Retrieves all the projects
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
projectName | 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": "9d1b8b6d-ed96-4714-8dcc-7fb22ebde9ee", "_parent_id": "72fac44e-9690-410a-a858-4f5f7bb6fb23", "root_parent_id": "3885d2d2-67da-4dcc-b04b-cd4369aa3a52", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "f137cf7f-84b0-425d-a31f-a19448768e44", "equipment_family_code": "sample string 6", "equipment_family": { "id": "2d392d03-2f1b-4585-8906-85861b8e13d1", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "0331a931-143b-443b-bf0b-5e7011668613", "_parent_code": "sample string 6", "sales_organization_id": "8ec7fbaa-cc28-4579-aa32-85d22102c9d2", "sales_organization_code": "sample string 8", "sales_organization": { "id": "200838d2-ca9a-4cad-b5a8-c8a45182e36b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b4e09219-4863-4bda-936e-9cc25fbeffa9", "db_currency_id": "ec4f3ce5-dc33-4b64-91c9-00ab60b3ced6", "db_language_id": "5ef152f4-aad7-458a-8cb7-1c24e6478e88", "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-07-17T10:19:13.4929767+00:00" }, "modified_dateutc": "2025-07-17T10:19:13.4929767+00:00" }, "equipment_model_id": "3e967189-eea2-46bf-8087-d34c71c79e93", "equipment_model_code": "sample string 8", "equipment_model": { "id": "25cf91b4-7d14-4a9a-a21b-5a7a657c7a0c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "ec089b7a-9c06-4c7c-920e-25fb9ee6f947", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "125b5764-70e6-48eb-8610-66759cf09973", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "60cdf6a2-e499-40b8-89e7-146216b13072", "sales_organization_code": "sample string 5", "sales_organization": { "id": "200838d2-ca9a-4cad-b5a8-c8a45182e36b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b4e09219-4863-4bda-936e-9cc25fbeffa9", "db_currency_id": "ec4f3ce5-dc33-4b64-91c9-00ab60b3ced6", "db_language_id": "5ef152f4-aad7-458a-8cb7-1c24e6478e88", "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-07-17T10:19:13.4929767+00:00" }, "modified_dateutc": "2025-07-17T10:19:13.4929767+00:00" }, "equipment_family_id": "273bb7c3-a25c-492a-ac25-573e9c834887", "equipment_family_code": "sample string 8", "equipment_family": { "id": "2d392d03-2f1b-4585-8906-85861b8e13d1", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "0331a931-143b-443b-bf0b-5e7011668613", "_parent_code": "sample string 6", "sales_organization_id": "8ec7fbaa-cc28-4579-aa32-85d22102c9d2", "sales_organization_code": "sample string 8", "sales_organization": { "id": "200838d2-ca9a-4cad-b5a8-c8a45182e36b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b4e09219-4863-4bda-936e-9cc25fbeffa9", "db_currency_id": "ec4f3ce5-dc33-4b64-91c9-00ab60b3ced6", "db_language_id": "5ef152f4-aad7-458a-8cb7-1c24e6478e88", "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-07-17T10:19:13.4929767+00:00" }, "modified_dateutc": "2025-07-17T10:19:13.4929767+00:00" }, "date_in_production_since": "2025-07-17T10:19:13.4929767+00:00", "date_out_of_production_since": "2025-07-17T10:19:13.4929767+00:00", "date_end_support": "2025-07-17T10:19:13.4929767+00:00", "sales_organization_id": "3bee8ce7-4647-4062-b854-471dab5c9f80", "sales_organization_code": "sample string 13", "sales_organization": { "id": "200838d2-ca9a-4cad-b5a8-c8a45182e36b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b4e09219-4863-4bda-936e-9cc25fbeffa9", "db_currency_id": "ec4f3ce5-dc33-4b64-91c9-00ab60b3ced6", "db_language_id": "5ef152f4-aad7-458a-8cb7-1c24e6478e88", "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-07-17T10:19:13.4929767+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-07-17T10:19:13.5086028+00:00" }, "project_status_id": "fd722829-7c9d-47cc-9718-7e857a9679b1", "project_status_code": "sample string 10", "project_status": { "id": "15b812fb-92ae-4ff4-8350-d03e97612c56", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "86e22ab6-b714-4ac0-b1bb-6f4e3f9578a9", "sales_organization_code": "sample string 6", "sales_organization": { "id": "200838d2-ca9a-4cad-b5a8-c8a45182e36b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b4e09219-4863-4bda-936e-9cc25fbeffa9", "db_currency_id": "ec4f3ce5-dc33-4b64-91c9-00ab60b3ced6", "db_language_id": "5ef152f4-aad7-458a-8cb7-1c24e6478e88", "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-07-17T10:19:13.4929767+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-17T10:19:13.5086028+00:00" }, "company_id": "3560fe85-4f55-4a96-8472-e0236a6f0cf1", "company_code": "sample string 12", "db_address_id": "a92fdeef-7206-4c41-9614-c808c11dc09d", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "05e55d60-d41d-4da8-bb29-c559aada61fe", "contact_reference_back_office": "sample string 17", "owner_user_id": "ebdf524e-46be-41c5-82eb-3bcff46453f2", "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-07-17T10:19:13.5086028+00:00", "date_create": "2025-07-17T10:19:13.5086028+00:00", "date_update": "2025-07-17T10:19:13.5086028+00:00", "updated_by_user_id": "e972bb55-514a-4bbe-b28f-9a2f7dbf2b46", "customer_reference": "sample string 28", "warranty_date_until": "2025-07-17T10:19:13.5086028+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-07-17T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-07-17T10:19:13.5086028+00:00", "date_last_job": "2025-07-17T10:19:13.5086028+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-07-17T10:19:13.5086028+00:00", "modified_dateutc": "2025-07-17T10:19:13.5086028+00:00", "is_mobile_installation": true }