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": "b60bd455-f5e9-4475-af36-6044156f531e",
"_parent_id": "42b1f7d8-f85d-4a7f-afc8-68f8609be77b",
"root_parent_id": "903ace92-6095-493e-accb-df1fbb9c0dca",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1d07b0ff-de8a-4d57-9061-779273f55b29",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fffce6f6-d09e-48f3-bd01-820bca78e16d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8b8b2f98-16b5-47e5-a7d0-8bb2548a5a15",
"_parent_code": "sample string 6",
"sales_organization_id": "206d50ee-ae1d-49d2-91e5-e9674b6a96c0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3740649a-95a9-4f5f-b337-e39d495f4453",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ddde253a-e078-4c1c-8fc3-0c79fb38d053",
"db_currency_id": "d239bcfd-ade7-43d4-ab1a-7be598de9a0b",
"db_language_id": "962bb884-f202-4fb9-a925-f02f68fe452d",
"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-10-31T05:32:47.6628022+00:00"
},
"modified_dateutc": "2026-10-31T05:32:47.6740433+00:00"
},
"equipment_model_id": "64f2c1f7-ff47-4d60-979a-d8a03cbbd77b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9221d589-5842-41ad-905d-ac1800e62e2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c4a9ef4f-b6e7-48f6-ad15-8dfc9e89b8c3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c62c476c-70cf-48b0-aa84-5a3916247af0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7e95286b-91dd-42be-90b4-75321b081778",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3740649a-95a9-4f5f-b337-e39d495f4453",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ddde253a-e078-4c1c-8fc3-0c79fb38d053",
"db_currency_id": "d239bcfd-ade7-43d4-ab1a-7be598de9a0b",
"db_language_id": "962bb884-f202-4fb9-a925-f02f68fe452d",
"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-10-31T05:32:47.6628022+00:00"
},
"modified_dateutc": "2026-10-31T05:32:47.6740433+00:00"
},
"equipment_family_id": "6a082c7f-3d0b-43ed-89e5-d35d43711b56",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fffce6f6-d09e-48f3-bd01-820bca78e16d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8b8b2f98-16b5-47e5-a7d0-8bb2548a5a15",
"_parent_code": "sample string 6",
"sales_organization_id": "206d50ee-ae1d-49d2-91e5-e9674b6a96c0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3740649a-95a9-4f5f-b337-e39d495f4453",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ddde253a-e078-4c1c-8fc3-0c79fb38d053",
"db_currency_id": "d239bcfd-ade7-43d4-ab1a-7be598de9a0b",
"db_language_id": "962bb884-f202-4fb9-a925-f02f68fe452d",
"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-10-31T05:32:47.6628022+00:00"
},
"modified_dateutc": "2026-10-31T05:32:47.6740433+00:00"
},
"date_in_production_since": "2026-10-31T05:32:47.6740433+00:00",
"date_out_of_production_since": "2026-10-31T05:32:47.6740433+00:00",
"date_end_support": "2026-10-31T05:32:47.6740433+00:00",
"sales_organization_id": "52673d92-08dd-482f-b036-ed8ce7f361d4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3740649a-95a9-4f5f-b337-e39d495f4453",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ddde253a-e078-4c1c-8fc3-0c79fb38d053",
"db_currency_id": "d239bcfd-ade7-43d4-ab1a-7be598de9a0b",
"db_language_id": "962bb884-f202-4fb9-a925-f02f68fe452d",
"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-10-31T05:32:47.6628022+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-10-31T05:32:47.6740433+00:00"
},
"project_status_id": "82e4f2be-d193-4b5f-a90c-2df4a5563571",
"project_status_code": "sample string 10",
"project_status": {
"id": "923381f6-72d8-4ec6-b96d-6aafbac9c18c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5bda509a-df89-46ca-88a9-a6ffebccac3d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3740649a-95a9-4f5f-b337-e39d495f4453",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ddde253a-e078-4c1c-8fc3-0c79fb38d053",
"db_currency_id": "d239bcfd-ade7-43d4-ab1a-7be598de9a0b",
"db_language_id": "962bb884-f202-4fb9-a925-f02f68fe452d",
"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-10-31T05:32:47.6628022+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-31T05:32:47.6740433+00:00"
},
"company_id": "33e0361f-9dcb-4388-837b-e9a2558fc474",
"company_code": "sample string 12",
"db_address_id": "60de1dad-fb83-4eef-a556-c2aafee88060",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "63d922c7-fb85-4392-abae-be773659445e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "737fa274-85c5-409f-8be8-0b9f8867c0ac",
"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-10-31T05:32:47.6927333+00:00",
"date_create": "2026-10-31T05:32:47.6927333+00:00",
"date_update": "2026-10-31T05:32:47.6927333+00:00",
"updated_by_user_id": "60c5187f-cfc4-4ac8-91ff-6371890c1a58",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-31T05:32:47.6927333+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-10-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-31T05:32:47.6927333+00:00",
"date_last_job": "2026-10-31T05:32:47.6927333+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-31T05:32:47.6927333+00:00",
"modified_dateutc": "2026-10-31T05:32:47.6927333+00:00",
"is_mobile_installation": true
}