Retrieves all the projects
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
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 |
Response Formats
application/json, text/json
{
"id": "1d7ed9e4-eb86-471a-8cc3-f6906de50bdd",
"_parent_id": "1e3e986a-505a-4803-ba1a-169648ea56dd",
"root_parent_id": "588f9f7d-3743-4c5d-87fb-161e95b23cf6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "36faa20a-7464-47aa-ba25-e4e4e08a7a9e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "76b897ea-2f59-4c57-853a-d23c2ec2763a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0d4414a2-de60-4e03-954e-2569ecdfa560",
"_parent_code": "sample string 6",
"sales_organization_id": "7790266a-029a-486e-aada-2ca63f92e4e0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "20672911-4d69-411f-851e-fa578cbd2f7b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f5add4f-0b75-4de1-83a7-e045f6f028d1",
"db_currency_id": "59b558e1-4929-4a5a-8c4a-6da771edbf07",
"db_language_id": "3ed7bdf5-f3db-49e9-8fc6-59021544e5e1",
"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-12-23T02:30:54.3886507+00:00"
},
"modified_dateutc": "2025-12-23T02:30:54.3886507+00:00"
},
"equipment_model_id": "aeb74512-5688-4cfe-9994-07126faf7f61",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f2a5c575-1062-4789-a3e0-4eeddc8bcf7e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "25943f77-2b96-453c-a2a0-3b9d9ac96292",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5d331729-ce24-4fce-aa47-085b5f728d30",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "648b26fb-bd3c-4134-ad1b-f18f07167347",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "20672911-4d69-411f-851e-fa578cbd2f7b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f5add4f-0b75-4de1-83a7-e045f6f028d1",
"db_currency_id": "59b558e1-4929-4a5a-8c4a-6da771edbf07",
"db_language_id": "3ed7bdf5-f3db-49e9-8fc6-59021544e5e1",
"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-12-23T02:30:54.3886507+00:00"
},
"modified_dateutc": "2025-12-23T02:30:54.3886507+00:00"
},
"equipment_family_id": "810e62d7-42f1-4fb5-bb86-afb06556de0b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "76b897ea-2f59-4c57-853a-d23c2ec2763a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0d4414a2-de60-4e03-954e-2569ecdfa560",
"_parent_code": "sample string 6",
"sales_organization_id": "7790266a-029a-486e-aada-2ca63f92e4e0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "20672911-4d69-411f-851e-fa578cbd2f7b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f5add4f-0b75-4de1-83a7-e045f6f028d1",
"db_currency_id": "59b558e1-4929-4a5a-8c4a-6da771edbf07",
"db_language_id": "3ed7bdf5-f3db-49e9-8fc6-59021544e5e1",
"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-12-23T02:30:54.3886507+00:00"
},
"modified_dateutc": "2025-12-23T02:30:54.3886507+00:00"
},
"date_in_production_since": "2025-12-23T02:30:54.3886507+00:00",
"date_out_of_production_since": "2025-12-23T02:30:54.3886507+00:00",
"date_end_support": "2025-12-23T02:30:54.3886507+00:00",
"sales_organization_id": "50fefcb4-eafb-4467-b9e7-6fea2766de49",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "20672911-4d69-411f-851e-fa578cbd2f7b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f5add4f-0b75-4de1-83a7-e045f6f028d1",
"db_currency_id": "59b558e1-4929-4a5a-8c4a-6da771edbf07",
"db_language_id": "3ed7bdf5-f3db-49e9-8fc6-59021544e5e1",
"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-12-23T02:30:54.3886507+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-12-23T02:30:54.3886507+00:00"
},
"project_status_id": "c15e3a0f-def9-453b-aba3-31e02cb00964",
"project_status_code": "sample string 10",
"project_status": {
"id": "05c81ded-40c5-4f63-95de-ef2b9527337a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "60a3a5ca-783e-45d1-9300-ec3c0dc0e300",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "20672911-4d69-411f-851e-fa578cbd2f7b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f5add4f-0b75-4de1-83a7-e045f6f028d1",
"db_currency_id": "59b558e1-4929-4a5a-8c4a-6da771edbf07",
"db_language_id": "3ed7bdf5-f3db-49e9-8fc6-59021544e5e1",
"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-12-23T02:30:54.3886507+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-23T02:30:54.3886507+00:00"
},
"company_id": "873babc1-4664-46b0-a59b-3b28386323ee",
"company_code": "sample string 12",
"db_address_id": "d37a071c-7b2b-4737-9d77-e360a824bf25",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f171f0e0-a6e9-4403-926f-5473f290fed5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4352604d-ace3-4e1e-aab7-4ab79df74154",
"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-12-23T02:30:54.3886507+00:00",
"date_create": "2025-12-23T02:30:54.3886507+00:00",
"date_update": "2025-12-23T02:30:54.3886507+00:00",
"updated_by_user_id": "100b859a-d97e-425a-866d-2cdd0da60a2b",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-23T02:30:54.3886507+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-12-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-23T02:30:54.3886507+00:00",
"date_last_job": "2025-12-23T02:30:54.3886507+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-23T02:30:54.4042751+00:00",
"modified_dateutc": "2025-12-23T02:30:54.4042751+00:00",
"is_mobile_installation": true
}