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": "b7ad8c95-8f11-4257-bbc3-b91d7ef188c9",
"_parent_id": "e1fe88f7-501b-4210-8280-4b0cd90c31d4",
"root_parent_id": "0dd235ac-9fc5-47fb-8a0b-d9976a9daea4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e0269b37-94cd-460a-b239-32cc76799e43",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4be483b3-8b8c-49e5-8eec-a67632a20827",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7a502af2-0d6f-40a5-8616-2ff24d49e42e",
"_parent_code": "sample string 6",
"sales_organization_id": "b730a911-e550-4ff5-a10e-a67dad37e4b2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2b6059da-e280-4884-9164-f256f8146ece",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bd1551b-5aef-4dc9-be2d-8986616a6897",
"db_currency_id": "fd399878-7692-4f2a-b8da-bf7c5056cead",
"db_language_id": "1519cd89-c5f4-403f-9a92-8b6f3b01cae2",
"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-06-01T00:08:51.5213156+00:00"
},
"modified_dateutc": "2025-06-01T00:08:51.5213156+00:00"
},
"equipment_model_id": "3b0603de-058c-48a6-8027-7409f9e144c9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "11fd2e4d-682e-4cd4-8d7f-bcffb893c2ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "86977f3e-f0a1-4191-be8a-4d670f6303ef",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "70b83611-1244-4199-b983-0ff122b57b20",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7297527d-cb8e-4184-9a69-0393d93a5ea2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2b6059da-e280-4884-9164-f256f8146ece",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bd1551b-5aef-4dc9-be2d-8986616a6897",
"db_currency_id": "fd399878-7692-4f2a-b8da-bf7c5056cead",
"db_language_id": "1519cd89-c5f4-403f-9a92-8b6f3b01cae2",
"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-06-01T00:08:51.5213156+00:00"
},
"modified_dateutc": "2025-06-01T00:08:51.5213156+00:00"
},
"equipment_family_id": "79b43570-57ba-4a34-b8c3-402419b30d0a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4be483b3-8b8c-49e5-8eec-a67632a20827",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7a502af2-0d6f-40a5-8616-2ff24d49e42e",
"_parent_code": "sample string 6",
"sales_organization_id": "b730a911-e550-4ff5-a10e-a67dad37e4b2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2b6059da-e280-4884-9164-f256f8146ece",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bd1551b-5aef-4dc9-be2d-8986616a6897",
"db_currency_id": "fd399878-7692-4f2a-b8da-bf7c5056cead",
"db_language_id": "1519cd89-c5f4-403f-9a92-8b6f3b01cae2",
"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-06-01T00:08:51.5213156+00:00"
},
"modified_dateutc": "2025-06-01T00:08:51.5213156+00:00"
},
"date_in_production_since": "2025-06-01T00:08:51.5213156+00:00",
"date_out_of_production_since": "2025-06-01T00:08:51.5213156+00:00",
"date_end_support": "2025-06-01T00:08:51.5213156+00:00",
"sales_organization_id": "6b79b4a0-ed2e-4579-b86f-6894903c201c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2b6059da-e280-4884-9164-f256f8146ece",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bd1551b-5aef-4dc9-be2d-8986616a6897",
"db_currency_id": "fd399878-7692-4f2a-b8da-bf7c5056cead",
"db_language_id": "1519cd89-c5f4-403f-9a92-8b6f3b01cae2",
"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-06-01T00:08:51.5213156+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-06-01T00:08:51.5213156+00:00"
},
"project_status_id": "68ea6378-c27d-4662-aa84-4b8a89d59f24",
"project_status_code": "sample string 10",
"project_status": {
"id": "6ad9e1b5-05ea-486d-8358-db1daec25968",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4181f647-9e4d-4503-a351-ec365c2a0641",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2b6059da-e280-4884-9164-f256f8146ece",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bd1551b-5aef-4dc9-be2d-8986616a6897",
"db_currency_id": "fd399878-7692-4f2a-b8da-bf7c5056cead",
"db_language_id": "1519cd89-c5f4-403f-9a92-8b6f3b01cae2",
"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-06-01T00:08:51.5213156+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-01T00:08:51.5213156+00:00"
},
"company_id": "c7b2353d-1771-47e8-b3f0-f140f2505661",
"company_code": "sample string 12",
"db_address_id": "c867169b-f6ae-4f55-8f59-3d3d2c72096b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d9d0053e-5e37-4e08-b76b-e217fe5a7d5e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "586668e4-7966-4c27-89a0-c326884eef66",
"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-06-01T00:08:51.5213156+00:00",
"date_create": "2025-06-01T00:08:51.5213156+00:00",
"date_update": "2025-06-01T00:08:51.5213156+00:00",
"updated_by_user_id": "d975b521-fcd7-467f-898f-171ca38645a7",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-06-01T00:08:51.5213156+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-06-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-06-01T00:08:51.5213156+00:00",
"date_last_job": "2025-06-01T00:08:51.5213156+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-06-01T00:08:51.5213156+00:00",
"modified_dateutc": "2025-06-01T00:08:51.5213156+00:00",
"is_mobile_installation": true
}