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": "ed681ae9-d832-48c2-9a9c-db04e122b751",
  "_parent_id": "d1951228-35ec-479e-98c1-244fa750634a",
  "root_parent_id": "58c2b841-6464-4980-8fd6-4b4f41365d4a",
  "_parent_reference_back_office": "sample string 4",
  "equipment_family_id": "c605eae0-b393-4f81-8567-cc3cc2a943b0",
  "equipment_family_code": "sample string 6",
  "equipment_family": {
    "id": "053a627c-3dc3-4cf7-b153-ea423dd37581",
    "name": "sample string 2",
    "description": "sample string 3",
    "code": "sample string 4",
    "_parent_id": "62c146a6-81ae-45c4-b15f-4cb68d2fc447",
    "_parent_code": "sample string 6",
    "sales_organization_id": "9d4b4123-7a73-4812-b4b7-a0546a111f69",
    "sales_organization_code": "sample string 8",
    "sales_organization": {
      "id": "003aaa06-9ffa-4e06-858e-cd6773219f8a",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "440515f4-6f6f-4b24-a125-8e4d3a6a7cb4",
      "db_currency_id": "bdccf7b5-5e32-4707-bac1-7531543c0192",
      "db_language_id": "efb66c7a-0a9b-4a05-bfaa-c6940a7b82d2",
      "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-02-25T11:09:34.0193029+00:00"
    },
    "modified_dateutc": "2024-02-25T11:09:34.0193029+00:00"
  },
  "equipment_model_id": "8c2ab2a6-9bf4-4418-aae6-1a4ba9e5e5c0",
  "equipment_model_code": "sample string 8",
  "equipment_model": {
    "id": "7f3d590e-53ef-41f4-9869-bb05af226ea0",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "equipment_brand_id": "7cda4db2-d927-418f-89d4-9855fb307609",
    "equipment_brand_code": "sample string 6",
    "equipment_brand": {
      "id": "a8cfd588-b2ee-4bf4-b2f6-5a34ca2de787",
      "name": "sample string 2",
      "code": "sample string 3",
      "sales_organization_id": "affb95da-cfa2-4238-8d23-ba979fc3a5a6",
      "sales_organization_code": "sample string 5",
      "sales_organization": {
        "id": "003aaa06-9ffa-4e06-858e-cd6773219f8a",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "440515f4-6f6f-4b24-a125-8e4d3a6a7cb4",
        "db_currency_id": "bdccf7b5-5e32-4707-bac1-7531543c0192",
        "db_language_id": "efb66c7a-0a9b-4a05-bfaa-c6940a7b82d2",
        "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-02-25T11:09:34.0193029+00:00"
      },
      "modified_dateutc": "2024-02-25T11:09:34.0193029+00:00"
    },
    "equipment_family_id": "c95b0aa8-c284-45e9-ba37-d3dd44bbf3dd",
    "equipment_family_code": "sample string 8",
    "equipment_family": {
      "id": "053a627c-3dc3-4cf7-b153-ea423dd37581",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "_parent_id": "62c146a6-81ae-45c4-b15f-4cb68d2fc447",
      "_parent_code": "sample string 6",
      "sales_organization_id": "9d4b4123-7a73-4812-b4b7-a0546a111f69",
      "sales_organization_code": "sample string 8",
      "sales_organization": {
        "id": "003aaa06-9ffa-4e06-858e-cd6773219f8a",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "440515f4-6f6f-4b24-a125-8e4d3a6a7cb4",
        "db_currency_id": "bdccf7b5-5e32-4707-bac1-7531543c0192",
        "db_language_id": "efb66c7a-0a9b-4a05-bfaa-c6940a7b82d2",
        "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-02-25T11:09:34.0193029+00:00"
      },
      "modified_dateutc": "2024-02-25T11:09:34.0193029+00:00"
    },
    "date_in_production_since": "2024-02-25T11:09:34.0193029+00:00",
    "date_out_of_production_since": "2024-02-25T11:09:34.0193029+00:00",
    "date_end_support": "2024-02-25T11:09:34.0193029+00:00",
    "sales_organization_id": "0691d5a0-65c7-4609-85c2-84c305bfad0f",
    "sales_organization_code": "sample string 13",
    "sales_organization": {
      "id": "003aaa06-9ffa-4e06-858e-cd6773219f8a",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "440515f4-6f6f-4b24-a125-8e4d3a6a7cb4",
      "db_currency_id": "bdccf7b5-5e32-4707-bac1-7531543c0192",
      "db_language_id": "efb66c7a-0a9b-4a05-bfaa-c6940a7b82d2",
      "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-02-25T11:09:34.0193029+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-02-25T11:09:34.0193029+00:00"
  },
  "project_status_id": "7ad142c7-bb99-4773-83de-0abb1c43486b",
  "project_status_code": "sample string 10",
  "project_status": {
    "id": "ef08ec98-2d0d-4fc1-b5f1-4cbcf2831855",
    "name": "sample string 2",
    "is_default": true,
    "is_closed": true,
    "sales_organization_id": "4a7ccb74-15a3-4dc9-88af-e8bb9e0629a5",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "003aaa06-9ffa-4e06-858e-cd6773219f8a",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "440515f4-6f6f-4b24-a125-8e4d3a6a7cb4",
      "db_currency_id": "bdccf7b5-5e32-4707-bac1-7531543c0192",
      "db_language_id": "efb66c7a-0a9b-4a05-bfaa-c6940a7b82d2",
      "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-02-25T11:09:34.0193029+00:00"
    },
    "code": "sample string 7",
    "modified_dateutc": "2024-02-25T11:09:34.0193029+00:00"
  },
  "company_id": "d5aec2b5-9b01-4869-86a3-6e02e3d2e156",
  "company_code": "sample string 12",
  "db_address_id": "3b42c87b-2672-40ff-bbb5-0015a0edc545",
  "db_address_code": "sample string 14",
  "location": "sample string 15",
  "contact_id": "3c7c4bd2-1144-4117-873d-21ea9b558611",
  "contact_reference_back_office": "sample string 17",
  "owner_user_id": "e363d236-cccb-4f29-b1c2-cc4b88481eed",
  "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-02-25T11:09:34.0193029+00:00",
  "date_create": "2024-02-25T11:09:34.0193029+00:00",
  "date_update": "2024-02-25T11:09:34.0193029+00:00",
  "updated_by_user_id": "b2377525-79a5-44d8-ab47-5c8b19e2a3bd",
  "customer_reference": "sample string 28",
  "warranty_date_until": "2024-02-25T11:09:34.0193029+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-02-25T00:00:00+00:00",
  "shutdown_consequence": "sample string 35",
  "id2": 36,
  "nb_open_jobs": 37,
  "date_next_job": "2024-02-25T11:09:34.0193029+00:00",
  "date_last_job": "2024-02-25T11:09:34.0193029+00:00",
  "nb_jobs_planned": 40,
  "nb_jobs_tobeplanned": 41,
  "nb_jobs_waitingfurtheraction": 42,
  "back_office_timestamp": "2024-02-25T11:09:34.0193029+00:00",
  "modified_dateutc": "2024-02-25T11:09:34.0193029+00:00",
  "is_mobile_installation": true
}