Request Information

URI Parameters :

NameDescriptionTypeAdditional information
keyword

string

Required

Body Parameters :

None.

Response Information

Resource Description :

ProjectView
NameDescriptionTypeAdditional information
id

Primary key

globally unique identifier
id2

Internal ID (numeric). Will be used if reference_back_office is empty

integer
reference_back_office

The Id/Ref of the back office for this job

string

Max length: 50

customer_reference

Reference of this project for the customer

string

Max length: 50

_parent_id

Reference to a parent project (Project hierachy Parent/Child)

globally unique identifier
root_parent_id

globally unique identifier
is_mobile_installation

boolean
project_status_id

Foreign key of project status for this project

globally unique identifier
project_status_name

Status of the project (project.project_status_id=>project_status.name)

string

Max length: 50

project_status_is_closed

Status of the project (project.project_status_id=>project_status.is_closed)

boolean
name

Name of the project

string

Max length: 50

description

Description of the project

string

Max length: 50

equipment_family_id

Foreign key of equipment family for this project

globally unique identifier
equipment_family_name

Equipment Family (translated) of the project (project.equipment_family_id=>equipment_family.name)

string

Max length: 50

equipment_model_id

Foreign key of equipment model for this project

globally unique identifier
equipment_model_name

Equipment Model (translated) of the project (project.equipment_model_id=>equipment_model.name)

string

Max length: 50

equipment_brand_id

Foreign key of equipment brand for this project

globally unique identifier
equipment_brand_name

Equipment Brand (translated) of the project (equipment_model.equipment_brand_id=>equipment_brand.name)

string

Max length: 50

company_id

Foreign key of company (owner of the project)

globally unique identifier
company_code

Company code that owns the project (project.company_id=>company.code)

string

Max length: 50

company_name

Company name that owns the project (project.company_id=>company.name)

string

Max length: 50

company_sales_organization_id

Sales Organization ID of the company that own the project (project.company_id=>company.sales_organization_id)

globally unique identifier
db_address_street

Address Street of the project

string

Max length: 50

db_address_street2

string

Max length: 50

db_address_street_number

Address Street Number of the project

string

Max length: 50

db_address_zip

Address Zip code of the project

string

Max length: 50

db_address_city

Address City of the project

string

Max length: 50

db_address_country_code

Address Country code of the project

string

Max length: 50

db_address_country_name

Address Country name of the project

string

Max length: 50

db_address_phone

Address Phone number of the project

string

Max length: 50

nb_jobs_planned

Number of jobs with status Planned

integer
nb_jobs_tobeplanned

Number of jobs with status ToBePlan

integer
nb_jobs_waitingfurtheraction

Number of jobs with status WaitingFurtherAction

integer
company_db_address_id

The main address id of the company

globally unique identifier
has_child

Inform if this project has child (is a parent)

boolean
db_address_id

DbAddressId of the project (if empty, will use the main address of the company)

globally unique identifier
location

Additional text to describe the location

string

Max length: 50

contact_id

Main contact of the project

globally unique identifier
serial_number

Serial Number

string

Max length: 50

barcode

Barcode

string

Max length: 50

date_start_production

Date project/installation becomes active

date
date_create

Date create

date
date_update

Date update

date
nb_open_jobs

Number of jobs Open (In progress)

integer
date_next_job

Date+Time of the next job planned

date
date_last_job

Date+Time of the last job completed

date
warranty_date_until

End date of the warranty (if applicable)

date
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: 50

replacement_date

date
contract_id

globally unique identifier

Response Formats

application/json, text/json

Sample:
{
  "id": "b0a44f6c-13f3-405e-a736-d2728da805d4",
  "id2": 2,
  "reference_back_office": "sample string 3",
  "customer_reference": "sample string 4",
  "_parent_id": "412530f8-acac-4c6f-a05c-48e988fb1550",
  "root_parent_id": "de611ec7-0523-429e-83bd-f2fa6b45d4ea",
  "is_mobile_installation": true,
  "project_status_id": "5603f88d-4498-4e64-9bad-201a27e723b5",
  "project_status_name": "sample string 9",
  "project_status_is_closed": true,
  "name": "sample string 11",
  "description": "sample string 12",
  "equipment_family_id": "50bb88f7-8352-4895-9a0d-8a0d79a21d06",
  "equipment_family_name": "sample string 14",
  "equipment_model_id": "c202d3f9-5d4e-468c-ac85-5178b62cd634",
  "equipment_model_name": "sample string 16",
  "equipment_brand_id": "ddbe3336-0e91-4552-834a-fea118cb0ab0",
  "equipment_brand_name": "sample string 18",
  "company_id": "645a904d-aa3c-4d83-8fde-a68adbdd7714",
  "company_code": "sample string 20",
  "company_name": "sample string 21",
  "company_sales_organization_id": "121ef4a2-8cdc-46b5-b961-ceb8f4727c7a",
  "db_address_street": "sample string 23",
  "db_address_street2": "sample string 24",
  "db_address_street_number": "sample string 25",
  "db_address_zip": "sample string 26",
  "db_address_city": "sample string 27",
  "db_address_country_code": "sample string 28",
  "db_address_country_name": "sample string 29",
  "db_address_phone": "sample string 30",
  "nb_jobs_planned": 31,
  "nb_jobs_tobeplanned": 32,
  "nb_jobs_waitingfurtheraction": 33,
  "company_db_address_id": "c149354f-061a-42f2-9096-203319eadd3e",
  "has_child": true,
  "db_address_id": "91928c6f-0d7f-4f61-9cec-ff03a07f8fe8",
  "location": "sample string 37",
  "contact_id": "1018e682-a62b-457a-85c1-a2afa6840303",
  "serial_number": "sample string 39",
  "barcode": "sample string 40",
  "date_start_production": "2026-06-24T04:03:12.7048688+00:00",
  "date_create": "2026-06-24T04:03:12.7048688+00:00",
  "date_update": "2026-06-24T04:03:12.7048688+00:00",
  "nb_open_jobs": 44,
  "date_next_job": "2026-06-24T04:03:12.7048688+00:00",
  "date_last_job": "2026-06-24T04:03:12.7048688+00:00",
  "warranty_date_until": "2026-06-24T04:03:12.7048688+00:00",
  "date_built": "2026-06-24T04:03:12.7048688+00:00",
  "shutdown_consequence": "sample string 49",
  "replacement_date": "2026-06-24T04:03:12.7048688+00:00",
  "contract_id": "e157caf3-44fc-4717-a434-9e3ca7594ae1"
}

application/xml, text/xml

Sample:
<ProjectView xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <_parent_id>412530f8-acac-4c6f-a05c-48e988fb1550</_parent_id>
  <barcode>sample string 40</barcode>
  <company_code>sample string 20</company_code>
  <company_db_address_id>c149354f-061a-42f2-9096-203319eadd3e</company_db_address_id>
  <company_id>645a904d-aa3c-4d83-8fde-a68adbdd7714</company_id>
  <company_name>sample string 21</company_name>
  <company_sales_organization_id>121ef4a2-8cdc-46b5-b961-ceb8f4727c7a</company_sales_organization_id>
  <contact_id>1018e682-a62b-457a-85c1-a2afa6840303</contact_id>
  <contract_id>e157caf3-44fc-4717-a434-9e3ca7594ae1</contract_id>
  <customer_reference>sample string 4</customer_reference>
  <date_built>2026-06-24T04:03:12.704Z</date_built>
  <date_create>2026-06-24T04:03:12.704Z</date_create>
  <date_last_job>2026-06-24T04:03:12.704Z</date_last_job>
  <date_next_job>2026-06-24T04:03:12.704Z</date_next_job>
  <date_start_production>2026-06-24T04:03:12.704Z</date_start_production>
  <date_update>2026-06-24T04:03:12.704Z</date_update>
  <db_address_city>sample string 27</db_address_city>
  <db_address_country_code>sample string 28</db_address_country_code>
  <db_address_country_name>sample string 29</db_address_country_name>
  <db_address_id>91928c6f-0d7f-4f61-9cec-ff03a07f8fe8</db_address_id>
  <db_address_phone>sample string 30</db_address_phone>
  <db_address_street>sample string 23</db_address_street>
  <db_address_street2>sample string 24</db_address_street2>
  <db_address_street_number>sample string 25</db_address_street_number>
  <db_address_zip>sample string 26</db_address_zip>
  <description>sample string 12</description>
  <equipment_brand_id>ddbe3336-0e91-4552-834a-fea118cb0ab0</equipment_brand_id>
  <equipment_brand_name>sample string 18</equipment_brand_name>
  <equipment_family_id>50bb88f7-8352-4895-9a0d-8a0d79a21d06</equipment_family_id>
  <equipment_family_name>sample string 14</equipment_family_name>
  <equipment_model_id>c202d3f9-5d4e-468c-ac85-5178b62cd634</equipment_model_id>
  <equipment_model_name>sample string 16</equipment_model_name>
  <has_child>true</has_child>
  <id>b0a44f6c-13f3-405e-a736-d2728da805d4</id>
  <id2>2</id2>
  <is_mobile_installation>true</is_mobile_installation>
  <location>sample string 37</location>
  <name>sample string 11</name>
  <nb_jobs_planned>31</nb_jobs_planned>
  <nb_jobs_tobeplanned>32</nb_jobs_tobeplanned>
  <nb_jobs_waitingfurtheraction>33</nb_jobs_waitingfurtheraction>
  <nb_open_jobs>44</nb_open_jobs>
  <project_status_id>5603f88d-4498-4e64-9bad-201a27e723b5</project_status_id>
  <project_status_is_closed>true</project_status_is_closed>
  <project_status_name>sample string 9</project_status_name>
  <reference_back_office>sample string 3</reference_back_office>
  <replacement_date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-06-24T04:03:12.7048688Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </replacement_date>
  <root_parent_id>de611ec7-0523-429e-83bd-f2fa6b45d4ea</root_parent_id>
  <serial_number>sample string 39</serial_number>
  <shutdown_consequence>sample string 49</shutdown_consequence>
  <warranty_date_until>2026-06-24T04:03:12.704Z</warranty_date_until>
</ProjectView>