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": "928c51e6-72c0-4abb-be0e-a2ed46a9fabf",
"_parent_id": "8234d05d-60d1-445c-8d81-975f35cf92d2",
"root_parent_id": "377a4eff-806e-442d-bc0c-0ef6c58b3f08",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c1dacd5f-b6b9-45d8-a51f-d6c62b623433",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bed91f69-305c-4af9-99ba-137e50f31bb7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "94fb3133-c5c5-43d8-9a3c-55c630593147",
"_parent_code": "sample string 6",
"sales_organization_id": "17738cc3-e762-464a-a2fe-f2082d2f2b14",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "33287516-a756-425e-bd9a-2bc6463b7c6e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cbf4a4fe-d002-436a-915b-04cc6767195a",
"db_currency_id": "a79b6cd7-5a68-43e8-a5be-e8b30f536e8c",
"db_language_id": "f73f0935-ee08-4cf8-a3b9-a5f735b9d80b",
"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": "2024-04-16T14:51:54.6835893+00:00"
},
"modified_dateutc": "2024-04-16T14:51:54.6835893+00:00"
},
"equipment_model_id": "7d8521b1-b53a-4b3a-bf86-1ef176417b7d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e1b9839d-0372-426e-8201-8a92057d8827",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "356251d8-2bf4-416a-93af-a952373ee76d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "83a0caa3-b407-499c-b250-19a34c008eea",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f915b4d7-4bbe-472e-b925-81dd4133bef6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "33287516-a756-425e-bd9a-2bc6463b7c6e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cbf4a4fe-d002-436a-915b-04cc6767195a",
"db_currency_id": "a79b6cd7-5a68-43e8-a5be-e8b30f536e8c",
"db_language_id": "f73f0935-ee08-4cf8-a3b9-a5f735b9d80b",
"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": "2024-04-16T14:51:54.6835893+00:00"
},
"modified_dateutc": "2024-04-16T14:51:54.6835893+00:00"
},
"equipment_family_id": "c87a71fb-f916-4e38-9b85-70b1442a644a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bed91f69-305c-4af9-99ba-137e50f31bb7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "94fb3133-c5c5-43d8-9a3c-55c630593147",
"_parent_code": "sample string 6",
"sales_organization_id": "17738cc3-e762-464a-a2fe-f2082d2f2b14",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "33287516-a756-425e-bd9a-2bc6463b7c6e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cbf4a4fe-d002-436a-915b-04cc6767195a",
"db_currency_id": "a79b6cd7-5a68-43e8-a5be-e8b30f536e8c",
"db_language_id": "f73f0935-ee08-4cf8-a3b9-a5f735b9d80b",
"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": "2024-04-16T14:51:54.6835893+00:00"
},
"modified_dateutc": "2024-04-16T14:51:54.6835893+00:00"
},
"date_in_production_since": "2024-04-16T14:51:54.6835893+00:00",
"date_out_of_production_since": "2024-04-16T14:51:54.6835893+00:00",
"date_end_support": "2024-04-16T14:51:54.6835893+00:00",
"sales_organization_id": "65f74428-d02d-4728-a677-6581ffdd8255",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "33287516-a756-425e-bd9a-2bc6463b7c6e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cbf4a4fe-d002-436a-915b-04cc6767195a",
"db_currency_id": "a79b6cd7-5a68-43e8-a5be-e8b30f536e8c",
"db_language_id": "f73f0935-ee08-4cf8-a3b9-a5f735b9d80b",
"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": "2024-04-16T14:51:54.6835893+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": "2024-04-16T14:51:54.6835893+00:00"
},
"project_status_id": "cb9f1e36-b1f2-474d-9ea6-aeefe7bd0496",
"project_status_code": "sample string 10",
"project_status": {
"id": "25456e7c-4257-46f6-b458-6ce7a12df59e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b8750296-b04e-4549-80a1-8bb82c9eb8d2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "33287516-a756-425e-bd9a-2bc6463b7c6e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cbf4a4fe-d002-436a-915b-04cc6767195a",
"db_currency_id": "a79b6cd7-5a68-43e8-a5be-e8b30f536e8c",
"db_language_id": "f73f0935-ee08-4cf8-a3b9-a5f735b9d80b",
"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": "2024-04-16T14:51:54.6835893+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-04-16T14:51:54.6835893+00:00"
},
"company_id": "8f9bc951-270f-4c96-9d34-6b6c43328c9f",
"company_code": "sample string 12",
"db_address_id": "d2a3416d-e0d9-42fc-a99d-f325800091fa",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2fa39852-a2f7-4c59-b604-15cbed911167",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f661a090-2a79-4320-914b-f93074f0db5f",
"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": "2024-04-16T14:51:54.6835893+00:00",
"date_create": "2024-04-16T14:51:54.6835893+00:00",
"date_update": "2024-04-16T14:51:54.6835893+00:00",
"updated_by_user_id": "4a898c65-5ff1-45af-99c4-2cfe2a10b0c0",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-04-16T14:51:54.6835893+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": "2024-04-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-04-16T14:51:54.6835893+00:00",
"date_last_job": "2024-04-16T14:51:54.6835893+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-04-16T14:51:54.6835893+00:00",
"modified_dateutc": "2024-04-16T14:51:54.6835893+00:00",
"is_mobile_installation": true
}