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": "e28d082f-1e8e-44cb-892e-aa1ccd7d5e9c",
  "_parent_id": "d6d5ed27-74bc-40de-bf67-05f5b82c093c",
  "root_parent_id": "6ddd3ea1-6153-4abd-a8ef-69a853996ce6",
  "_parent_reference_back_office": "sample string 4",
  "equipment_family_id": "cb639395-398d-4b1f-9d0f-9396603bd007",
  "equipment_family_code": "sample string 6",
  "equipment_family": {
    "id": "1b2d4708-13ab-470d-ad98-bc25d26ee4a3",
    "name": "sample string 2",
    "description": "sample string 3",
    "code": "sample string 4",
    "_parent_id": "d7f4e83a-19b2-44d8-9661-e56a26902051",
    "_parent_code": "sample string 6",
    "sales_organization_id": "d263dd0d-4ed1-48dd-a008-b47988cc2f29",
    "sales_organization_code": "sample string 8",
    "sales_organization": {
      "id": "f25ce793-0845-49af-9524-f4bd0fd6ce79",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "23eb0935-4c7a-4979-8e8f-140ace145da2",
      "db_currency_id": "3dd30f5e-96a9-4e8b-bcfd-15f2cfc09661",
      "db_language_id": "3430af76-8c9a-4299-85ba-24f302022468",
      "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-04-02T11:17:49.7075439+00:00"
    },
    "modified_dateutc": "2025-04-02T11:17:49.7075439+00:00"
  },
  "equipment_model_id": "14a99de5-2f3d-4706-8296-d9c127d2f830",
  "equipment_model_code": "sample string 8",
  "equipment_model": {
    "id": "ae078543-9cd1-482c-9175-6d0f6b4cf207",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "equipment_brand_id": "2362a471-a8cf-4740-a538-bcbe4765378b",
    "equipment_brand_code": "sample string 6",
    "equipment_brand": {
      "id": "f7728252-d1a1-4879-9b3a-d3030005859f",
      "name": "sample string 2",
      "code": "sample string 3",
      "sales_organization_id": "92d2f810-ef9b-4fc7-a63f-1900b421715f",
      "sales_organization_code": "sample string 5",
      "sales_organization": {
        "id": "f25ce793-0845-49af-9524-f4bd0fd6ce79",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "23eb0935-4c7a-4979-8e8f-140ace145da2",
        "db_currency_id": "3dd30f5e-96a9-4e8b-bcfd-15f2cfc09661",
        "db_language_id": "3430af76-8c9a-4299-85ba-24f302022468",
        "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-04-02T11:17:49.7075439+00:00"
      },
      "modified_dateutc": "2025-04-02T11:17:49.7075439+00:00"
    },
    "equipment_family_id": "528b0c3a-32dc-4945-b7a8-5fc1ce18729d",
    "equipment_family_code": "sample string 8",
    "equipment_family": {
      "id": "1b2d4708-13ab-470d-ad98-bc25d26ee4a3",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "_parent_id": "d7f4e83a-19b2-44d8-9661-e56a26902051",
      "_parent_code": "sample string 6",
      "sales_organization_id": "d263dd0d-4ed1-48dd-a008-b47988cc2f29",
      "sales_organization_code": "sample string 8",
      "sales_organization": {
        "id": "f25ce793-0845-49af-9524-f4bd0fd6ce79",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "23eb0935-4c7a-4979-8e8f-140ace145da2",
        "db_currency_id": "3dd30f5e-96a9-4e8b-bcfd-15f2cfc09661",
        "db_language_id": "3430af76-8c9a-4299-85ba-24f302022468",
        "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-04-02T11:17:49.7075439+00:00"
      },
      "modified_dateutc": "2025-04-02T11:17:49.7075439+00:00"
    },
    "date_in_production_since": "2025-04-02T11:17:49.7075439+00:00",
    "date_out_of_production_since": "2025-04-02T11:17:49.7075439+00:00",
    "date_end_support": "2025-04-02T11:17:49.7075439+00:00",
    "sales_organization_id": "fcf84c91-cc99-42a7-95c1-9e8a8c4eb425",
    "sales_organization_code": "sample string 13",
    "sales_organization": {
      "id": "f25ce793-0845-49af-9524-f4bd0fd6ce79",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "23eb0935-4c7a-4979-8e8f-140ace145da2",
      "db_currency_id": "3dd30f5e-96a9-4e8b-bcfd-15f2cfc09661",
      "db_language_id": "3430af76-8c9a-4299-85ba-24f302022468",
      "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-04-02T11:17:49.7075439+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-04-02T11:17:49.9106683+00:00"
  },
  "project_status_id": "03d64004-783b-40ec-97f0-9248936621f9",
  "project_status_code": "sample string 10",
  "project_status": {
    "id": "3666aae6-f76a-4def-9d1b-7b31b086e426",
    "name": "sample string 2",
    "is_default": true,
    "is_closed": true,
    "sales_organization_id": "96c20018-e398-4d4a-9bcb-c93ac6bafc94",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "f25ce793-0845-49af-9524-f4bd0fd6ce79",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "23eb0935-4c7a-4979-8e8f-140ace145da2",
      "db_currency_id": "3dd30f5e-96a9-4e8b-bcfd-15f2cfc09661",
      "db_language_id": "3430af76-8c9a-4299-85ba-24f302022468",
      "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-04-02T11:17:49.7075439+00:00"
    },
    "code": "sample string 7",
    "modified_dateutc": "2025-04-02T11:17:49.9106683+00:00"
  },
  "company_id": "ca7c8f36-cf39-44dd-826d-f548b9590e28",
  "company_code": "sample string 12",
  "db_address_id": "c66d5f04-3299-40bd-83de-b07eddb8b06f",
  "db_address_code": "sample string 14",
  "location": "sample string 15",
  "contact_id": "3ae6546a-f55b-4b25-89f1-db5fd970d017",
  "contact_reference_back_office": "sample string 17",
  "owner_user_id": "4cd09d98-1e3d-42d5-a368-2ccd5dc8decd",
  "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-04-02T11:17:49.9106683+00:00",
  "date_create": "2025-04-02T11:17:49.9106683+00:00",
  "date_update": "2025-04-02T11:17:49.9106683+00:00",
  "updated_by_user_id": "895a470d-29db-42f0-acba-2fa6d2751bc7",
  "customer_reference": "sample string 28",
  "warranty_date_until": "2025-04-02T11:17:49.9106683+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-04-02T00:00:00+00:00",
  "shutdown_consequence": "sample string 35",
  "id2": 36,
  "nb_open_jobs": 37,
  "date_next_job": "2025-04-02T11:17:49.9106683+00:00",
  "date_last_job": "2025-04-02T11:17:49.9106683+00:00",
  "nb_jobs_planned": 40,
  "nb_jobs_tobeplanned": 41,
  "nb_jobs_waitingfurtheraction": 42,
  "back_office_timestamp": "2025-04-02T11:17:49.9106683+00:00",
  "modified_dateutc": "2025-04-02T11:17:49.9106683+00:00",
  "is_mobile_installation": true
}