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": "bf2a0b83-ed21-4157-b8a6-8ef8f046d075",
"_parent_id": "301fec42-c0aa-4d96-9bd0-55f57c6dd38e",
"root_parent_id": "400af7cb-1b73-47dd-8530-d6142b795351",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5bbbcb1f-2e41-40a7-bb24-1b4b2f7844af",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "23a918f7-1a1a-4044-aa8b-4f98185fadb8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3e171d1a-7eee-4c36-b6f6-026353c82714",
"_parent_code": "sample string 6",
"sales_organization_id": "327a8b5f-ebf1-4fb0-acf8-aaaeb32c3061",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0b131b3f-da0b-4be0-838e-b3bfdbfb8927",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41d8b76f-6a8b-4d6e-8405-0b3c6d72c0f3",
"db_currency_id": "5f5e45f9-4191-4b3f-9016-ebe163d6239b",
"db_language_id": "b75a376e-216f-4121-aa97-eefe6280f661",
"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-02-08T06:05:57.9707516+00:00"
},
"modified_dateutc": "2026-02-08T06:05:57.9707516+00:00"
},
"equipment_model_id": "dc8ddbe6-4f3f-4975-adce-5a1235ddb8fb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a538509e-b736-42dc-a27a-f9b7d8c110d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0a70e00c-5934-4257-954e-11db3bb1b003",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2cc1128d-ce3f-4be5-bb9f-708cefd0f357",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b6c3fefd-700a-4455-86cf-4ed80c4aac3c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0b131b3f-da0b-4be0-838e-b3bfdbfb8927",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41d8b76f-6a8b-4d6e-8405-0b3c6d72c0f3",
"db_currency_id": "5f5e45f9-4191-4b3f-9016-ebe163d6239b",
"db_language_id": "b75a376e-216f-4121-aa97-eefe6280f661",
"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-02-08T06:05:57.9707516+00:00"
},
"modified_dateutc": "2026-02-08T06:05:57.9707516+00:00"
},
"equipment_family_id": "18f3368d-bc19-4ee4-ba12-54c76a6a45bb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "23a918f7-1a1a-4044-aa8b-4f98185fadb8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3e171d1a-7eee-4c36-b6f6-026353c82714",
"_parent_code": "sample string 6",
"sales_organization_id": "327a8b5f-ebf1-4fb0-acf8-aaaeb32c3061",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0b131b3f-da0b-4be0-838e-b3bfdbfb8927",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41d8b76f-6a8b-4d6e-8405-0b3c6d72c0f3",
"db_currency_id": "5f5e45f9-4191-4b3f-9016-ebe163d6239b",
"db_language_id": "b75a376e-216f-4121-aa97-eefe6280f661",
"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-02-08T06:05:57.9707516+00:00"
},
"modified_dateutc": "2026-02-08T06:05:57.9707516+00:00"
},
"date_in_production_since": "2026-02-08T06:05:57.9707516+00:00",
"date_out_of_production_since": "2026-02-08T06:05:57.9707516+00:00",
"date_end_support": "2026-02-08T06:05:57.9707516+00:00",
"sales_organization_id": "68d3bcf4-c835-4f6c-9877-6a34c2b1d908",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0b131b3f-da0b-4be0-838e-b3bfdbfb8927",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41d8b76f-6a8b-4d6e-8405-0b3c6d72c0f3",
"db_currency_id": "5f5e45f9-4191-4b3f-9016-ebe163d6239b",
"db_language_id": "b75a376e-216f-4121-aa97-eefe6280f661",
"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-02-08T06:05:57.9707516+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-02-08T06:05:57.9707516+00:00"
},
"project_status_id": "86930dac-109b-43ee-b272-00be74125765",
"project_status_code": "sample string 10",
"project_status": {
"id": "d7ad8b42-4495-44fe-a834-a5f79ff3d75f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c8f299ff-706c-4367-9a24-67d0f9f1634d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0b131b3f-da0b-4be0-838e-b3bfdbfb8927",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41d8b76f-6a8b-4d6e-8405-0b3c6d72c0f3",
"db_currency_id": "5f5e45f9-4191-4b3f-9016-ebe163d6239b",
"db_language_id": "b75a376e-216f-4121-aa97-eefe6280f661",
"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-02-08T06:05:57.9707516+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-08T06:05:57.9707516+00:00"
},
"company_id": "cc36385f-3587-4fb7-8927-4d040a376d02",
"company_code": "sample string 12",
"db_address_id": "0aedae14-bf46-4329-b0b1-2f030508d6a5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "422a3528-d3a8-4a28-bf70-b189ad552124",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8dbae4be-ba9b-4cc6-904b-3235b8e72601",
"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-02-08T06:05:57.9707516+00:00",
"date_create": "2026-02-08T06:05:57.9707516+00:00",
"date_update": "2026-02-08T06:05:57.9707516+00:00",
"updated_by_user_id": "87c6569b-d419-468e-97fa-c154779d4607",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-08T06:05:57.9707516+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-02-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-08T06:05:57.9707516+00:00",
"date_last_job": "2026-02-08T06:05:57.9707516+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-08T06:05:57.9707516+00:00",
"modified_dateutc": "2026-02-08T06:05:57.9707516+00:00",
"is_mobile_installation": true
}