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": "25fbe192-689e-4df6-89e1-e897c837acef",
  "_parent_id": "3b25e2f1-c972-4975-8156-d474ae877e71",
  "root_parent_id": "dff8fa6e-8818-44bc-b40a-92032ae9b90d",
  "_parent_reference_back_office": "sample string 4",
  "equipment_family_id": "62379829-28c5-4f04-9745-3417e4f0ecaa",
  "equipment_family_code": "sample string 6",
  "equipment_family": {
    "id": "be5445b5-1ec7-45ac-bd64-3c8a3299334a",
    "name": "sample string 2",
    "description": "sample string 3",
    "code": "sample string 4",
    "_parent_id": "eb81ba7a-1699-426b-9817-b97fd68646d0",
    "_parent_code": "sample string 6",
    "sales_organization_id": "a4b2a1cd-cd56-4b3b-911f-1330ba94cb87",
    "sales_organization_code": "sample string 8",
    "sales_organization": {
      "id": "7fbd2e8d-7896-4eef-8641-81e62dd974eb",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "7f6ae1de-fb9a-4afd-b90c-c210dc490f6c",
      "db_currency_id": "0a1ea5da-0545-46fe-ab43-7d17aa8389bb",
      "db_language_id": "d188a343-5566-4be3-98ac-8742a3b1d299",
      "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-11-01T14:54:27.4228209+00:00"
    },
    "modified_dateutc": "2024-11-01T14:54:27.4228209+00:00"
  },
  "equipment_model_id": "44342da7-83fc-40e2-80eb-2c0fa59213dc",
  "equipment_model_code": "sample string 8",
  "equipment_model": {
    "id": "1014227a-1f21-4293-a000-b2a58942f58d",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "equipment_brand_id": "36702b6d-28af-4ac8-b51f-58d6cdc0f4a8",
    "equipment_brand_code": "sample string 6",
    "equipment_brand": {
      "id": "1d2248e7-55a1-428b-8480-670ad33ae405",
      "name": "sample string 2",
      "code": "sample string 3",
      "sales_organization_id": "ada9c82d-01d5-411a-b463-ec15cd0ec606",
      "sales_organization_code": "sample string 5",
      "sales_organization": {
        "id": "7fbd2e8d-7896-4eef-8641-81e62dd974eb",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "7f6ae1de-fb9a-4afd-b90c-c210dc490f6c",
        "db_currency_id": "0a1ea5da-0545-46fe-ab43-7d17aa8389bb",
        "db_language_id": "d188a343-5566-4be3-98ac-8742a3b1d299",
        "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-11-01T14:54:27.4228209+00:00"
      },
      "modified_dateutc": "2024-11-01T14:54:27.4228209+00:00"
    },
    "equipment_family_id": "38ed3122-66a7-4222-adc6-71dfe360f5eb",
    "equipment_family_code": "sample string 8",
    "equipment_family": {
      "id": "be5445b5-1ec7-45ac-bd64-3c8a3299334a",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "_parent_id": "eb81ba7a-1699-426b-9817-b97fd68646d0",
      "_parent_code": "sample string 6",
      "sales_organization_id": "a4b2a1cd-cd56-4b3b-911f-1330ba94cb87",
      "sales_organization_code": "sample string 8",
      "sales_organization": {
        "id": "7fbd2e8d-7896-4eef-8641-81e62dd974eb",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "7f6ae1de-fb9a-4afd-b90c-c210dc490f6c",
        "db_currency_id": "0a1ea5da-0545-46fe-ab43-7d17aa8389bb",
        "db_language_id": "d188a343-5566-4be3-98ac-8742a3b1d299",
        "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-11-01T14:54:27.4228209+00:00"
      },
      "modified_dateutc": "2024-11-01T14:54:27.4228209+00:00"
    },
    "date_in_production_since": "2024-11-01T14:54:27.4228209+00:00",
    "date_out_of_production_since": "2024-11-01T14:54:27.4228209+00:00",
    "date_end_support": "2024-11-01T14:54:27.4228209+00:00",
    "sales_organization_id": "83be8caa-a2ee-48a4-b4bb-478681b9ad56",
    "sales_organization_code": "sample string 13",
    "sales_organization": {
      "id": "7fbd2e8d-7896-4eef-8641-81e62dd974eb",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "7f6ae1de-fb9a-4afd-b90c-c210dc490f6c",
      "db_currency_id": "0a1ea5da-0545-46fe-ab43-7d17aa8389bb",
      "db_language_id": "d188a343-5566-4be3-98ac-8742a3b1d299",
      "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-11-01T14:54:27.4228209+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-11-01T14:54:27.4228209+00:00"
  },
  "project_status_id": "79155885-241d-4624-a49f-3d2c00e756d9",
  "project_status_code": "sample string 10",
  "project_status": {
    "id": "3806621b-42b7-4970-ba1a-be91e9565cf5",
    "name": "sample string 2",
    "is_default": true,
    "is_closed": true,
    "sales_organization_id": "ab57715d-01ae-4c6e-abe2-b3f57d34f1e4",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "7fbd2e8d-7896-4eef-8641-81e62dd974eb",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "7f6ae1de-fb9a-4afd-b90c-c210dc490f6c",
      "db_currency_id": "0a1ea5da-0545-46fe-ab43-7d17aa8389bb",
      "db_language_id": "d188a343-5566-4be3-98ac-8742a3b1d299",
      "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-11-01T14:54:27.4228209+00:00"
    },
    "code": "sample string 7",
    "modified_dateutc": "2024-11-01T14:54:27.4228209+00:00"
  },
  "company_id": "6a2cf3aa-1a0a-4814-acc4-efa2a6ab1689",
  "company_code": "sample string 12",
  "db_address_id": "caf860e1-cf8b-4fcc-9d64-e16757cbd695",
  "db_address_code": "sample string 14",
  "location": "sample string 15",
  "contact_id": "703bf5c3-7b57-4fce-b926-8f6d8886ff31",
  "contact_reference_back_office": "sample string 17",
  "owner_user_id": "905733d7-cd71-4730-a5d6-546b1ca2f1f9",
  "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-11-01T14:54:27.4228209+00:00",
  "date_create": "2024-11-01T14:54:27.4228209+00:00",
  "date_update": "2024-11-01T14:54:27.4228209+00:00",
  "updated_by_user_id": "7783fdd2-99df-434a-88ac-38fa1cf41578",
  "customer_reference": "sample string 28",
  "warranty_date_until": "2024-11-01T14:54:27.4228209+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-11-01T00:00:00+00:00",
  "shutdown_consequence": "sample string 35",
  "id2": 36,
  "nb_open_jobs": 37,
  "date_next_job": "2024-11-01T14:54:27.4228209+00:00",
  "date_last_job": "2024-11-01T14:54:27.4228209+00:00",
  "nb_jobs_planned": 40,
  "nb_jobs_tobeplanned": 41,
  "nb_jobs_waitingfurtheraction": 42,
  "back_office_timestamp": "2024-11-01T14:54:27.4228209+00:00",
  "modified_dateutc": "2024-11-01T14:54:27.4228209+00:00",
  "is_mobile_installation": true
}