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": "41f805dc-4abd-4d6d-acb2-65a31d485753",
"_parent_id": "dd079c1a-e8d8-4541-a3fd-18e6d819cc1e",
"root_parent_id": "ff808391-a556-4815-aea6-326fb9e3f32a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "adbcb516-f689-4a9e-80cd-f92a4275678e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ece828a3-fb0f-47e6-ba40-f4ce6cf48f8a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6856ebe8-432e-4b85-8182-e6b49ee59559",
"_parent_code": "sample string 6",
"sales_organization_id": "ec9cd7e3-d3e6-4534-9c54-47f5fa4c0251",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "47a0588f-f507-46f3-9ebf-960b4dce0e87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "818ffe1a-298c-4bc1-b6a7-c95a2fa38325",
"db_currency_id": "882fd89a-ec0c-4fe3-84ac-6f042f3817e4",
"db_language_id": "886f429b-da1a-4337-9ff3-2f45ecacef77",
"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-06-06T06:27:40.2635891+00:00"
},
"modified_dateutc": "2026-06-06T06:27:40.2635891+00:00"
},
"equipment_model_id": "9a4b21e4-a8b9-4c14-991d-14f0c929f403",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6d345aa9-3e39-4dbf-8f77-60fb634c7061",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "eb02580c-2653-44c8-b492-78bcfc7cb084",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6b2e210d-c59f-4146-87be-c27e2f90e662",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "61a24114-dd8c-4cca-be7c-7f5a87bcc2ee",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "47a0588f-f507-46f3-9ebf-960b4dce0e87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "818ffe1a-298c-4bc1-b6a7-c95a2fa38325",
"db_currency_id": "882fd89a-ec0c-4fe3-84ac-6f042f3817e4",
"db_language_id": "886f429b-da1a-4337-9ff3-2f45ecacef77",
"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-06-06T06:27:40.2635891+00:00"
},
"modified_dateutc": "2026-06-06T06:27:40.2635891+00:00"
},
"equipment_family_id": "5981c437-ebf0-47d0-a235-7e824d495fef",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ece828a3-fb0f-47e6-ba40-f4ce6cf48f8a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6856ebe8-432e-4b85-8182-e6b49ee59559",
"_parent_code": "sample string 6",
"sales_organization_id": "ec9cd7e3-d3e6-4534-9c54-47f5fa4c0251",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "47a0588f-f507-46f3-9ebf-960b4dce0e87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "818ffe1a-298c-4bc1-b6a7-c95a2fa38325",
"db_currency_id": "882fd89a-ec0c-4fe3-84ac-6f042f3817e4",
"db_language_id": "886f429b-da1a-4337-9ff3-2f45ecacef77",
"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-06-06T06:27:40.2635891+00:00"
},
"modified_dateutc": "2026-06-06T06:27:40.2635891+00:00"
},
"date_in_production_since": "2026-06-06T06:27:40.2635891+00:00",
"date_out_of_production_since": "2026-06-06T06:27:40.2635891+00:00",
"date_end_support": "2026-06-06T06:27:40.2635891+00:00",
"sales_organization_id": "f5706754-8bcd-44cc-af80-e5a7dcadf8fb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "47a0588f-f507-46f3-9ebf-960b4dce0e87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "818ffe1a-298c-4bc1-b6a7-c95a2fa38325",
"db_currency_id": "882fd89a-ec0c-4fe3-84ac-6f042f3817e4",
"db_language_id": "886f429b-da1a-4337-9ff3-2f45ecacef77",
"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-06-06T06:27:40.2635891+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-06-06T06:27:40.2635891+00:00"
},
"project_status_id": "fa0299ff-91d9-49d0-9f98-886639201653",
"project_status_code": "sample string 10",
"project_status": {
"id": "db168fbf-40f6-4bb7-97bf-df5990d3ff44",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f8814912-ba5f-462d-bbb2-ef909a48cbcf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "47a0588f-f507-46f3-9ebf-960b4dce0e87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "818ffe1a-298c-4bc1-b6a7-c95a2fa38325",
"db_currency_id": "882fd89a-ec0c-4fe3-84ac-6f042f3817e4",
"db_language_id": "886f429b-da1a-4337-9ff3-2f45ecacef77",
"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-06-06T06:27:40.2635891+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-06T06:27:40.2635891+00:00"
},
"company_id": "bdbf5bcb-9c0b-440b-8dea-524a3bfca9f6",
"company_code": "sample string 12",
"db_address_id": "0c0c9a04-feb7-4bf7-9508-4b658327e290",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d60371ad-b79f-46c5-92d0-3ca7912f7ee1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "37b8c717-cf42-4865-8fd0-e14768521c36",
"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-06-06T06:27:40.2635891+00:00",
"date_create": "2026-06-06T06:27:40.2635891+00:00",
"date_update": "2026-06-06T06:27:40.2635891+00:00",
"updated_by_user_id": "503a170b-61e3-45a6-88c4-0db98ac01482",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-06T06:27:40.2635891+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-06-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-06T06:27:40.2635891+00:00",
"date_last_job": "2026-06-06T06:27:40.2635891+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-06T06:27:40.2635891+00:00",
"modified_dateutc": "2026-06-06T06:27:40.2635891+00:00",
"is_mobile_installation": true
}