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": "b9f2e150-b592-430c-8b14-bc201ce1421b",
  "_parent_id": "e8418df7-d2d7-4ddd-adcb-543befb77670",
  "root_parent_id": "a2623c7d-49fa-4e19-9460-7ef95396e335",
  "_parent_reference_back_office": "sample string 4",
  "equipment_family_id": "7cb3c6de-6c46-4c2c-895d-5db1870174c1",
  "equipment_family_code": "sample string 6",
  "equipment_family": {
    "id": "1d72659c-1caf-4450-8e30-4ea68e0c38c9",
    "name": "sample string 2",
    "description": "sample string 3",
    "code": "sample string 4",
    "_parent_id": "aa4af7d0-b911-406e-a9a9-d806054f9560",
    "_parent_code": "sample string 6",
    "sales_organization_id": "2b94f394-d9b2-4f79-aebb-dd6325080330",
    "sales_organization_code": "sample string 8",
    "sales_organization": {
      "id": "c4152efe-49b6-44ca-bc0a-56824ad1593e",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "6b45b8f4-6851-4df6-a173-528dcb507d33",
      "db_currency_id": "81727005-9112-4c34-ac4c-c78efaaf14ea",
      "db_language_id": "b99dae74-0e6a-4862-8e2b-d6cd5b518960",
      "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": "2022-12-02T21:44:20.2476686+01:00"
    },
    "modified_dateutc": "2022-12-02T21:44:20.2476686+01:00"
  },
  "equipment_model_id": "e6fbff09-38c5-4a67-b278-ffe0528a5875",
  "equipment_model_code": "sample string 8",
  "equipment_model": {
    "id": "93d6d861-8370-4610-aeea-fb3cf1a3c8bf",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "equipment_brand_id": "7c42a0f2-ff71-4a3e-84c9-12493af50858",
    "equipment_brand_code": "sample string 6",
    "equipment_brand": {
      "id": "2dbff60c-ad29-44a4-971b-ca0a6cdb7beb",
      "name": "sample string 2",
      "code": "sample string 3",
      "sales_organization_id": "cf696ddc-1299-43a0-b229-bec3621d9f67",
      "sales_organization_code": "sample string 5",
      "sales_organization": {
        "id": "c4152efe-49b6-44ca-bc0a-56824ad1593e",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "6b45b8f4-6851-4df6-a173-528dcb507d33",
        "db_currency_id": "81727005-9112-4c34-ac4c-c78efaaf14ea",
        "db_language_id": "b99dae74-0e6a-4862-8e2b-d6cd5b518960",
        "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": "2022-12-02T21:44:20.2476686+01:00"
      },
      "modified_dateutc": "2022-12-02T21:44:20.2476686+01:00"
    },
    "equipment_family_id": "a872068a-9183-405c-af5a-f8f9a71b1490",
    "equipment_family_code": "sample string 8",
    "equipment_family": {
      "id": "1d72659c-1caf-4450-8e30-4ea68e0c38c9",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "_parent_id": "aa4af7d0-b911-406e-a9a9-d806054f9560",
      "_parent_code": "sample string 6",
      "sales_organization_id": "2b94f394-d9b2-4f79-aebb-dd6325080330",
      "sales_organization_code": "sample string 8",
      "sales_organization": {
        "id": "c4152efe-49b6-44ca-bc0a-56824ad1593e",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "6b45b8f4-6851-4df6-a173-528dcb507d33",
        "db_currency_id": "81727005-9112-4c34-ac4c-c78efaaf14ea",
        "db_language_id": "b99dae74-0e6a-4862-8e2b-d6cd5b518960",
        "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": "2022-12-02T21:44:20.2476686+01:00"
      },
      "modified_dateutc": "2022-12-02T21:44:20.2476686+01:00"
    },
    "date_in_production_since": "2022-12-02T21:44:20.2476686+01:00",
    "date_out_of_production_since": "2022-12-02T21:44:20.2476686+01:00",
    "date_end_support": "2022-12-02T21:44:20.2476686+01:00",
    "sales_organization_id": "8b670dbe-8d88-482c-b788-9308c2ea0594",
    "sales_organization_code": "sample string 13",
    "sales_organization": {
      "id": "c4152efe-49b6-44ca-bc0a-56824ad1593e",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "6b45b8f4-6851-4df6-a173-528dcb507d33",
      "db_currency_id": "81727005-9112-4c34-ac4c-c78efaaf14ea",
      "db_language_id": "b99dae74-0e6a-4862-8e2b-d6cd5b518960",
      "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": "2022-12-02T21:44:20.2476686+01: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": "2022-12-02T21:44:20.2476686+01:00"
  },
  "project_status_id": "5c446fde-9dab-4093-98fc-3462a8dcee92",
  "project_status_code": "sample string 10",
  "project_status": {
    "id": "647b455c-a2ba-4daa-b591-ecbc576529c4",
    "name": "sample string 2",
    "is_default": true,
    "is_closed": true,
    "sales_organization_id": "9a74ebfc-a729-4be3-b65c-2b6b5b87b656",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "c4152efe-49b6-44ca-bc0a-56824ad1593e",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "6b45b8f4-6851-4df6-a173-528dcb507d33",
      "db_currency_id": "81727005-9112-4c34-ac4c-c78efaaf14ea",
      "db_language_id": "b99dae74-0e6a-4862-8e2b-d6cd5b518960",
      "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": "2022-12-02T21:44:20.2476686+01:00"
    },
    "code": "sample string 7",
    "modified_dateutc": "2022-12-02T21:44:20.2476686+01:00"
  },
  "company_id": "e8e79a22-88ee-4f88-9d38-0121016fd8a1",
  "company_code": "sample string 12",
  "db_address_id": "f154b6ac-4dd7-4b05-9f1b-2e63e127f831",
  "db_address_code": "sample string 14",
  "location": "sample string 15",
  "contact_id": "24c72fd4-7630-43d5-a82d-6ed9441aab30",
  "contact_reference_back_office": "sample string 17",
  "owner_user_id": "9ae6e4ac-ca8e-40aa-9671-3a93b064b3d0",
  "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": "2022-12-02T21:44:20.2476686+01:00",
  "date_create": "2022-12-02T21:44:20.2476686+01:00",
  "date_update": "2022-12-02T21:44:20.2476686+01:00",
  "updated_by_user_id": "41999c21-06e4-4f5b-aaf2-2307ac7e34b3",
  "customer_reference": "sample string 28",
  "warranty_date_until": "2022-12-02T21:44:20.2644737+01: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": "2022-12-02T00:00:00+01:00",
  "shutdown_consequence": "sample string 35",
  "id2": 36,
  "nb_open_jobs": 37,
  "date_next_job": "2022-12-02T21:44:20.2644737+01:00",
  "date_last_job": "2022-12-02T21:44:20.2644737+01:00",
  "nb_jobs_planned": 40,
  "nb_jobs_tobeplanned": 41,
  "nb_jobs_waitingfurtheraction": 42,
  "back_office_timestamp": "2022-12-02T21:44:20.2644737+01:00",
  "modified_dateutc": "2022-12-02T21:44:20.2644737+01:00",
  "is_mobile_installation": true
}