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
projectName | 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": "f9fea448-52c4-4873-b70f-fdd57bd9c136", "_parent_id": "e1bb267f-15e2-466b-9a58-775b6232b3e7", "root_parent_id": "d5db0bb8-747d-4e5f-bc5e-a7f2d737c915", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "dc1eb5ef-3201-4aba-921a-454e3f4fbf31", "equipment_family_code": "sample string 6", "equipment_family": { "id": "f8d8cc5c-ac9d-4c54-ab72-8d81b428f32c", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "2a203f88-ae3f-4850-92ee-2cb791546154", "_parent_code": "sample string 6", "sales_organization_id": "6ac1e8af-cca4-4849-a696-9a1c0836c361", "sales_organization_code": "sample string 8", "sales_organization": { "id": "1822ed6e-9906-4076-ba5c-df4f0e1b594d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "48e99a8c-3bdd-4d50-b67f-e735df971606", "db_currency_id": "cc069114-4833-4b50-b3e5-3cb018d369d8", "db_language_id": "3938ed08-5039-4c58-bcd5-1798c23d8cd5", "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-05-17T14:17:43.6671612+00:00" }, "modified_dateutc": "2025-05-17T14:17:43.6671612+00:00" }, "equipment_model_id": "037502ac-000d-467e-be50-b5092ac34f62", "equipment_model_code": "sample string 8", "equipment_model": { "id": "78dc1515-75f8-4e87-bfa4-a1ca7d749cee", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "067ab2e9-c8af-4643-aa2e-d5b39ccc64ee", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "de7b4989-0160-43f0-9536-04d602b0dedb", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "144d8bf8-b923-48ac-8c6f-7ceadf98cf2d", "sales_organization_code": "sample string 5", "sales_organization": { "id": "1822ed6e-9906-4076-ba5c-df4f0e1b594d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "48e99a8c-3bdd-4d50-b67f-e735df971606", "db_currency_id": "cc069114-4833-4b50-b3e5-3cb018d369d8", "db_language_id": "3938ed08-5039-4c58-bcd5-1798c23d8cd5", "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-05-17T14:17:43.6671612+00:00" }, "modified_dateutc": "2025-05-17T14:17:43.6671612+00:00" }, "equipment_family_id": "f65c9971-6919-4335-a242-22817a07c407", "equipment_family_code": "sample string 8", "equipment_family": { "id": "f8d8cc5c-ac9d-4c54-ab72-8d81b428f32c", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "2a203f88-ae3f-4850-92ee-2cb791546154", "_parent_code": "sample string 6", "sales_organization_id": "6ac1e8af-cca4-4849-a696-9a1c0836c361", "sales_organization_code": "sample string 8", "sales_organization": { "id": "1822ed6e-9906-4076-ba5c-df4f0e1b594d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "48e99a8c-3bdd-4d50-b67f-e735df971606", "db_currency_id": "cc069114-4833-4b50-b3e5-3cb018d369d8", "db_language_id": "3938ed08-5039-4c58-bcd5-1798c23d8cd5", "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-05-17T14:17:43.6671612+00:00" }, "modified_dateutc": "2025-05-17T14:17:43.6671612+00:00" }, "date_in_production_since": "2025-05-17T14:17:43.6671612+00:00", "date_out_of_production_since": "2025-05-17T14:17:43.6671612+00:00", "date_end_support": "2025-05-17T14:17:43.6671612+00:00", "sales_organization_id": "0ed310f1-3427-441b-879a-db2690853392", "sales_organization_code": "sample string 13", "sales_organization": { "id": "1822ed6e-9906-4076-ba5c-df4f0e1b594d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "48e99a8c-3bdd-4d50-b67f-e735df971606", "db_currency_id": "cc069114-4833-4b50-b3e5-3cb018d369d8", "db_language_id": "3938ed08-5039-4c58-bcd5-1798c23d8cd5", "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-05-17T14:17:43.6671612+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-05-17T14:17:43.6671612+00:00" }, "project_status_id": "300c5fe8-d230-4cdd-9929-6511b0239e1c", "project_status_code": "sample string 10", "project_status": { "id": "6dda3686-c5b4-4bd3-9041-3d997eb12204", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "c6751e1f-3e1e-4019-aabe-6fd82a76fbfe", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1822ed6e-9906-4076-ba5c-df4f0e1b594d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "48e99a8c-3bdd-4d50-b67f-e735df971606", "db_currency_id": "cc069114-4833-4b50-b3e5-3cb018d369d8", "db_language_id": "3938ed08-5039-4c58-bcd5-1798c23d8cd5", "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-05-17T14:17:43.6671612+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-05-17T14:17:43.6671612+00:00" }, "company_id": "8f8b294a-eaec-4fb3-bbb8-e45bbfc0bddd", "company_code": "sample string 12", "db_address_id": "e892a497-3d8a-4fce-9123-c3f9ee67abf0", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "620e6c93-3ecc-4875-b5ee-86e14608a030", "contact_reference_back_office": "sample string 17", "owner_user_id": "f10229df-c91e-4fde-8bf9-821d158593b7", "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-05-17T14:17:43.6671612+00:00", "date_create": "2025-05-17T14:17:43.6671612+00:00", "date_update": "2025-05-17T14:17:43.6671612+00:00", "updated_by_user_id": "0dd8485d-7736-43b1-89a9-b8e6b2cfd857", "customer_reference": "sample string 28", "warranty_date_until": "2025-05-17T14:17:43.6671612+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-05-17T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-05-17T14:17:43.6671612+00:00", "date_last_job": "2025-05-17T14:17:43.6671612+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-05-17T14:17:43.6671612+00:00", "modified_dateutc": "2025-05-17T14:17:43.6671612+00:00", "is_mobile_installation": true }