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 | |
udf1 |
Custom field udf1 |
string | |
udf2 |
Custom field udf2 |
string | |
udf3 |
Custom field udf3 |
string | |
udf4 |
Custom field udf4 |
string | |
udf5 |
Custom field udf5 |
string | |
udf6 |
Custom field udf6 |
string | |
udf7 |
Custom field udf7 |
string | |
udf8 |
Custom field udf8 |
string | |
udf9 |
Custom field udf9 |
string | |
udf10 |
Custom field udf10 |
string | |
udf11 |
Custom field udf11 |
string | |
udf12 |
Custom field udf12 |
string | |
udf13 |
Custom field udf13 |
string | |
udf14 |
Custom field udf14 |
string | |
udf15 |
Custom field udf15 |
string | |
udf16 |
Custom field udf16 |
string | |
udf17 |
Custom field udf17 |
string | |
udf18 |
Custom field udf18 |
string | |
udf19 |
Custom field udf19 |
string | |
udf20 |
Custom field udf20 |
string | |
udf21 |
Custom field udf21 |
string | |
udf22 |
Custom field udf22 |
string | |
udf23 |
Custom field udf23 |
string | |
udf24 |
Custom field udf24 |
string | |
udf25 |
Custom field udf25 |
string | |
udf26 |
Custom field udf26 |
string | |
udf27 |
Custom field udf27 |
string | |
udf28 |
Custom field udf28 |
string | |
udf29 |
Custom field udf29 |
string | |
udf30 |
Custom field udf30 |
string | |
udf31 |
Custom field udf31 |
string | |
udf32 |
Custom field udf32 |
string | |
udf33 |
Custom field udf33 |
string | |
udf34 |
Custom field udf34 |
string | |
udf35 |
Custom field udf35 |
string | |
udf36 |
Custom field udf36 |
string | |
udf37 |
Custom field udf37 |
string | |
udf38 |
Custom field udf38 |
string | |
udf39 |
Custom field udf39 |
string | |
udf40 |
Custom field udf40 |
string | |
udf41 |
Custom field udf41 |
string | |
udf42 |
Custom field udf42 |
string | |
udf43 |
Custom field udf43 |
string | |
udf44 |
Custom field udf44 |
string | |
udf45 |
Custom field udf45 |
string | |
udf46 |
Custom field udf46 |
string | |
udf47 |
Custom field udf47 |
string | |
udf48 |
Custom field udf48 |
string | |
udf49 |
Custom field udf49 |
string | |
udf50 |
Custom field udf50 |
string | |
udf51 |
Custom field udf51 |
string | |
udf52 |
Custom field udf52 |
string | |
udf53 |
Custom field udf53 |
string | |
udf54 |
Custom field udf54 |
string | |
udf55 |
Custom field udf55 |
string | |
udf56 |
Custom field udf56 |
string | |
udf57 |
Custom field udf57 |
string | |
udf58 |
Custom field udf58 |
string | |
udf59 |
Custom field udf59 |
string | |
udf60 |
Custom field udf60 |
string | |
udf61 |
Custom field udf61 |
string | |
udf62 |
Custom field udf62 |
string | |
udf63 |
Custom field udf63 |
string | |
udf64 |
Custom field udf64 |
string | |
udf65 |
Custom field udf65 |
string | |
udf66 |
Custom field udf66 |
string | |
udf67 |
Custom field udf67 |
string | |
udf68 |
Custom field udf68 |
string | |
udf69 |
Custom field udf69 |
string | |
udf70 |
Custom field udf70 |
string | |
udf71 |
Custom field udf71 |
string | |
udf72 |
Custom field udf72 |
string | |
udf73 |
Custom field udf73 |
string | |
udf74 |
Custom field udf74 |
string | |
udf75 |
Custom field udf75 |
string | |
udf76 |
Custom field udf76 |
string | |
udf77 |
Custom field udf77 |
string | |
udf78 |
Custom field udf78 |
string | |
udf79 |
Custom field udf79 |
string | |
udf80 |
Custom field udf80 |
string | |
udf81 |
Custom field udf81 |
string | |
udf82 |
Custom field udf82 |
string | |
udf83 |
Custom field udf83 |
string | |
udf84 |
Custom field udf84 |
string | |
udf85 |
Custom field udf85 |
string | |
udf86 |
Custom field udf86 |
string | |
udf87 |
Custom field udf87 |
string | |
udf88 |
Custom field udf88 |
string | |
udf89 |
Custom field udf89 |
string | |
udf90 |
Custom field udf90 |
string | |
udf91 |
Custom field udf91 |
string | |
udf92 |
Custom field udf92 |
string | |
udf93 |
Custom field udf93 |
string | |
udf94 |
Custom field udf94 |
string | |
udf95 |
Custom field udf95 |
string | |
udf96 |
Custom field udf96 |
string | |
udf97 |
Custom field udf97 |
string | |
udf98 |
Custom field udf98 |
string | |
udf99 |
Custom field udf99 |
string | |
udf100 |
Custom field udf100 |
string |
Response Formats
application/json, text/json
{ "id": "598cfd9c-6c99-4038-ba26-ae3b56c010b7", "_parent_id": "87e275ab-c40e-4089-bfe4-8f229bed9ada", "root_parent_id": "7ba034ce-4344-4eee-bb83-cf0f89bdae25", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "c63e70c5-defc-44c1-80e0-10baaa7fbec2", "equipment_family_code": "sample string 6", "equipment_family": { "id": "1be7b31d-c081-4983-8952-d19f77f5c841", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "1706875a-d587-4af2-b772-af857f44986c", "_parent_code": "sample string 6", "sales_organization_id": "7c45a644-f8e0-4c5e-bae7-6dc4a5418422", "sales_organization_code": "sample string 8", "sales_organization": { "id": "a0607c45-d22e-4932-bfc8-e197407988f0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "60701afa-6e96-4d3d-a5a4-30683bb97666", "db_currency_id": "50a3f091-6173-4e8e-9dc8-8f4a8932734b", "db_language_id": "8089c751-dfb9-4e09-bc5e-d3fb1626581f", "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-07T05:49:06.9843477+00:00" }, "modified_dateutc": "2025-06-07T05:49:06.9843477+00:00" }, "equipment_model_id": "b454e6ea-4e8e-42a4-8700-a5512b597358", "equipment_model_code": "sample string 8", "equipment_model": { "id": "6168948b-cead-4d3d-ab2e-b2bbbc4f368e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "8bdd3697-d5dc-46c6-b0cb-408572c110f5", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "3ee0583b-4eda-4aaf-8ca8-9bae786f26ca", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "6a02677f-0432-4e5d-9dff-b887327939da", "sales_organization_code": "sample string 5", "sales_organization": { "id": "a0607c45-d22e-4932-bfc8-e197407988f0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "60701afa-6e96-4d3d-a5a4-30683bb97666", "db_currency_id": "50a3f091-6173-4e8e-9dc8-8f4a8932734b", "db_language_id": "8089c751-dfb9-4e09-bc5e-d3fb1626581f", "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-07T05:49:06.9843477+00:00" }, "modified_dateutc": "2025-06-07T05:49:06.9843477+00:00" }, "equipment_family_id": "01ede711-e8b5-4fd3-8848-0a5b428a6f77", "equipment_family_code": "sample string 8", "equipment_family": { "id": "1be7b31d-c081-4983-8952-d19f77f5c841", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "1706875a-d587-4af2-b772-af857f44986c", "_parent_code": "sample string 6", "sales_organization_id": "7c45a644-f8e0-4c5e-bae7-6dc4a5418422", "sales_organization_code": "sample string 8", "sales_organization": { "id": "a0607c45-d22e-4932-bfc8-e197407988f0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "60701afa-6e96-4d3d-a5a4-30683bb97666", "db_currency_id": "50a3f091-6173-4e8e-9dc8-8f4a8932734b", "db_language_id": "8089c751-dfb9-4e09-bc5e-d3fb1626581f", "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-07T05:49:06.9843477+00:00" }, "modified_dateutc": "2025-06-07T05:49:06.9843477+00:00" }, "date_in_production_since": "2025-06-07T05:49:06.9843477+00:00", "date_out_of_production_since": "2025-06-07T05:49:06.9843477+00:00", "date_end_support": "2025-06-07T05:49:06.9843477+00:00", "sales_organization_id": "0e33dafb-aef6-4911-bd1f-bebf98194d04", "sales_organization_code": "sample string 13", "sales_organization": { "id": "a0607c45-d22e-4932-bfc8-e197407988f0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "60701afa-6e96-4d3d-a5a4-30683bb97666", "db_currency_id": "50a3f091-6173-4e8e-9dc8-8f4a8932734b", "db_language_id": "8089c751-dfb9-4e09-bc5e-d3fb1626581f", "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-07T05:49:06.9843477+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-07T05:49:06.9843477+00:00" }, "project_status_id": "e86c7584-8c5d-4c14-b1bc-012e02162207", "project_status_code": "sample string 10", "project_status": { "id": "4ab1bf19-26d0-44f3-8607-da41367099a5", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "a6f7f93d-316a-4c2a-b545-b78353259a5f", "sales_organization_code": "sample string 6", "sales_organization": { "id": "a0607c45-d22e-4932-bfc8-e197407988f0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "60701afa-6e96-4d3d-a5a4-30683bb97666", "db_currency_id": "50a3f091-6173-4e8e-9dc8-8f4a8932734b", "db_language_id": "8089c751-dfb9-4e09-bc5e-d3fb1626581f", "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-07T05:49:06.9843477+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-07T05:49:06.9843477+00:00" }, "company_id": "4ea05add-d46b-466f-a29f-1001a0014a2c", "company_code": "sample string 12", "db_address_id": "523b1c95-07c8-4a37-8e39-93a0cd05f52b", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "0d197d08-9d3d-4847-aaa8-f1e7075f2279", "contact_reference_back_office": "sample string 17", "owner_user_id": "76757396-f3de-4c9a-ae2f-c90b22a0124e", "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-07T05:49:06.9843477+00:00", "date_create": "2025-06-07T05:49:06.9843477+00:00", "date_update": "2025-06-07T05:49:06.9843477+00:00", "updated_by_user_id": "bfda20a5-eb8c-4539-ac7f-7a77db918972", "customer_reference": "sample string 28", "warranty_date_until": "2025-06-07T05:49:06.9843477+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-07T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-06-07T05:49:06.9843477+00:00", "date_last_job": "2025-06-07T05:49:06.9843477+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-06-07T05:49:06.9843477+00:00", "modified_dateutc": "2025-06-07T05:49:06.9843477+00:00", "is_mobile_installation": true, "udf1": "sample string 46", "udf2": "sample string 47", "udf3": "sample string 48", "udf4": "sample string 49", "udf5": "sample string 50", "udf6": "sample string 51", "udf7": "sample string 52", "udf8": "sample string 53", "udf9": "sample string 54", "udf10": "sample string 55", "udf11": "sample string 56", "udf12": "sample string 57", "udf13": "sample string 58", "udf14": "sample string 59", "udf15": "sample string 60", "udf16": "sample string 61", "udf17": "sample string 62", "udf18": "sample string 63", "udf19": "sample string 64", "udf20": "sample string 65", "udf21": "sample string 66", "udf22": "sample string 67", "udf23": "sample string 68", "udf24": "sample string 69", "udf25": "sample string 70", "udf26": "sample string 71", "udf27": "sample string 72", "udf28": "sample string 73", "udf29": "sample string 74", "udf30": "sample string 75", "udf31": "sample string 76", "udf32": "sample string 77", "udf33": "sample string 78", "udf34": "sample string 79", "udf35": "sample string 80", "udf36": "sample string 81", "udf37": "sample string 82", "udf38": "sample string 83", "udf39": "sample string 84", "udf40": "sample string 85", "udf41": "sample string 86", "udf42": "sample string 87", "udf43": "sample string 88", "udf44": "sample string 89", "udf45": "sample string 90", "udf46": "sample string 91", "udf47": "sample string 92", "udf48": "sample string 93", "udf49": "sample string 94", "udf50": "sample string 95", "udf51": "sample string 96", "udf52": "sample string 97", "udf53": "sample string 98", "udf54": "sample string 99", "udf55": "sample string 100", "udf56": "sample string 101", "udf57": "sample string 102", "udf58": "sample string 103", "udf59": "sample string 104", "udf60": "sample string 105", "udf61": "sample string 106", "udf62": "sample string 107", "udf63": "sample string 108", "udf64": "sample string 109", "udf65": "sample string 110", "udf66": "sample string 111", "udf67": "sample string 112", "udf68": "sample string 113", "udf69": "sample string 114", "udf70": "sample string 115", "udf71": "sample string 116", "udf72": "sample string 117", "udf73": "sample string 118", "udf74": "sample string 119", "udf75": "sample string 120", "udf76": "sample string 121", "udf77": "sample string 122", "udf78": "sample string 123", "udf79": "sample string 124", "udf80": "sample string 125", "udf81": "sample string 126", "udf82": "sample string 127", "udf83": "sample string 128", "udf84": "sample string 129", "udf85": "sample string 130", "udf86": "sample string 131", "udf87": "sample string 132", "udf88": "sample string 133", "udf89": "sample string 134", "udf90": "sample string 135", "udf91": "sample string 136", "udf92": "sample string 137", "udf93": "sample string 138", "udf94": "sample string 139", "udf95": "sample string 140", "udf96": "sample string 141", "udf97": "sample string 142", "udf98": "sample string 143", "udf99": "sample string 144", "udf100": "sample string 145" }