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": "9eb36605-bf50-4f6f-980c-783dab790fe0",
"_parent_id": "3c1c6508-2f33-44cf-9509-e742f1327384",
"root_parent_id": "72bbf4b4-32cf-48cb-8828-adeaba222918",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fbd1f31d-27ef-4f39-a0f3-ca03cf51017f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "75773738-b2c1-41b3-b660-a305a6045cb0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "17955e6f-9741-4e36-beee-807f04099de3",
"_parent_code": "sample string 6",
"sales_organization_id": "e8a7903b-cccb-4433-ac83-8b4bbfb00fa8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4f3af0c4-f561-4d10-9003-fb3d12f13697",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "176cb72d-67d2-4b91-847d-7e2514f3a3cd",
"db_currency_id": "c378e5fd-bd74-4b21-9dd5-adf0036f38e1",
"db_language_id": "ff2a6627-c555-4355-960c-b113749912d3",
"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-03-27T12:52:08.2210207+00:00"
},
"modified_dateutc": "2025-03-27T12:52:08.2210207+00:00"
},
"equipment_model_id": "58e0af64-d79e-440a-b56c-af42e338e79e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "abf56280-81d0-4d98-a567-08a8bdbd6903",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "58be76bb-faa0-49ea-ba54-f29a5727513c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6607ec4c-d6f4-40fc-9f08-5814332f7db3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0c925dbe-759e-4045-ac6a-f0e96e9ac9b4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4f3af0c4-f561-4d10-9003-fb3d12f13697",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "176cb72d-67d2-4b91-847d-7e2514f3a3cd",
"db_currency_id": "c378e5fd-bd74-4b21-9dd5-adf0036f38e1",
"db_language_id": "ff2a6627-c555-4355-960c-b113749912d3",
"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-03-27T12:52:08.2210207+00:00"
},
"modified_dateutc": "2025-03-27T12:52:08.2210207+00:00"
},
"equipment_family_id": "b345c0e4-6aa1-4974-ba01-80ecf0a33865",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "75773738-b2c1-41b3-b660-a305a6045cb0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "17955e6f-9741-4e36-beee-807f04099de3",
"_parent_code": "sample string 6",
"sales_organization_id": "e8a7903b-cccb-4433-ac83-8b4bbfb00fa8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4f3af0c4-f561-4d10-9003-fb3d12f13697",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "176cb72d-67d2-4b91-847d-7e2514f3a3cd",
"db_currency_id": "c378e5fd-bd74-4b21-9dd5-adf0036f38e1",
"db_language_id": "ff2a6627-c555-4355-960c-b113749912d3",
"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-03-27T12:52:08.2210207+00:00"
},
"modified_dateutc": "2025-03-27T12:52:08.2210207+00:00"
},
"date_in_production_since": "2025-03-27T12:52:08.2210207+00:00",
"date_out_of_production_since": "2025-03-27T12:52:08.2210207+00:00",
"date_end_support": "2025-03-27T12:52:08.2210207+00:00",
"sales_organization_id": "e55f0169-529a-46be-93b2-d089a572b321",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4f3af0c4-f561-4d10-9003-fb3d12f13697",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "176cb72d-67d2-4b91-847d-7e2514f3a3cd",
"db_currency_id": "c378e5fd-bd74-4b21-9dd5-adf0036f38e1",
"db_language_id": "ff2a6627-c555-4355-960c-b113749912d3",
"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-03-27T12:52:08.2210207+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-03-27T12:52:08.2210207+00:00"
},
"project_status_id": "9587a49e-8876-4896-a2fc-0563847b30f0",
"project_status_code": "sample string 10",
"project_status": {
"id": "f12833b2-f045-4f78-b98d-9667bab2bcb2",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "13a45daf-5d49-4624-993b-a2976fa6e811",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f3af0c4-f561-4d10-9003-fb3d12f13697",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "176cb72d-67d2-4b91-847d-7e2514f3a3cd",
"db_currency_id": "c378e5fd-bd74-4b21-9dd5-adf0036f38e1",
"db_language_id": "ff2a6627-c555-4355-960c-b113749912d3",
"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-03-27T12:52:08.2210207+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-03-27T12:52:08.236587+00:00"
},
"company_id": "d387fd0b-65c6-4134-8030-fe5b72021909",
"company_code": "sample string 12",
"db_address_id": "c1c4f740-54a7-45e4-8bf0-d8b476b1f471",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3f96083f-c064-4134-99a9-a637952b3a5f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ba938dac-0f90-4eb6-a726-953899cb125f",
"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-03-27T12:52:08.236587+00:00",
"date_create": "2025-03-27T12:52:08.236587+00:00",
"date_update": "2025-03-27T12:52:08.236587+00:00",
"updated_by_user_id": "f94e3997-a001-499e-ac5f-72a21d275b05",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-03-27T12:52:08.236587+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-03-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-03-27T12:52:08.236587+00:00",
"date_last_job": "2025-03-27T12:52:08.236587+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-03-27T12:52:08.236587+00:00",
"modified_dateutc": "2025-03-27T12:52:08.236587+00:00",
"is_mobile_installation": true
}