Retrieves the project with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

project
NameDescriptionTypeAdditional 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

Sample:
{
  "id": "d2c36f50-9b0c-476e-944e-07b2b8789c67",
  "_parent_id": "e48675c4-e056-456c-9437-8287863c8168",
  "root_parent_id": "67aba774-dbbf-4b59-9083-971ee85d104b",
  "_parent_reference_back_office": "sample string 4",
  "equipment_family_id": "348c69f9-57a4-4b2c-9b57-cdc2d8e8cd77",
  "equipment_family_code": "sample string 6",
  "equipment_family": {
    "id": "d5e10301-96ad-48b5-b1ca-c2b47f92ef67",
    "name": "sample string 2",
    "description": "sample string 3",
    "code": "sample string 4",
    "_parent_id": "4b99172f-e74b-4449-853e-188530b84067",
    "_parent_code": "sample string 6",
    "sales_organization_id": "7e793c08-37d0-4c83-8c28-12fc7f2a8c91",
    "sales_organization_code": "sample string 8",
    "sales_organization": {
      "id": "82d05954-04ba-4f0c-affc-d955a6095e94",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "24f5d052-61b0-40c9-af63-bd20f26a3416",
      "db_currency_id": "132de1ff-83d3-4246-865e-c340c48a6895",
      "db_language_id": "031c3a8c-ed9f-4250-96d4-63423e5f5228",
      "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-14T17:00:10.2452291+00:00"
    },
    "modified_dateutc": "2025-07-14T17:00:10.2452291+00:00"
  },
  "equipment_model_id": "14201de0-acab-4a0e-93b5-2b559c191662",
  "equipment_model_code": "sample string 8",
  "equipment_model": {
    "id": "b1bb4fee-7774-4c57-9c34-9b98aa95e86b",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "equipment_brand_id": "95a072bd-c630-4b02-93b8-21038605d523",
    "equipment_brand_code": "sample string 6",
    "equipment_brand": {
      "id": "b9c217dd-94eb-4002-8fae-b730fac33d18",
      "name": "sample string 2",
      "code": "sample string 3",
      "sales_organization_id": "ac1ad09e-a527-4441-be55-f1786aec2018",
      "sales_organization_code": "sample string 5",
      "sales_organization": {
        "id": "82d05954-04ba-4f0c-affc-d955a6095e94",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "24f5d052-61b0-40c9-af63-bd20f26a3416",
        "db_currency_id": "132de1ff-83d3-4246-865e-c340c48a6895",
        "db_language_id": "031c3a8c-ed9f-4250-96d4-63423e5f5228",
        "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-14T17:00:10.2452291+00:00"
      },
      "modified_dateutc": "2025-07-14T17:00:10.2452291+00:00"
    },
    "equipment_family_id": "b1644568-92b0-40a6-a3a6-ce44072b80b3",
    "equipment_family_code": "sample string 8",
    "equipment_family": {
      "id": "d5e10301-96ad-48b5-b1ca-c2b47f92ef67",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "_parent_id": "4b99172f-e74b-4449-853e-188530b84067",
      "_parent_code": "sample string 6",
      "sales_organization_id": "7e793c08-37d0-4c83-8c28-12fc7f2a8c91",
      "sales_organization_code": "sample string 8",
      "sales_organization": {
        "id": "82d05954-04ba-4f0c-affc-d955a6095e94",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "24f5d052-61b0-40c9-af63-bd20f26a3416",
        "db_currency_id": "132de1ff-83d3-4246-865e-c340c48a6895",
        "db_language_id": "031c3a8c-ed9f-4250-96d4-63423e5f5228",
        "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-14T17:00:10.2452291+00:00"
      },
      "modified_dateutc": "2025-07-14T17:00:10.2452291+00:00"
    },
    "date_in_production_since": "2025-07-14T17:00:10.2452291+00:00",
    "date_out_of_production_since": "2025-07-14T17:00:10.2452291+00:00",
    "date_end_support": "2025-07-14T17:00:10.2452291+00:00",
    "sales_organization_id": "c198d07b-1e97-4601-aaf1-5a780d0389e0",
    "sales_organization_code": "sample string 13",
    "sales_organization": {
      "id": "82d05954-04ba-4f0c-affc-d955a6095e94",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "24f5d052-61b0-40c9-af63-bd20f26a3416",
      "db_currency_id": "132de1ff-83d3-4246-865e-c340c48a6895",
      "db_language_id": "031c3a8c-ed9f-4250-96d4-63423e5f5228",
      "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-14T17:00:10.2452291+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-14T17:00:10.2452291+00:00"
  },
  "project_status_id": "3a0a9f34-440e-413c-b061-618618687547",
  "project_status_code": "sample string 10",
  "project_status": {
    "id": "0807c6e5-1460-468c-8753-a450c06c3e7c",
    "name": "sample string 2",
    "is_default": true,
    "is_closed": true,
    "sales_organization_id": "d589dbe9-c4a3-4da2-85d4-8642c7a4a89b",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "82d05954-04ba-4f0c-affc-d955a6095e94",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "24f5d052-61b0-40c9-af63-bd20f26a3416",
      "db_currency_id": "132de1ff-83d3-4246-865e-c340c48a6895",
      "db_language_id": "031c3a8c-ed9f-4250-96d4-63423e5f5228",
      "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-14T17:00:10.2452291+00:00"
    },
    "code": "sample string 7",
    "modified_dateutc": "2025-07-14T17:00:10.2452291+00:00"
  },
  "company_id": "f92c712b-9333-4cf1-9b18-77da7807b56d",
  "company_code": "sample string 12",
  "db_address_id": "aa394088-37ef-46a8-a987-abd9089d439c",
  "db_address_code": "sample string 14",
  "location": "sample string 15",
  "contact_id": "842455a8-aff4-4ae5-b54b-0392032fd92f",
  "contact_reference_back_office": "sample string 17",
  "owner_user_id": "9081981d-aa5c-4314-8bc3-433871177623",
  "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-14T17:00:10.2452291+00:00",
  "date_create": "2025-07-14T17:00:10.2452291+00:00",
  "date_update": "2025-07-14T17:00:10.2452291+00:00",
  "updated_by_user_id": "51cf20be-ab64-4bde-aeaf-a38b4698e747",
  "customer_reference": "sample string 28",
  "warranty_date_until": "2025-07-14T17:00:10.2452291+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-14T00:00:00+00:00",
  "shutdown_consequence": "sample string 35",
  "id2": 36,
  "nb_open_jobs": 37,
  "date_next_job": "2025-07-14T17:00:10.2452291+00:00",
  "date_last_job": "2025-07-14T17:00:10.2452291+00:00",
  "nb_jobs_planned": 40,
  "nb_jobs_tobeplanned": 41,
  "nb_jobs_waitingfurtheraction": 42,
  "back_office_timestamp": "2025-07-14T17:00:10.2452291+00:00",
  "modified_dateutc": "2025-07-14T17:00:10.2452291+00:00",
  "is_mobile_installation": true
}