Creates a new project
Request Information
URI Parameters :
None.
Body Parameters :
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 | |
| 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": "4b83f0d3-14fb-4865-86d3-d433cf822da9",
"_parent_id": "77307c0c-6253-45c3-9b4b-0333b8fe719f",
"root_parent_id": "d2d1980b-97bd-467a-ac1f-da2f9d288ebe",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "77811f54-be48-41a5-ac3c-132b3348c6e8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "93de99a7-0831-4ac4-b81c-70cc08ea9a56",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b8cd295b-5971-433a-a11d-cbd0d6f241fe",
"_parent_code": "sample string 6",
"sales_organization_id": "23d18c1b-76f2-4a8b-89e1-b6042bc0a9c7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ed92490b-6c16-497c-afdc-bdc6920880f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7d59202-0c35-477c-9da0-7ded4a21d36d",
"db_currency_id": "a802422b-70dd-4dd6-8079-0de332657528",
"db_language_id": "4402c1c6-5cf3-4434-b8a8-552227d2155c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-09-11T11:33:09.741245+00:00"
},
"modified_dateutc": "2026-09-11T11:33:09.741245+00:00"
},
"equipment_model_id": "ac894923-0bd2-4833-8972-0b45964689d5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8f4f50ea-6a8c-4f7d-94a9-fe21149b1e42",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d7e3ade1-1e19-4880-915e-670f4a2248a2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9aad1875-82d7-433a-8c1b-02c36cb80232",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "effc9a5d-b470-428a-9aef-49e9fe4bb994",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ed92490b-6c16-497c-afdc-bdc6920880f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7d59202-0c35-477c-9da0-7ded4a21d36d",
"db_currency_id": "a802422b-70dd-4dd6-8079-0de332657528",
"db_language_id": "4402c1c6-5cf3-4434-b8a8-552227d2155c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-09-11T11:33:09.741245+00:00"
},
"modified_dateutc": "2026-09-11T11:33:09.741245+00:00"
},
"equipment_family_id": "5fcc26de-2e26-4275-9028-8fa148d407ed",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "93de99a7-0831-4ac4-b81c-70cc08ea9a56",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b8cd295b-5971-433a-a11d-cbd0d6f241fe",
"_parent_code": "sample string 6",
"sales_organization_id": "23d18c1b-76f2-4a8b-89e1-b6042bc0a9c7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ed92490b-6c16-497c-afdc-bdc6920880f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7d59202-0c35-477c-9da0-7ded4a21d36d",
"db_currency_id": "a802422b-70dd-4dd6-8079-0de332657528",
"db_language_id": "4402c1c6-5cf3-4434-b8a8-552227d2155c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-09-11T11:33:09.741245+00:00"
},
"modified_dateutc": "2026-09-11T11:33:09.741245+00:00"
},
"date_in_production_since": "2026-09-11T11:33:09.741245+00:00",
"date_out_of_production_since": "2026-09-11T11:33:09.741245+00:00",
"date_end_support": "2026-09-11T11:33:09.741245+00:00",
"sales_organization_id": "78f0f195-f70c-47cd-918e-2db69d1fc3fc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ed92490b-6c16-497c-afdc-bdc6920880f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7d59202-0c35-477c-9da0-7ded4a21d36d",
"db_currency_id": "a802422b-70dd-4dd6-8079-0de332657528",
"db_language_id": "4402c1c6-5cf3-4434-b8a8-552227d2155c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-09-11T11:33:09.741245+00:00"
},
"replacement_period_nb_months": 14,
"warranty_period_nb_months": 15,
"translations": [
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
},
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
}
],
"modified_dateutc": "2026-09-11T11:33:09.741245+00:00"
},
"project_status_id": "6365fa37-0b5d-464a-96cc-fa4066258fb8",
"project_status_code": "sample string 10",
"project_status": {
"id": "3748bdaf-e348-475d-88bd-10562ef1ce35",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d803be50-45a0-480d-be10-fa18c0842080",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ed92490b-6c16-497c-afdc-bdc6920880f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7d59202-0c35-477c-9da0-7ded4a21d36d",
"db_currency_id": "a802422b-70dd-4dd6-8079-0de332657528",
"db_language_id": "4402c1c6-5cf3-4434-b8a8-552227d2155c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-09-11T11:33:09.741245+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T11:33:09.741245+00:00"
},
"company_id": "07dbd489-8e61-433e-90c6-6a7abade0c55",
"company_code": "sample string 12",
"db_address_id": "da26d7e1-632a-4662-bd06-2219bbb74f86",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c52c13eb-b650-4b74-82b1-b6350ae6cf2e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "febf49c9-92d6-4c1b-836b-5373ade07273",
"name": "sample string 19",
"description": "sample string 20",
"reference_back_office": "sample string 21",
"serial_number": "sample string 22",
"barcode": "sample string 23",
"date_start_production": "2026-09-11T11:33:09.741245+00:00",
"date_create": "2026-09-11T11:33:09.741245+00:00",
"date_update": "2026-09-11T11:33:09.741245+00:00",
"updated_by_user_id": "9bcb7b6e-368a-4e64-b4db-fcd8d59cd84d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-11T11:33:09.741245+00:00",
"last_standard_result_score_1": "sample string 30",
"last_standard_result_score_2": "sample string 31",
"target_standard_result_score_1": "sample string 32",
"target_standard_result_score_2": "sample string 33",
"date_built": "2026-09-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-11T11:33:09.741245+00:00",
"date_last_job": "2026-09-11T11:33:09.741245+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-11T11:33:09.741245+00:00",
"modified_dateutc": "2026-09-11T11:33:09.741245+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 :
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 | |
| 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": "46083181-ac6d-4b3e-a299-0c843193f3dd",
"_parent_id": "74bfa205-f311-485f-82bb-dd985b201a2f",
"root_parent_id": "fa7ebeb3-8e46-46e9-8c3d-911384363e4c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "526cc199-391f-42f7-a94b-bdc2f2d28e15",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9f439511-078a-4e42-8c93-62d95e050edb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6d2b1437-e10e-4088-9cf8-4301033f21a8",
"_parent_code": "sample string 6",
"sales_organization_id": "f4d61db8-8c58-4ba0-9629-2888ca6ebd8a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "951b5468-d42f-4142-b9e5-f33ea3dc7a62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ac0f4f6-2926-4fcf-8a3e-2cb10fb73cc7",
"db_currency_id": "deb7bb45-4486-46b8-8aa0-aa4d2c593184",
"db_language_id": "9283da0f-b5e4-4f97-a1c7-a2ab693f4535",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-09-11T11:33:09.8193705+00:00"
},
"modified_dateutc": "2026-09-11T11:33:09.8193705+00:00"
},
"equipment_model_id": "f5b26014-5ddb-4273-8978-bee784fd61bd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b24b9ba4-7286-4116-a0fd-99cfff78c809",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "24fc1b6e-27bc-4482-9a6d-8924eb2a72ad",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ad493d4c-fa8f-4295-aac9-2806f676704d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d5b62e78-7700-4819-be5e-cd084dedd057",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "951b5468-d42f-4142-b9e5-f33ea3dc7a62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ac0f4f6-2926-4fcf-8a3e-2cb10fb73cc7",
"db_currency_id": "deb7bb45-4486-46b8-8aa0-aa4d2c593184",
"db_language_id": "9283da0f-b5e4-4f97-a1c7-a2ab693f4535",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-09-11T11:33:09.8193705+00:00"
},
"modified_dateutc": "2026-09-11T11:33:09.8193705+00:00"
},
"equipment_family_id": "b6007a4c-5ac0-495a-8824-6cd22be21eea",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9f439511-078a-4e42-8c93-62d95e050edb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6d2b1437-e10e-4088-9cf8-4301033f21a8",
"_parent_code": "sample string 6",
"sales_organization_id": "f4d61db8-8c58-4ba0-9629-2888ca6ebd8a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "951b5468-d42f-4142-b9e5-f33ea3dc7a62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ac0f4f6-2926-4fcf-8a3e-2cb10fb73cc7",
"db_currency_id": "deb7bb45-4486-46b8-8aa0-aa4d2c593184",
"db_language_id": "9283da0f-b5e4-4f97-a1c7-a2ab693f4535",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-09-11T11:33:09.8193705+00:00"
},
"modified_dateutc": "2026-09-11T11:33:09.8193705+00:00"
},
"date_in_production_since": "2026-09-11T11:33:09.8193705+00:00",
"date_out_of_production_since": "2026-09-11T11:33:09.8193705+00:00",
"date_end_support": "2026-09-11T11:33:09.8193705+00:00",
"sales_organization_id": "16ca2d92-3844-46e5-ae10-751ebbdc27b5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "951b5468-d42f-4142-b9e5-f33ea3dc7a62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ac0f4f6-2926-4fcf-8a3e-2cb10fb73cc7",
"db_currency_id": "deb7bb45-4486-46b8-8aa0-aa4d2c593184",
"db_language_id": "9283da0f-b5e4-4f97-a1c7-a2ab693f4535",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-09-11T11:33:09.8193705+00:00"
},
"replacement_period_nb_months": 14,
"warranty_period_nb_months": 15,
"translations": [
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
},
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
}
],
"modified_dateutc": "2026-09-11T11:33:09.8193705+00:00"
},
"project_status_id": "39ba56c2-7bc7-4445-b86a-2e5f603dacaf",
"project_status_code": "sample string 10",
"project_status": {
"id": "20e2c7eb-2967-4c34-8c8e-9b2949d04a20",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8172791e-bee5-41d5-a0fa-aa7af474f994",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "951b5468-d42f-4142-b9e5-f33ea3dc7a62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ac0f4f6-2926-4fcf-8a3e-2cb10fb73cc7",
"db_currency_id": "deb7bb45-4486-46b8-8aa0-aa4d2c593184",
"db_language_id": "9283da0f-b5e4-4f97-a1c7-a2ab693f4535",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-09-11T11:33:09.8193705+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T11:33:09.8193705+00:00"
},
"company_id": "bad3c2c6-bb1e-47f2-b94d-99921824cafe",
"company_code": "sample string 12",
"db_address_id": "f455421f-723a-4c08-8bbc-877615d725f1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "65260694-f5f1-44f2-9e45-c8b871578901",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a0dd2d5a-9e6b-4591-85a7-0f632181b154",
"name": "sample string 19",
"description": "sample string 20",
"reference_back_office": "sample string 21",
"serial_number": "sample string 22",
"barcode": "sample string 23",
"date_start_production": "2026-09-11T11:33:09.8193705+00:00",
"date_create": "2026-09-11T11:33:09.8193705+00:00",
"date_update": "2026-09-11T11:33:09.8193705+00:00",
"updated_by_user_id": "dd172958-5fe6-4664-940f-28c63a50a504",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-11T11:33:09.8193705+00:00",
"last_standard_result_score_1": "sample string 30",
"last_standard_result_score_2": "sample string 31",
"target_standard_result_score_1": "sample string 32",
"target_standard_result_score_2": "sample string 33",
"date_built": "2026-09-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-11T11:33:09.8193705+00:00",
"date_last_job": "2026-09-11T11:33:09.8193705+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-11T11:33:09.8193705+00:00",
"modified_dateutc": "2026-09-11T11:33:09.8193705+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"
}