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": "49da748c-ee65-4a45-87ad-0648aec6369b",
"_parent_id": "c6b9fa32-5f41-4512-b4f8-45ad978100c8",
"root_parent_id": "5a8056df-c7cb-45fb-bf71-c357cc597e8d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "99688bc1-dbe6-4137-a6bb-a45630e91103",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d9c20e85-bb05-493a-817f-28b4b3c4a241",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "66bd2473-8946-43ab-ad71-ee7965725bb8",
"_parent_code": "sample string 6",
"sales_organization_id": "65b1eb6a-3629-41c2-b8dd-74b5996795ab",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "027022b2-eea1-47ea-aaff-8296f3df9780",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a196810f-c4a5-438e-b9b8-b2ce72dfaef6",
"db_currency_id": "14053170-8f94-4dbf-b969-2725ce30564a",
"db_language_id": "33a49664-6700-480a-b2d9-19769e64bd90",
"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-06T07:52:22.6618075+00:00"
},
"modified_dateutc": "2025-07-06T07:52:22.6618075+00:00"
},
"equipment_model_id": "9151e6cb-47c8-47b4-ba96-8d6b5950418f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "95d7f474-164f-4de1-b8af-03a286d65bc7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3f0bdb21-7ddf-48ba-a40c-0d8ee88d8124",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1a7be198-47a4-4043-958c-b53dd3c6bd3f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fbc97865-01ef-43ce-bef3-b5430b2350c4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "027022b2-eea1-47ea-aaff-8296f3df9780",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a196810f-c4a5-438e-b9b8-b2ce72dfaef6",
"db_currency_id": "14053170-8f94-4dbf-b969-2725ce30564a",
"db_language_id": "33a49664-6700-480a-b2d9-19769e64bd90",
"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-06T07:52:22.6618075+00:00"
},
"modified_dateutc": "2025-07-06T07:52:22.6618075+00:00"
},
"equipment_family_id": "1f916c58-0ea9-4954-990f-77e850d1348d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d9c20e85-bb05-493a-817f-28b4b3c4a241",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "66bd2473-8946-43ab-ad71-ee7965725bb8",
"_parent_code": "sample string 6",
"sales_organization_id": "65b1eb6a-3629-41c2-b8dd-74b5996795ab",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "027022b2-eea1-47ea-aaff-8296f3df9780",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a196810f-c4a5-438e-b9b8-b2ce72dfaef6",
"db_currency_id": "14053170-8f94-4dbf-b969-2725ce30564a",
"db_language_id": "33a49664-6700-480a-b2d9-19769e64bd90",
"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-06T07:52:22.6618075+00:00"
},
"modified_dateutc": "2025-07-06T07:52:22.6618075+00:00"
},
"date_in_production_since": "2025-07-06T07:52:22.6618075+00:00",
"date_out_of_production_since": "2025-07-06T07:52:22.6618075+00:00",
"date_end_support": "2025-07-06T07:52:22.6618075+00:00",
"sales_organization_id": "a8a768f4-2ed8-40c7-a6cc-4a3b58b8e4be",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "027022b2-eea1-47ea-aaff-8296f3df9780",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a196810f-c4a5-438e-b9b8-b2ce72dfaef6",
"db_currency_id": "14053170-8f94-4dbf-b969-2725ce30564a",
"db_language_id": "33a49664-6700-480a-b2d9-19769e64bd90",
"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-06T07:52:22.6618075+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-06T07:52:22.6618075+00:00"
},
"project_status_id": "8581f36c-ac3b-4a66-b90f-4d96c390a6e3",
"project_status_code": "sample string 10",
"project_status": {
"id": "f9bc58c3-43e5-4d09-88dd-d2932b5cfc28",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4f96f181-c3fd-4149-b5a8-5b9095dc1863",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "027022b2-eea1-47ea-aaff-8296f3df9780",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a196810f-c4a5-438e-b9b8-b2ce72dfaef6",
"db_currency_id": "14053170-8f94-4dbf-b969-2725ce30564a",
"db_language_id": "33a49664-6700-480a-b2d9-19769e64bd90",
"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-06T07:52:22.6618075+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-06T07:52:22.6618075+00:00"
},
"company_id": "6161e76f-f776-4bdd-a753-051c906001cb",
"company_code": "sample string 12",
"db_address_id": "5928a4e3-0bdf-42b4-86b7-68c44218a19b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cca40a0c-bebc-48f0-877d-ce9de71edafd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6c99affa-7e5b-4156-9371-1d484b72d3c9",
"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-06T07:52:22.6618075+00:00",
"date_create": "2025-07-06T07:52:22.6618075+00:00",
"date_update": "2025-07-06T07:52:22.6618075+00:00",
"updated_by_user_id": "8bcc91ca-016b-457b-91a4-5a72c838d2b3",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-07-06T07:52:22.6618075+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-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-07-06T07:52:22.6618075+00:00",
"date_last_job": "2025-07-06T07:52:22.6618075+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-07-06T07:52:22.6618075+00:00",
"modified_dateutc": "2025-07-06T07:52:22.6618075+00:00",
"is_mobile_installation": true
}