Creates a new project
Request Information
URI Parameters :
None.
Body Parameters :
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 |
Request Formats :
application/json, text/json
{ "id": "b98b8bc8-6453-41ce-93b5-3836d437fca7", "_parent_id": "b04a764b-cecb-4608-8fea-ca8a99072ab0", "root_parent_id": "90251a16-6600-4381-bb15-940c28dce95d", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "f919a8ed-e27d-4753-9ea7-8331541a95ad", "equipment_family_code": "sample string 6", "equipment_family": { "id": "cec68280-128e-4e59-bce2-270eb064a025", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "7c097ff2-6507-4239-9d00-27083383b1a6", "_parent_code": "sample string 6", "sales_organization_id": "ab2f539b-ff6c-4303-8555-7ae2df1815e0", "sales_organization_code": "sample string 8", "sales_organization": { "id": "528e4d03-b393-4c43-9106-5f57b9fdd623", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "67b8ef75-1f9b-480e-927d-1d6f393eb387", "db_currency_id": "86692e2b-75f0-4fcc-874e-2e5f8d95652a", "db_language_id": "12f9b9d1-7be4-461c-9384-d326b1a9db61", "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-27T00:46:09.3759476+00:00" }, "modified_dateutc": "2025-06-27T00:46:09.3759476+00:00" }, "equipment_model_id": "d49392d1-9f5c-40d5-aaaa-a3d32bfd7b20", "equipment_model_code": "sample string 8", "equipment_model": { "id": "09f5c705-0ed5-41f8-ac3e-ee3705a19ae3", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "b7585192-0472-402d-9200-1d7240d20a86", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "f4f336b8-4d97-4dc9-82f3-2bfd2bc4af65", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "47e55dd2-d3b7-4f3d-a9e3-8b6cb8e12496", "sales_organization_code": "sample string 5", "sales_organization": { "id": "528e4d03-b393-4c43-9106-5f57b9fdd623", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "67b8ef75-1f9b-480e-927d-1d6f393eb387", "db_currency_id": "86692e2b-75f0-4fcc-874e-2e5f8d95652a", "db_language_id": "12f9b9d1-7be4-461c-9384-d326b1a9db61", "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-27T00:46:09.3759476+00:00" }, "modified_dateutc": "2025-06-27T00:46:09.3759476+00:00" }, "equipment_family_id": "6f62fa27-07d9-46ce-937a-17f56840805c", "equipment_family_code": "sample string 8", "equipment_family": { "id": "cec68280-128e-4e59-bce2-270eb064a025", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "7c097ff2-6507-4239-9d00-27083383b1a6", "_parent_code": "sample string 6", "sales_organization_id": "ab2f539b-ff6c-4303-8555-7ae2df1815e0", "sales_organization_code": "sample string 8", "sales_organization": { "id": "528e4d03-b393-4c43-9106-5f57b9fdd623", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "67b8ef75-1f9b-480e-927d-1d6f393eb387", "db_currency_id": "86692e2b-75f0-4fcc-874e-2e5f8d95652a", "db_language_id": "12f9b9d1-7be4-461c-9384-d326b1a9db61", "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-27T00:46:09.3759476+00:00" }, "modified_dateutc": "2025-06-27T00:46:09.3759476+00:00" }, "date_in_production_since": "2025-06-27T00:46:09.3759476+00:00", "date_out_of_production_since": "2025-06-27T00:46:09.3759476+00:00", "date_end_support": "2025-06-27T00:46:09.3759476+00:00", "sales_organization_id": "df7aefe6-d012-4d70-ab9c-30bcb2e21ba5", "sales_organization_code": "sample string 13", "sales_organization": { "id": "528e4d03-b393-4c43-9106-5f57b9fdd623", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "67b8ef75-1f9b-480e-927d-1d6f393eb387", "db_currency_id": "86692e2b-75f0-4fcc-874e-2e5f8d95652a", "db_language_id": "12f9b9d1-7be4-461c-9384-d326b1a9db61", "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-27T00:46:09.3759476+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-27T00:46:09.3759476+00:00" }, "project_status_id": "9238de65-30bc-4b23-bf37-421166bd19d8", "project_status_code": "sample string 10", "project_status": { "id": "59bcbf4a-027a-4d1f-b5eb-25c5cfe08b74", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "f2197919-7400-460a-b8a5-627b89e0c84e", "sales_organization_code": "sample string 6", "sales_organization": { "id": "528e4d03-b393-4c43-9106-5f57b9fdd623", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "67b8ef75-1f9b-480e-927d-1d6f393eb387", "db_currency_id": "86692e2b-75f0-4fcc-874e-2e5f8d95652a", "db_language_id": "12f9b9d1-7be4-461c-9384-d326b1a9db61", "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-27T00:46:09.3759476+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-27T00:46:09.3936818+00:00" }, "company_id": "97494821-e811-4f0f-aa76-f72801a5b054", "company_code": "sample string 12", "db_address_id": "88d4c8ae-fe81-4ca3-9263-b720fde239e2", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "fd88766b-26f6-410a-9d5e-4d4d0b18ec84", "contact_reference_back_office": "sample string 17", "owner_user_id": "8ce02a9a-2c60-47f7-b833-48d5bb1a8564", "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-27T00:46:09.3936818+00:00", "date_create": "2025-06-27T00:46:09.3936818+00:00", "date_update": "2025-06-27T00:46:09.3936818+00:00", "updated_by_user_id": "d161577e-de28-40b2-bad6-ef105c502409", "customer_reference": "sample string 28", "warranty_date_until": "2025-06-27T00:46:09.3936818+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-27T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-06-27T00:46:09.3936818+00:00", "date_last_job": "2025-06-27T00:46:09.3936818+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-06-27T00:46:09.3936818+00:00", "modified_dateutc": "2025-06-27T00:46:09.3936818+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" }
Response Information
Resource Description :
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": "280c1b71-00d0-47f7-97dd-e95ff5d0cd0a", "_parent_id": "90f0057d-2d80-404a-b77e-2eed76f0ca9a", "root_parent_id": "154fd043-3840-44f9-8579-2157480f9b8d", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "a40b11bb-e706-4dff-a8db-ec99c71c3706", "equipment_family_code": "sample string 6", "equipment_family": { "id": "7a3cdd75-15aa-4e85-9c6f-42f02f56c6d9", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "3faf2ce4-d47f-4c5d-a6d0-b8536f13cd18", "_parent_code": "sample string 6", "sales_organization_id": "be1dc0a5-a1b4-4aa3-8af5-ec71e5157169", "sales_organization_code": "sample string 8", "sales_organization": { "id": "9521348f-95ff-4768-a8e3-de256d1a465d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "74614ddd-6bd5-475f-9123-ba2680250d9e", "db_currency_id": "f5dec15a-5c95-48cd-87dd-7fc684e1317c", "db_language_id": "cefa8a54-f46c-46f8-83e2-0722445cb2e0", "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-27T00:46:09.3936818+00:00" }, "modified_dateutc": "2025-06-27T00:46:09.3936818+00:00" }, "equipment_model_id": "9b6242d1-6660-487e-8284-44a2386be876", "equipment_model_code": "sample string 8", "equipment_model": { "id": "d6cbb5cd-53fd-4c13-a92b-f67347d9e76b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "f0151f50-f19c-4624-8d5a-7cd07682afd8", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "8300acb6-dbbe-4110-941d-1733efd8b901", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "90f8269d-8971-4ffb-8326-e47d3e298c5f", "sales_organization_code": "sample string 5", "sales_organization": { "id": "9521348f-95ff-4768-a8e3-de256d1a465d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "74614ddd-6bd5-475f-9123-ba2680250d9e", "db_currency_id": "f5dec15a-5c95-48cd-87dd-7fc684e1317c", "db_language_id": "cefa8a54-f46c-46f8-83e2-0722445cb2e0", "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-27T00:46:09.3936818+00:00" }, "modified_dateutc": "2025-06-27T00:46:09.3936818+00:00" }, "equipment_family_id": "cd300cf6-5d84-486f-b719-12b1a0239620", "equipment_family_code": "sample string 8", "equipment_family": { "id": "7a3cdd75-15aa-4e85-9c6f-42f02f56c6d9", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "3faf2ce4-d47f-4c5d-a6d0-b8536f13cd18", "_parent_code": "sample string 6", "sales_organization_id": "be1dc0a5-a1b4-4aa3-8af5-ec71e5157169", "sales_organization_code": "sample string 8", "sales_organization": { "id": "9521348f-95ff-4768-a8e3-de256d1a465d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "74614ddd-6bd5-475f-9123-ba2680250d9e", "db_currency_id": "f5dec15a-5c95-48cd-87dd-7fc684e1317c", "db_language_id": "cefa8a54-f46c-46f8-83e2-0722445cb2e0", "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-27T00:46:09.3936818+00:00" }, "modified_dateutc": "2025-06-27T00:46:09.3936818+00:00" }, "date_in_production_since": "2025-06-27T00:46:09.3936818+00:00", "date_out_of_production_since": "2025-06-27T00:46:09.3936818+00:00", "date_end_support": "2025-06-27T00:46:09.3936818+00:00", "sales_organization_id": "86ec0852-418e-4da1-9303-16a7e4ac3c55", "sales_organization_code": "sample string 13", "sales_organization": { "id": "9521348f-95ff-4768-a8e3-de256d1a465d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "74614ddd-6bd5-475f-9123-ba2680250d9e", "db_currency_id": "f5dec15a-5c95-48cd-87dd-7fc684e1317c", "db_language_id": "cefa8a54-f46c-46f8-83e2-0722445cb2e0", "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-27T00:46:09.3936818+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-27T00:46:09.3936818+00:00" }, "project_status_id": "a9ab80ae-2c76-4fe8-9aff-914b6a914006", "project_status_code": "sample string 10", "project_status": { "id": "97d53d06-a540-4a76-ba36-3a7612257c69", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "6b1cdd5d-6b28-48fd-9732-da871b4ce1ab", "sales_organization_code": "sample string 6", "sales_organization": { "id": "9521348f-95ff-4768-a8e3-de256d1a465d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "74614ddd-6bd5-475f-9123-ba2680250d9e", "db_currency_id": "f5dec15a-5c95-48cd-87dd-7fc684e1317c", "db_language_id": "cefa8a54-f46c-46f8-83e2-0722445cb2e0", "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-27T00:46:09.3936818+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-27T00:46:09.3936818+00:00" }, "company_id": "19259b56-4e70-4041-8127-caab105cf1dd", "company_code": "sample string 12", "db_address_id": "21b59dcd-ff66-43c4-a8c8-c7e309c591df", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "7f67ae99-0e0f-466c-89cf-8338b50576e5", "contact_reference_back_office": "sample string 17", "owner_user_id": "9148182a-9df7-40bc-808d-721d17431b78", "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-27T00:46:09.3936818+00:00", "date_create": "2025-06-27T00:46:09.3936818+00:00", "date_update": "2025-06-27T00:46:09.3936818+00:00", "updated_by_user_id": "d75baca3-3986-4895-b13c-512346098a47", "customer_reference": "sample string 28", "warranty_date_until": "2025-06-27T00:46:09.3936818+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-27T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-06-27T00:46:09.3936818+00:00", "date_last_job": "2025-06-27T00:46:09.3936818+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-06-27T00:46:09.3936818+00:00", "modified_dateutc": "2025-06-27T00:46:09.3936818+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" }