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": "b340f068-8b82-4eb5-aac3-7648d7191e57",
  "_parent_id": "f93ad70d-6bca-44d7-8491-8038c2a3ff39",
  "root_parent_id": "008ec5f0-2611-4926-a644-9490a0954f93",
  "_parent_reference_back_office": "sample string 4",
  "equipment_family_id": "d37fc1fe-8ba4-41fd-9fff-ff7bd77e98b8",
  "equipment_family_code": "sample string 6",
  "equipment_family": {
    "id": "8e2ef4af-9a81-41f4-a915-11aa13e59a11",
    "name": "sample string 2",
    "description": "sample string 3",
    "code": "sample string 4",
    "_parent_id": "f6892070-ba55-4fed-99f8-e0144722bb25",
    "_parent_code": "sample string 6",
    "sales_organization_id": "7b5ac17b-d455-4689-8052-e442dc62970d",
    "sales_organization_code": "sample string 8",
    "sales_organization": {
      "id": "0e2c530c-42bd-4381-bed1-c37d9848cc95",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "9ef5cbd6-6420-422d-bf60-c7b2e7570edb",
      "db_currency_id": "c78b3dd4-1265-4792-9a5a-9e835fe98aaa",
      "db_language_id": "9f9e46c3-186f-4907-bbe0-a9e7d77e45fb",
      "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-08-17T04:16:24.8472271+02:00"
    },
    "modified_dateutc": "2022-08-17T04:16:24.8472271+02:00"
  },
  "equipment_model_id": "28efae46-2ba0-4b6c-a2da-828d3c0a9e96",
  "equipment_model_code": "sample string 8",
  "equipment_model": {
    "id": "558e6200-833e-4cae-b6cb-d75b7f28b8e4",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "equipment_brand_id": "d9685762-776b-450b-9688-144302a11619",
    "equipment_brand_code": "sample string 6",
    "equipment_brand": {
      "id": "82855fa3-34ee-49f9-9590-f30994923422",
      "name": "sample string 2",
      "code": "sample string 3",
      "sales_organization_id": "f58c9868-9e1a-4979-911f-2420db7aaf19",
      "sales_organization_code": "sample string 5",
      "sales_organization": {
        "id": "0e2c530c-42bd-4381-bed1-c37d9848cc95",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "9ef5cbd6-6420-422d-bf60-c7b2e7570edb",
        "db_currency_id": "c78b3dd4-1265-4792-9a5a-9e835fe98aaa",
        "db_language_id": "9f9e46c3-186f-4907-bbe0-a9e7d77e45fb",
        "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-08-17T04:16:24.8472271+02:00"
      },
      "modified_dateutc": "2022-08-17T04:16:24.8472271+02:00"
    },
    "equipment_family_id": "6ddf9b4f-e127-4c96-be4e-cc5d47143bca",
    "equipment_family_code": "sample string 8",
    "equipment_family": {
      "id": "8e2ef4af-9a81-41f4-a915-11aa13e59a11",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "_parent_id": "f6892070-ba55-4fed-99f8-e0144722bb25",
      "_parent_code": "sample string 6",
      "sales_organization_id": "7b5ac17b-d455-4689-8052-e442dc62970d",
      "sales_organization_code": "sample string 8",
      "sales_organization": {
        "id": "0e2c530c-42bd-4381-bed1-c37d9848cc95",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "9ef5cbd6-6420-422d-bf60-c7b2e7570edb",
        "db_currency_id": "c78b3dd4-1265-4792-9a5a-9e835fe98aaa",
        "db_language_id": "9f9e46c3-186f-4907-bbe0-a9e7d77e45fb",
        "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-08-17T04:16:24.8472271+02:00"
      },
      "modified_dateutc": "2022-08-17T04:16:24.8472271+02:00"
    },
    "date_in_production_since": "2022-08-17T04:16:24.8472271+02:00",
    "date_out_of_production_since": "2022-08-17T04:16:24.8472271+02:00",
    "date_end_support": "2022-08-17T04:16:24.8472271+02:00",
    "sales_organization_id": "ea7dc926-3f08-4d90-9396-15b22068908a",
    "sales_organization_code": "sample string 13",
    "sales_organization": {
      "id": "0e2c530c-42bd-4381-bed1-c37d9848cc95",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "9ef5cbd6-6420-422d-bf60-c7b2e7570edb",
      "db_currency_id": "c78b3dd4-1265-4792-9a5a-9e835fe98aaa",
      "db_language_id": "9f9e46c3-186f-4907-bbe0-a9e7d77e45fb",
      "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-08-17T04:16:24.8472271+02: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-08-17T04:16:24.8472271+02:00"
  },
  "project_status_id": "9e215055-6adb-4f21-812c-06efc7ed3ff8",
  "project_status_code": "sample string 10",
  "project_status": {
    "id": "7dd0d96b-76c8-4584-a26d-f2b9eff4da3b",
    "name": "sample string 2",
    "is_default": true,
    "is_closed": true,
    "sales_organization_id": "21a63226-9372-4db0-94e5-4ec6c94581d7",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "0e2c530c-42bd-4381-bed1-c37d9848cc95",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "9ef5cbd6-6420-422d-bf60-c7b2e7570edb",
      "db_currency_id": "c78b3dd4-1265-4792-9a5a-9e835fe98aaa",
      "db_language_id": "9f9e46c3-186f-4907-bbe0-a9e7d77e45fb",
      "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-08-17T04:16:24.8472271+02:00"
    },
    "code": "sample string 7",
    "modified_dateutc": "2022-08-17T04:16:24.8472271+02:00"
  },
  "company_id": "fc05d593-7ef5-4439-9b6c-94231f9684c9",
  "company_code": "sample string 12",
  "db_address_id": "463ac3ac-063d-4d92-867d-2e66cc82deb6",
  "db_address_code": "sample string 14",
  "location": "sample string 15",
  "contact_id": "16ddc792-c8b1-42d7-a408-b43e55baf788",
  "contact_reference_back_office": "sample string 17",
  "owner_user_id": "628bbdd4-279c-4a99-8676-6d4e94bff980",
  "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-08-17T04:16:24.8472271+02:00",
  "date_create": "2022-08-17T04:16:24.8472271+02:00",
  "date_update": "2022-08-17T04:16:24.8472271+02:00",
  "updated_by_user_id": "e113b0a0-374d-49e6-9124-b0fdda20e086",
  "customer_reference": "sample string 28",
  "warranty_date_until": "2022-08-17T04:16:24.8472271+02: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-08-17T00:00:00+02:00",
  "shutdown_consequence": "sample string 35",
  "id2": 36,
  "nb_open_jobs": 37,
  "date_next_job": "2022-08-17T04:16:24.8472271+02:00",
  "date_last_job": "2022-08-17T04:16:24.8472271+02:00",
  "nb_jobs_planned": 40,
  "nb_jobs_tobeplanned": 41,
  "nb_jobs_waitingfurtheraction": 42,
  "back_office_timestamp": "2022-08-17T04:16:24.8472271+02:00",
  "modified_dateutc": "2022-08-17T04:16:24.8472271+02:00",
  "is_mobile_installation": true
}