Retrieves the project with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
project| Name | Description | Type | Additional 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
{
"id": "d172687c-cf2e-4a4e-9658-90f6dfe14b22",
"_parent_id": "13ce6473-2fd2-4f33-ad54-f94002865d3c",
"root_parent_id": "24100eb7-aeb6-4119-a2db-f9dda0600ffe",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9045cb6e-e279-4803-b8f6-5993ffccbc4f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4dac9ef4-fde5-4f4d-a22b-b0fb157abb5a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "46fb966f-fcfc-4b76-9fa6-805730512672",
"_parent_code": "sample string 6",
"sales_organization_id": "a170b16c-f9ad-4985-9e86-d9c4a57c65a2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3c7ce6a5-4c03-4907-ab57-f79335ee7b1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "044ec44d-a930-485a-aba3-abef484e2d66",
"db_currency_id": "1d0e2e1f-e05f-4d2e-ba80-e4a7d74180c1",
"db_language_id": "fa24c44b-a583-47a0-9dfc-2e3abed4225d",
"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": "2026-07-03T17:06:50.5393053+00:00"
},
"modified_dateutc": "2026-07-03T17:06:50.5393053+00:00"
},
"equipment_model_id": "b817d83c-10bf-4cf1-b262-ff16fb166d9f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fd0f820a-e670-47f0-a83e-b225b05e65b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "98e540f9-71a5-4ed9-b786-e3e1ee3eee09",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b7acef18-b45b-49e3-8904-4174ec5d451e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "760a1954-d8a5-4629-823d-b2ac629022a4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3c7ce6a5-4c03-4907-ab57-f79335ee7b1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "044ec44d-a930-485a-aba3-abef484e2d66",
"db_currency_id": "1d0e2e1f-e05f-4d2e-ba80-e4a7d74180c1",
"db_language_id": "fa24c44b-a583-47a0-9dfc-2e3abed4225d",
"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": "2026-07-03T17:06:50.5393053+00:00"
},
"modified_dateutc": "2026-07-03T17:06:50.5393053+00:00"
},
"equipment_family_id": "2a9f87db-a816-49b1-8a3f-cca2f79a8030",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4dac9ef4-fde5-4f4d-a22b-b0fb157abb5a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "46fb966f-fcfc-4b76-9fa6-805730512672",
"_parent_code": "sample string 6",
"sales_organization_id": "a170b16c-f9ad-4985-9e86-d9c4a57c65a2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3c7ce6a5-4c03-4907-ab57-f79335ee7b1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "044ec44d-a930-485a-aba3-abef484e2d66",
"db_currency_id": "1d0e2e1f-e05f-4d2e-ba80-e4a7d74180c1",
"db_language_id": "fa24c44b-a583-47a0-9dfc-2e3abed4225d",
"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": "2026-07-03T17:06:50.5393053+00:00"
},
"modified_dateutc": "2026-07-03T17:06:50.5393053+00:00"
},
"date_in_production_since": "2026-07-03T17:06:50.5393053+00:00",
"date_out_of_production_since": "2026-07-03T17:06:50.5393053+00:00",
"date_end_support": "2026-07-03T17:06:50.5393053+00:00",
"sales_organization_id": "b6cf8800-783f-4e62-912b-41406f5c4370",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3c7ce6a5-4c03-4907-ab57-f79335ee7b1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "044ec44d-a930-485a-aba3-abef484e2d66",
"db_currency_id": "1d0e2e1f-e05f-4d2e-ba80-e4a7d74180c1",
"db_language_id": "fa24c44b-a583-47a0-9dfc-2e3abed4225d",
"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": "2026-07-03T17:06:50.5393053+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": "2026-07-03T17:06:50.5393053+00:00"
},
"project_status_id": "20e6e1d6-54db-41c8-847e-fcc5b8d039c7",
"project_status_code": "sample string 10",
"project_status": {
"id": "5a5a36a9-8da7-4909-b13b-19c1e69b8782",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ae8f1d99-8cf1-41c1-9398-a43e865e3c2f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3c7ce6a5-4c03-4907-ab57-f79335ee7b1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "044ec44d-a930-485a-aba3-abef484e2d66",
"db_currency_id": "1d0e2e1f-e05f-4d2e-ba80-e4a7d74180c1",
"db_language_id": "fa24c44b-a583-47a0-9dfc-2e3abed4225d",
"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": "2026-07-03T17:06:50.5393053+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-03T17:06:50.5393053+00:00"
},
"company_id": "a5b50f59-ed95-4db1-bc93-3035c499bd1d",
"company_code": "sample string 12",
"db_address_id": "eecd5090-52a3-4d9e-ae9a-98cfe3f3b39e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cc529c86-94b1-410e-a23c-d5e7494bcfc1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "58135912-56be-491c-bc60-0d40916de9b2",
"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": "2026-07-03T17:06:50.5393053+00:00",
"date_create": "2026-07-03T17:06:50.5393053+00:00",
"date_update": "2026-07-03T17:06:50.5393053+00:00",
"updated_by_user_id": "23ddeb5a-10b6-45ef-8957-e9dd265c9650",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-03T17:06:50.5393053+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": "2026-07-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-03T17:06:50.5393053+00:00",
"date_last_job": "2026-07-03T17:06:50.5393053+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-03T17:06:50.5393053+00:00",
"modified_dateutc": "2026-07-03T17:06:50.5393053+00:00",
"is_mobile_installation": true
}