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": "eba72f68-f671-4438-a9a8-660ffa2d71a3",
  "_parent_id": "39165a8e-4594-46f9-b737-5c58321d658c",
  "root_parent_id": "001d01e2-e02d-458f-8efa-0ecf19eb1cf7",
  "_parent_reference_back_office": "sample string 4",
  "equipment_family_id": "4a78b83f-a0e1-48fe-bd74-34805a0efdb8",
  "equipment_family_code": "sample string 6",
  "equipment_family": {
    "id": "9fede2ab-cb6c-43c0-8c57-ab59fc545848",
    "name": "sample string 2",
    "description": "sample string 3",
    "code": "sample string 4",
    "_parent_id": "c3e1e1b6-5900-40f3-98ad-6200d4bec909",
    "_parent_code": "sample string 6",
    "sales_organization_id": "e3d09fc6-d4f4-4fdd-9fba-9cce1ede38f9",
    "sales_organization_code": "sample string 8",
    "sales_organization": {
      "id": "25552b7a-12dc-431d-967a-05843f2b480b",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "8d9592c7-91cd-4ac0-a45b-67f92dc53e61",
      "db_currency_id": "01d2a4ec-8fa0-47fa-af36-4ddf2f7f1126",
      "db_language_id": "d66ad48a-ef03-441d-b724-6135b95866e9",
      "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-06-15T17:39:26.453266+00:00"
    },
    "modified_dateutc": "2024-06-15T17:39:26.453266+00:00"
  },
  "equipment_model_id": "9c9c086e-a9f7-4459-bc7d-3434eca4f72e",
  "equipment_model_code": "sample string 8",
  "equipment_model": {
    "id": "f50f16b6-a00c-4d6e-8119-acf0cacf0545",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "equipment_brand_id": "a9198e10-ddfa-455f-9afe-ab283a4557f5",
    "equipment_brand_code": "sample string 6",
    "equipment_brand": {
      "id": "57b40202-b5b2-4a24-bdc2-f6a4438b3c7d",
      "name": "sample string 2",
      "code": "sample string 3",
      "sales_organization_id": "a28ebc3c-d776-4696-b657-6b3c80a2b4df",
      "sales_organization_code": "sample string 5",
      "sales_organization": {
        "id": "25552b7a-12dc-431d-967a-05843f2b480b",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "8d9592c7-91cd-4ac0-a45b-67f92dc53e61",
        "db_currency_id": "01d2a4ec-8fa0-47fa-af36-4ddf2f7f1126",
        "db_language_id": "d66ad48a-ef03-441d-b724-6135b95866e9",
        "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-06-15T17:39:26.453266+00:00"
      },
      "modified_dateutc": "2024-06-15T17:39:26.453266+00:00"
    },
    "equipment_family_id": "d4cc6a8b-6759-4076-9eae-18e014b9a110",
    "equipment_family_code": "sample string 8",
    "equipment_family": {
      "id": "9fede2ab-cb6c-43c0-8c57-ab59fc545848",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "_parent_id": "c3e1e1b6-5900-40f3-98ad-6200d4bec909",
      "_parent_code": "sample string 6",
      "sales_organization_id": "e3d09fc6-d4f4-4fdd-9fba-9cce1ede38f9",
      "sales_organization_code": "sample string 8",
      "sales_organization": {
        "id": "25552b7a-12dc-431d-967a-05843f2b480b",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "8d9592c7-91cd-4ac0-a45b-67f92dc53e61",
        "db_currency_id": "01d2a4ec-8fa0-47fa-af36-4ddf2f7f1126",
        "db_language_id": "d66ad48a-ef03-441d-b724-6135b95866e9",
        "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-06-15T17:39:26.453266+00:00"
      },
      "modified_dateutc": "2024-06-15T17:39:26.453266+00:00"
    },
    "date_in_production_since": "2024-06-15T17:39:26.453266+00:00",
    "date_out_of_production_since": "2024-06-15T17:39:26.453266+00:00",
    "date_end_support": "2024-06-15T17:39:26.453266+00:00",
    "sales_organization_id": "cd62e71d-dc84-4e74-a975-7b166f4fb9ca",
    "sales_organization_code": "sample string 13",
    "sales_organization": {
      "id": "25552b7a-12dc-431d-967a-05843f2b480b",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "8d9592c7-91cd-4ac0-a45b-67f92dc53e61",
      "db_currency_id": "01d2a4ec-8fa0-47fa-af36-4ddf2f7f1126",
      "db_language_id": "d66ad48a-ef03-441d-b724-6135b95866e9",
      "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-06-15T17:39:26.453266+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-06-15T17:39:26.453266+00:00"
  },
  "project_status_id": "b218e6bb-828f-4a27-be08-a2d6db7f1009",
  "project_status_code": "sample string 10",
  "project_status": {
    "id": "02f5f8f2-98fa-477c-b5a6-6937be427f57",
    "name": "sample string 2",
    "is_default": true,
    "is_closed": true,
    "sales_organization_id": "db9f3234-d9d8-47f6-af49-17695a923634",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "25552b7a-12dc-431d-967a-05843f2b480b",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "8d9592c7-91cd-4ac0-a45b-67f92dc53e61",
      "db_currency_id": "01d2a4ec-8fa0-47fa-af36-4ddf2f7f1126",
      "db_language_id": "d66ad48a-ef03-441d-b724-6135b95866e9",
      "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-06-15T17:39:26.453266+00:00"
    },
    "code": "sample string 7",
    "modified_dateutc": "2024-06-15T17:39:26.453266+00:00"
  },
  "company_id": "fb2c2876-0db5-4fd2-80c1-a33c23a11ff8",
  "company_code": "sample string 12",
  "db_address_id": "1aa6bf02-9f99-495b-98a5-09ed5864bb62",
  "db_address_code": "sample string 14",
  "location": "sample string 15",
  "contact_id": "1f208b8e-3205-4327-b744-624290a8f77c",
  "contact_reference_back_office": "sample string 17",
  "owner_user_id": "1742a703-d32d-4643-9347-c0deef903d49",
  "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-06-15T17:39:26.453266+00:00",
  "date_create": "2024-06-15T17:39:26.453266+00:00",
  "date_update": "2024-06-15T17:39:26.453266+00:00",
  "updated_by_user_id": "f6eab3d8-86af-45d7-9c10-58429eb712ec",
  "customer_reference": "sample string 28",
  "warranty_date_until": "2024-06-15T17:39:26.453266+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-06-15T00:00:00+00:00",
  "shutdown_consequence": "sample string 35",
  "id2": 36,
  "nb_open_jobs": 37,
  "date_next_job": "2024-06-15T17:39:26.453266+00:00",
  "date_last_job": "2024-06-15T17:39:26.453266+00:00",
  "nb_jobs_planned": 40,
  "nb_jobs_tobeplanned": 41,
  "nb_jobs_waitingfurtheraction": 42,
  "back_office_timestamp": "2024-06-15T17:39:26.453266+00:00",
  "modified_dateutc": "2024-06-15T17:39:26.453266+00:00",
  "is_mobile_installation": true
}