Retrieves the project with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

project
NameDescriptionTypeAdditional information
id

Primary Key

globally unique identifier

Required

_parent_id

Reference to a parent installation

globally unique identifier
root_parent_id

This field will be filled automatically based on the parent_id

globally unique identifier
_parent_reference_back_office

Embedded entity "project" for parent installation using ERP PK when adding/updating project

string
_parent_project

Embedded entity "project" for parent installation when adding/updating project

project
equipment_family_id

Foreign key to equipment_family. It can be taken via equipment_family_code, equipment_family or equipment model that links to a valid equipment family

globally unique identifier
equipment_family_code

Embedded entity "equipment_family" using ERP PK when adding/updating project

string
equipment_family

Embedded entity "equipment_family" when adding/updating project

equipment_family
equipment_model_id

Foreign key to equipment model. It can get via equipment_family_code, equipment_family or equipment_model

globally unique identifier
equipment_model_code

Embedded entity "equipment_model" using ERP PK when adding/updating project

string
equipment_model

Embedded entity "equipment_model" when adding/updating project

equipment_model
project_status_id

Foreign key to project_status

globally unique identifier

Optionally required : project_status_id, project_status_code or project_status must be provided

project_status_code

Embedded entity "project_status" using ERP PK when adding/updating project

string

Optionally required : project_status_id, project_status_code or project_status must be provided

project_status

Embedded entity "project_status" when adding/updating project

project_status

Optionally required : project_status_id, project_status_code or project_status must be provided

company_id

The company owner of this project/installation

globally unique identifier

Optionally required : company_id, company_code or company must be provided

company_code

Embedded entity "company" using ERP PK when adding/updating project

string

Optionally required : company_id, company_code or company must be provided

company

Embedded entity "company" when adding/updating project

company

Optionally required : company_id, company_code or company must be provided

db_address_id

Specific db_address_id of the %company_id% if different than the company default address

globally unique identifier
db_address_code

Embedded entity "db_address" using ERP PK when adding/updating project

string
db_address

Embedded entity "db_address" when adding/updating project

db_address
location

Additional text to describe the location

string

Max length: 255

contact_id

Main contact for this project/installation

globally unique identifier
contact_reference_back_office

Embedded entity "contact" using ERP PK when adding/updating project

string
contact

Embedded entity "contact" when adding/updating project

contact
owner_user_id

User owner/manager of this project/installation

globally unique identifier
name

Name of the project/installation

string

Required

Max length: 50

description

Long description

string
reference_back_office

The Id/Ref of the back office for this project/installation. Used by Embedded entity

string

Max length: 255

serial_number

Serial number

string

Max length: 255

barcode

Barcode

string

Max length: 50

date_start_production

Date project/installation becomes active

date
date_create

Creation date+time

date
date_update

Update date+time

date
updated_by_user_id

Last User that updates the object

globally unique identifier
customer_reference

Reference of this project/installation for the customer

string

Max length: 50

warranty_date_until

End date of the warranty (if applicable)

date
last_standard_result_score_1

Last result score 1 (CF Standard module)

string

Max length: 50

last_standard_result_score_2

Last result score 2 (CF Standard module)

string
target_standard_result_score_1

Target result score 1 (CF Standard module)

string

Max length: 50

target_standard_result_score_2

Target result score 2 (CF Standard module)

string

Max length: 50

date_built

Build date of the installation (if applicable)

date
shutdown_consequence

Consequence of the installation is shut down (CEO has no air cooling anymore,..)

string

Max length: 4000

id2

Internal ID (numeric). Will be used if reference_back_office is empty

integer
nb_open_jobs

Readonly - Number of open jobs

integer
date_next_job

Date+time of the next job planned

date
date_last_job

Date+time of the last job completed

date
nb_jobs_planned

Number of jobs with status Planned

integer
nb_jobs_tobeplanned

Number of jobs with status To Be Planned

integer
nb_jobs_waitingfurtheraction

Number of jobs with status Waiting Further Action

integer
back_office_timestamp

Back Office timestamp value (conflict detection purpose)

date
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

date
is_mobile_installation

Set it TRUE if this is a mobile installation.

boolean

Response Formats

application/json, text/json

Sample:
{
  "id": "25d49909-b434-40a2-a7de-91cee107b18b",
  "_parent_id": "594470e6-b75e-4a04-bda0-f69e2b766b9b",
  "root_parent_id": "a4655d7f-9883-4813-84a1-2506e5553ee2",
  "_parent_reference_back_office": "sample string 4",
  "equipment_family_id": "18034e04-329c-4ba9-b3ea-64ff63524691",
  "equipment_family_code": "sample string 6",
  "equipment_family": {
    "id": "5e13dfc1-2b49-4aac-a873-797d39622a7b",
    "name": "sample string 2",
    "description": "sample string 3",
    "code": "sample string 4",
    "_parent_id": "e2182ab2-0a66-4c75-8028-8935dd14cbcf",
    "_parent_code": "sample string 6",
    "sales_organization_id": "8df5028a-d60b-4c6a-98bf-bac22fce155d",
    "sales_organization_code": "sample string 8",
    "sales_organization": {
      "id": "5764138b-743e-4c5e-9911-0ef82fab1521",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "6a88e222-f25b-46cc-a1c4-7c069b261e3f",
      "db_currency_id": "d49638ef-293a-4c5f-9872-2325cfc81056",
      "db_language_id": "df36bafd-9975-43c1-8385-b7c5f4e63f7a",
      "accountancy_code": "sample string 8",
      "archived": true,
      "default_unit_of_measure_system_type": "sample string 10",
      "street": "sample string 11",
      "street2": "sample string 12",
      "street_number": "sample string 13",
      "zip": "sample string 14",
      "city": "sample string 15",
      "email": "sample string 16",
      "phone": "sample string 17",
      "fax": "sample string 18",
      "url": "sample string 19",
      "vat_reg_code": "sample string 20",
      "modified_dateutc": "2025-07-08T05:57:48.186536+00:00"
    },
    "modified_dateutc": "2025-07-08T05:57:48.186536+00:00"
  },
  "equipment_model_id": "3454dc43-5168-41a3-8f85-3dba9861edd1",
  "equipment_model_code": "sample string 8",
  "equipment_model": {
    "id": "a238cf9e-b0df-4f6d-a62e-817ee18037ea",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "equipment_brand_id": "309f5ac7-3a79-4167-bf2d-de4d89068184",
    "equipment_brand_code": "sample string 6",
    "equipment_brand": {
      "id": "49e85667-4b40-47d7-8719-ae310b7d981a",
      "name": "sample string 2",
      "code": "sample string 3",
      "sales_organization_id": "52f5717d-54fd-43cf-8441-f33b61e418d9",
      "sales_organization_code": "sample string 5",
      "sales_organization": {
        "id": "5764138b-743e-4c5e-9911-0ef82fab1521",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "6a88e222-f25b-46cc-a1c4-7c069b261e3f",
        "db_currency_id": "d49638ef-293a-4c5f-9872-2325cfc81056",
        "db_language_id": "df36bafd-9975-43c1-8385-b7c5f4e63f7a",
        "accountancy_code": "sample string 8",
        "archived": true,
        "default_unit_of_measure_system_type": "sample string 10",
        "street": "sample string 11",
        "street2": "sample string 12",
        "street_number": "sample string 13",
        "zip": "sample string 14",
        "city": "sample string 15",
        "email": "sample string 16",
        "phone": "sample string 17",
        "fax": "sample string 18",
        "url": "sample string 19",
        "vat_reg_code": "sample string 20",
        "modified_dateutc": "2025-07-08T05:57:48.186536+00:00"
      },
      "modified_dateutc": "2025-07-08T05:57:48.186536+00:00"
    },
    "equipment_family_id": "481f5183-ca37-4105-a0c3-1be68eba2c57",
    "equipment_family_code": "sample string 8",
    "equipment_family": {
      "id": "5e13dfc1-2b49-4aac-a873-797d39622a7b",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "_parent_id": "e2182ab2-0a66-4c75-8028-8935dd14cbcf",
      "_parent_code": "sample string 6",
      "sales_organization_id": "8df5028a-d60b-4c6a-98bf-bac22fce155d",
      "sales_organization_code": "sample string 8",
      "sales_organization": {
        "id": "5764138b-743e-4c5e-9911-0ef82fab1521",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "6a88e222-f25b-46cc-a1c4-7c069b261e3f",
        "db_currency_id": "d49638ef-293a-4c5f-9872-2325cfc81056",
        "db_language_id": "df36bafd-9975-43c1-8385-b7c5f4e63f7a",
        "accountancy_code": "sample string 8",
        "archived": true,
        "default_unit_of_measure_system_type": "sample string 10",
        "street": "sample string 11",
        "street2": "sample string 12",
        "street_number": "sample string 13",
        "zip": "sample string 14",
        "city": "sample string 15",
        "email": "sample string 16",
        "phone": "sample string 17",
        "fax": "sample string 18",
        "url": "sample string 19",
        "vat_reg_code": "sample string 20",
        "modified_dateutc": "2025-07-08T05:57:48.186536+00:00"
      },
      "modified_dateutc": "2025-07-08T05:57:48.186536+00:00"
    },
    "date_in_production_since": "2025-07-08T05:57:48.186536+00:00",
    "date_out_of_production_since": "2025-07-08T05:57:48.186536+00:00",
    "date_end_support": "2025-07-08T05:57:48.186536+00:00",
    "sales_organization_id": "1a41022d-67b6-4792-9cd0-7b011f33537f",
    "sales_organization_code": "sample string 13",
    "sales_organization": {
      "id": "5764138b-743e-4c5e-9911-0ef82fab1521",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "6a88e222-f25b-46cc-a1c4-7c069b261e3f",
      "db_currency_id": "d49638ef-293a-4c5f-9872-2325cfc81056",
      "db_language_id": "df36bafd-9975-43c1-8385-b7c5f4e63f7a",
      "accountancy_code": "sample string 8",
      "archived": true,
      "default_unit_of_measure_system_type": "sample string 10",
      "street": "sample string 11",
      "street2": "sample string 12",
      "street_number": "sample string 13",
      "zip": "sample string 14",
      "city": "sample string 15",
      "email": "sample string 16",
      "phone": "sample string 17",
      "fax": "sample string 18",
      "url": "sample string 19",
      "vat_reg_code": "sample string 20",
      "modified_dateutc": "2025-07-08T05:57:48.186536+00:00"
    },
    "replacement_period_nb_months": 14,
    "warranty_period_nb_months": 15,
    "translations": [
      {
        "field_name": "sample string 1",
        "language_code": "sample string 2",
        "value_translated": "sample string 3"
      },
      {
        "field_name": "sample string 1",
        "language_code": "sample string 2",
        "value_translated": "sample string 3"
      }
    ],
    "modified_dateutc": "2025-07-08T05:57:48.186536+00:00"
  },
  "project_status_id": "7bbbbb0c-7fe2-4667-a4a4-ee0ce3f29a6b",
  "project_status_code": "sample string 10",
  "project_status": {
    "id": "dd56b099-904c-4f4b-9415-2df20bb822c8",
    "name": "sample string 2",
    "is_default": true,
    "is_closed": true,
    "sales_organization_id": "191988e5-33a5-4dd5-80ae-98e2007b79f3",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "5764138b-743e-4c5e-9911-0ef82fab1521",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "6a88e222-f25b-46cc-a1c4-7c069b261e3f",
      "db_currency_id": "d49638ef-293a-4c5f-9872-2325cfc81056",
      "db_language_id": "df36bafd-9975-43c1-8385-b7c5f4e63f7a",
      "accountancy_code": "sample string 8",
      "archived": true,
      "default_unit_of_measure_system_type": "sample string 10",
      "street": "sample string 11",
      "street2": "sample string 12",
      "street_number": "sample string 13",
      "zip": "sample string 14",
      "city": "sample string 15",
      "email": "sample string 16",
      "phone": "sample string 17",
      "fax": "sample string 18",
      "url": "sample string 19",
      "vat_reg_code": "sample string 20",
      "modified_dateutc": "2025-07-08T05:57:48.186536+00:00"
    },
    "code": "sample string 7",
    "modified_dateutc": "2025-07-08T05:57:48.186536+00:00"
  },
  "company_id": "34d061ed-0e8a-4665-ac4b-27958c8e41d0",
  "company_code": "sample string 12",
  "db_address_id": "b3a94569-027a-4eb0-b0f4-58ebbc2fa939",
  "db_address_code": "sample string 14",
  "location": "sample string 15",
  "contact_id": "0662bf9a-087e-4901-a09f-e801b48be7c8",
  "contact_reference_back_office": "sample string 17",
  "owner_user_id": "100342ac-55f2-43d0-b89c-ef0f469a4074",
  "name": "sample string 19",
  "description": "sample string 20",
  "reference_back_office": "sample string 21",
  "serial_number": "sample string 22",
  "barcode": "sample string 23",
  "date_start_production": "2025-07-08T05:57:48.186536+00:00",
  "date_create": "2025-07-08T05:57:48.186536+00:00",
  "date_update": "2025-07-08T05:57:48.186536+00:00",
  "updated_by_user_id": "2b131094-157b-4c25-a091-b0ab18e4c71e",
  "customer_reference": "sample string 28",
  "warranty_date_until": "2025-07-08T05:57:48.186536+00:00",
  "last_standard_result_score_1": "sample string 30",
  "last_standard_result_score_2": "sample string 31",
  "target_standard_result_score_1": "sample string 32",
  "target_standard_result_score_2": "sample string 33",
  "date_built": "2025-07-08T00:00:00+00:00",
  "shutdown_consequence": "sample string 35",
  "id2": 36,
  "nb_open_jobs": 37,
  "date_next_job": "2025-07-08T05:57:48.186536+00:00",
  "date_last_job": "2025-07-08T05:57:48.186536+00:00",
  "nb_jobs_planned": 40,
  "nb_jobs_tobeplanned": 41,
  "nb_jobs_waitingfurtheraction": 42,
  "back_office_timestamp": "2025-07-08T05:57:48.186536+00:00",
  "modified_dateutc": "2025-07-08T05:57:48.186536+00:00",
  "is_mobile_installation": true
}