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": "e70f0be4-63ee-4494-adee-31479251d76d",
"_parent_id": "a38d5a1b-c2b0-4caf-b305-5a6a25f96877",
"root_parent_id": "f2674e1c-bb95-4ef4-92e2-1aa6dcbed117",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3ba24f4d-8ef2-4b09-9539-02af4ac6cafe",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ba971ce7-0f58-4d85-bee8-42f2845626bb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "492902b8-c0ed-45a8-a62d-fb8a77376ee9",
"_parent_code": "sample string 6",
"sales_organization_id": "ce289888-a0ae-4896-846c-64b3d6695f48",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e2c3aa98-04bc-417c-ab00-f555b40e3836",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3ce9b1f4-42eb-4ffb-8fa3-dadb979135d5",
"db_currency_id": "8f960304-b464-42de-a714-d47cb8eef3ac",
"db_language_id": "e4c430bf-398f-4548-a651-b9cd5bc26a2e",
"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-08-12T19:00:41.6909636+00:00"
},
"modified_dateutc": "2026-08-12T19:00:41.6909636+00:00"
},
"equipment_model_id": "58aee539-2502-4c16-b560-47e49831dfc0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "374eafce-57ad-411a-9881-8bfd8d7ab3c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0f4a159e-5b79-49b8-8ffd-48de3423835b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5d140d13-37d5-42ff-b399-7f97e5fcbc26",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "08dd924f-d01f-49c5-bb81-efe9482df39a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e2c3aa98-04bc-417c-ab00-f555b40e3836",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3ce9b1f4-42eb-4ffb-8fa3-dadb979135d5",
"db_currency_id": "8f960304-b464-42de-a714-d47cb8eef3ac",
"db_language_id": "e4c430bf-398f-4548-a651-b9cd5bc26a2e",
"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-08-12T19:00:41.6909636+00:00"
},
"modified_dateutc": "2026-08-12T19:00:41.6909636+00:00"
},
"equipment_family_id": "d977220a-975f-4ca2-adef-3db98538a400",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ba971ce7-0f58-4d85-bee8-42f2845626bb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "492902b8-c0ed-45a8-a62d-fb8a77376ee9",
"_parent_code": "sample string 6",
"sales_organization_id": "ce289888-a0ae-4896-846c-64b3d6695f48",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e2c3aa98-04bc-417c-ab00-f555b40e3836",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3ce9b1f4-42eb-4ffb-8fa3-dadb979135d5",
"db_currency_id": "8f960304-b464-42de-a714-d47cb8eef3ac",
"db_language_id": "e4c430bf-398f-4548-a651-b9cd5bc26a2e",
"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-08-12T19:00:41.6909636+00:00"
},
"modified_dateutc": "2026-08-12T19:00:41.6909636+00:00"
},
"date_in_production_since": "2026-08-12T19:00:41.6909636+00:00",
"date_out_of_production_since": "2026-08-12T19:00:41.6909636+00:00",
"date_end_support": "2026-08-12T19:00:41.6909636+00:00",
"sales_organization_id": "e09c86ef-9001-417a-afa8-39915f85a3bb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e2c3aa98-04bc-417c-ab00-f555b40e3836",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3ce9b1f4-42eb-4ffb-8fa3-dadb979135d5",
"db_currency_id": "8f960304-b464-42de-a714-d47cb8eef3ac",
"db_language_id": "e4c430bf-398f-4548-a651-b9cd5bc26a2e",
"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-08-12T19:00:41.6909636+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-08-12T19:00:41.6909636+00:00"
},
"project_status_id": "b8c65e2c-d63e-42a6-bee9-e15040dd74bb",
"project_status_code": "sample string 10",
"project_status": {
"id": "b29971ec-6286-466b-bb5b-ab5bd8c46fd9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7bc2f275-38bc-4527-b9c7-16881a32c4f4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e2c3aa98-04bc-417c-ab00-f555b40e3836",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3ce9b1f4-42eb-4ffb-8fa3-dadb979135d5",
"db_currency_id": "8f960304-b464-42de-a714-d47cb8eef3ac",
"db_language_id": "e4c430bf-398f-4548-a651-b9cd5bc26a2e",
"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-08-12T19:00:41.6909636+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-12T19:00:41.6909636+00:00"
},
"company_id": "11aa7a21-df5d-462a-a698-21302b66f5f6",
"company_code": "sample string 12",
"db_address_id": "de634fdd-5b45-49ee-8758-6d1f3fa9bfc3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "33660914-b1c0-4e7b-9ca5-4981504e6a60",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "60a42f2d-18a4-43cf-b08e-7c4ca202adc5",
"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-08-12T19:00:41.6909636+00:00",
"date_create": "2026-08-12T19:00:41.6909636+00:00",
"date_update": "2026-08-12T19:00:41.6909636+00:00",
"updated_by_user_id": "2eed7e47-857f-44ca-8866-c2c1cec67f4c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-12T19:00:41.6909636+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-08-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-12T19:00:41.6909636+00:00",
"date_last_job": "2026-08-12T19:00:41.6909636+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-12T19:00:41.6909636+00:00",
"modified_dateutc": "2026-08-12T19:00:41.6909636+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": "fad9f8ac-0529-4080-8e00-42394440d937",
"_parent_id": "ec689cf6-10bb-49fc-ba6d-ffc9d38c1045",
"root_parent_id": "7ffccd5c-d045-4ded-872f-623fcddf3863",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5284e143-0efd-47e2-adbe-c06c61d7571f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c98c2871-78d7-40bf-b8e3-edc16d2e4024",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "126f379c-c217-40f0-9c70-36db12fe6bba",
"_parent_code": "sample string 6",
"sales_organization_id": "ed43eebc-f251-4775-8052-f49b8eb3a83a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "899b77b4-c811-499f-bb38-23064fb1add7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e5537c-eb18-4ceb-b7d4-e38a3a9053be",
"db_currency_id": "88cb5689-b42a-4a8f-b194-06679f43a8a7",
"db_language_id": "1fbbcd1b-17b9-4222-8af8-869fa518b3f6",
"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-08-12T19:00:41.7534659+00:00"
},
"modified_dateutc": "2026-08-12T19:00:41.7534659+00:00"
},
"equipment_model_id": "b8c54102-bfbe-484c-be24-0d47fe732cfa",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fa279054-15ec-452c-a4f2-4296cf4f4639",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "aebe98a4-398f-4c48-a496-fe54273c0b1f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "90aa1847-a3a9-4014-9eb6-6de4234e3a89",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4d5fbafb-ea31-422c-aafd-0c43c3788a3c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "899b77b4-c811-499f-bb38-23064fb1add7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e5537c-eb18-4ceb-b7d4-e38a3a9053be",
"db_currency_id": "88cb5689-b42a-4a8f-b194-06679f43a8a7",
"db_language_id": "1fbbcd1b-17b9-4222-8af8-869fa518b3f6",
"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-08-12T19:00:41.7534659+00:00"
},
"modified_dateutc": "2026-08-12T19:00:41.7534659+00:00"
},
"equipment_family_id": "c689746c-d229-4ac4-ab49-58ec9f02ea93",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c98c2871-78d7-40bf-b8e3-edc16d2e4024",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "126f379c-c217-40f0-9c70-36db12fe6bba",
"_parent_code": "sample string 6",
"sales_organization_id": "ed43eebc-f251-4775-8052-f49b8eb3a83a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "899b77b4-c811-499f-bb38-23064fb1add7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e5537c-eb18-4ceb-b7d4-e38a3a9053be",
"db_currency_id": "88cb5689-b42a-4a8f-b194-06679f43a8a7",
"db_language_id": "1fbbcd1b-17b9-4222-8af8-869fa518b3f6",
"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-08-12T19:00:41.7534659+00:00"
},
"modified_dateutc": "2026-08-12T19:00:41.7534659+00:00"
},
"date_in_production_since": "2026-08-12T19:00:41.7534659+00:00",
"date_out_of_production_since": "2026-08-12T19:00:41.7534659+00:00",
"date_end_support": "2026-08-12T19:00:41.7534659+00:00",
"sales_organization_id": "83553626-01af-49c9-9539-2a156dee1277",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "899b77b4-c811-499f-bb38-23064fb1add7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e5537c-eb18-4ceb-b7d4-e38a3a9053be",
"db_currency_id": "88cb5689-b42a-4a8f-b194-06679f43a8a7",
"db_language_id": "1fbbcd1b-17b9-4222-8af8-869fa518b3f6",
"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-08-12T19:00:41.7534659+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-08-12T19:00:41.7534659+00:00"
},
"project_status_id": "fc0ade22-a1b2-4fba-99a4-bc39e8b50abc",
"project_status_code": "sample string 10",
"project_status": {
"id": "ea9be49a-61a4-4734-b221-13921e1d8ef8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "44eaaaff-64f5-4cdb-97e3-82689b3f20e2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "899b77b4-c811-499f-bb38-23064fb1add7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e5537c-eb18-4ceb-b7d4-e38a3a9053be",
"db_currency_id": "88cb5689-b42a-4a8f-b194-06679f43a8a7",
"db_language_id": "1fbbcd1b-17b9-4222-8af8-869fa518b3f6",
"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-08-12T19:00:41.7534659+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-12T19:00:41.7534659+00:00"
},
"company_id": "cca0fe30-c20a-4cc6-84c3-cb2e25fa52a7",
"company_code": "sample string 12",
"db_address_id": "46b26982-133c-4b76-8164-395b2f33170f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9b524fc3-9b43-4a29-8a0c-1f1562688e63",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e4c3de24-a75c-46df-8b2d-e860ed1473e1",
"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-08-12T19:00:41.7534659+00:00",
"date_create": "2026-08-12T19:00:41.7534659+00:00",
"date_update": "2026-08-12T19:00:41.7534659+00:00",
"updated_by_user_id": "f64bbe9d-1336-43ad-887d-ec86dd63696a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-12T19:00:41.7534659+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-08-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-12T19:00:41.7534659+00:00",
"date_last_job": "2026-08-12T19:00:41.7534659+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-12T19:00:41.7534659+00:00",
"modified_dateutc": "2026-08-12T19:00:41.7534659+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"
}