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": "9d0eae3f-74f9-4bff-a82f-65863a3d6be9",
"_parent_id": "11d67814-ede0-4640-9780-969f7ee7a674",
"root_parent_id": "ab5f98ca-8e9d-4787-9014-0bd8201bc7f2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "069aef99-e099-4d98-8705-2f8ba855ca07",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "dba5cf42-27be-4ca9-87d7-889492fdafbb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "52be2fa9-e780-4e9d-9ecd-d306c7ae11b2",
"_parent_code": "sample string 6",
"sales_organization_id": "2971818c-9e98-4284-8afe-ae3ccbd71086",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "25d56581-aa24-47c4-8d40-c783e55283a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2854cf8a-ee82-4263-bd40-ef82eec37b05",
"db_currency_id": "dabcfe0a-4198-47d6-ab77-714fe9509b7c",
"db_language_id": "d83f34ad-d1dd-4930-a2c4-712fcaafd6b3",
"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-08T11:07:43.8989747+00:00"
},
"modified_dateutc": "2025-12-08T11:07:43.8989747+00:00"
},
"equipment_model_id": "b3695129-1b6e-40be-9327-1e4361a193c9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c06b8877-c72f-4747-b98c-b83cc538cb61",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fead9a55-5291-4638-8d6b-25da5c8667ce",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2fedcb54-6921-4992-8e8c-af1eccd4ce58",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0f5e9105-94c7-48ec-a1b7-c776b3b21bb2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "25d56581-aa24-47c4-8d40-c783e55283a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2854cf8a-ee82-4263-bd40-ef82eec37b05",
"db_currency_id": "dabcfe0a-4198-47d6-ab77-714fe9509b7c",
"db_language_id": "d83f34ad-d1dd-4930-a2c4-712fcaafd6b3",
"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-08T11:07:43.8989747+00:00"
},
"modified_dateutc": "2025-12-08T11:07:43.8989747+00:00"
},
"equipment_family_id": "3c912120-a730-4640-97cc-7c5e7fdafd64",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "dba5cf42-27be-4ca9-87d7-889492fdafbb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "52be2fa9-e780-4e9d-9ecd-d306c7ae11b2",
"_parent_code": "sample string 6",
"sales_organization_id": "2971818c-9e98-4284-8afe-ae3ccbd71086",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "25d56581-aa24-47c4-8d40-c783e55283a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2854cf8a-ee82-4263-bd40-ef82eec37b05",
"db_currency_id": "dabcfe0a-4198-47d6-ab77-714fe9509b7c",
"db_language_id": "d83f34ad-d1dd-4930-a2c4-712fcaafd6b3",
"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-08T11:07:43.8989747+00:00"
},
"modified_dateutc": "2025-12-08T11:07:43.8989747+00:00"
},
"date_in_production_since": "2025-12-08T11:07:43.8989747+00:00",
"date_out_of_production_since": "2025-12-08T11:07:43.8989747+00:00",
"date_end_support": "2025-12-08T11:07:43.8989747+00:00",
"sales_organization_id": "1ca5e80b-4c1c-4ab9-911b-6a4cd2b0536c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "25d56581-aa24-47c4-8d40-c783e55283a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2854cf8a-ee82-4263-bd40-ef82eec37b05",
"db_currency_id": "dabcfe0a-4198-47d6-ab77-714fe9509b7c",
"db_language_id": "d83f34ad-d1dd-4930-a2c4-712fcaafd6b3",
"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-08T11:07:43.8989747+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-08T11:07:43.8989747+00:00"
},
"project_status_id": "98175a7b-5194-4101-b01b-e6842acafb66",
"project_status_code": "sample string 10",
"project_status": {
"id": "e50c3d13-cd5b-430e-ace7-1276a4302b19",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7b83398f-5cd3-4bec-ba49-0d4ce7074497",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "25d56581-aa24-47c4-8d40-c783e55283a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2854cf8a-ee82-4263-bd40-ef82eec37b05",
"db_currency_id": "dabcfe0a-4198-47d6-ab77-714fe9509b7c",
"db_language_id": "d83f34ad-d1dd-4930-a2c4-712fcaafd6b3",
"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-08T11:07:43.8989747+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-08T11:07:43.8989747+00:00"
},
"company_id": "a971d399-2c39-4310-be81-32fb0552175b",
"company_code": "sample string 12",
"db_address_id": "b3003210-514b-4d38-b32e-a6e22a06651f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "860f6178-ec8a-49a1-a3ea-1b9e46def372",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "96682460-5ca0-4201-ba38-fc6b07ad40dd",
"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-08T11:07:43.8989747+00:00",
"date_create": "2025-12-08T11:07:43.8989747+00:00",
"date_update": "2025-12-08T11:07:43.8989747+00:00",
"updated_by_user_id": "abbcde94-edcc-446c-88c1-cab76b34cfcc",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-08T11:07:43.8989747+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-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-08T11:07:43.8989747+00:00",
"date_last_job": "2025-12-08T11:07:43.8989747+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-08T11:07:43.8989747+00:00",
"modified_dateutc": "2025-12-08T11:07:43.8989747+00:00",
"is_mobile_installation": true
}