Retrieves all the projects

Request Information

URI Parameters :

None.

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": "54357c53-0b22-45c8-8115-abc0548cb2e0",
  "_parent_id": "f3a98040-e1b9-41fb-b773-546c02269c40",
  "root_parent_id": "50cd5293-5b58-495c-be9e-986ed1026a81",
  "_parent_reference_back_office": "sample string 4",
  "equipment_family_id": "6645d2f7-34e0-47bd-8625-b9b001b7d1b5",
  "equipment_family_code": "sample string 6",
  "equipment_family": {
    "id": "a015f894-750f-4c17-afc8-c9a18768d980",
    "name": "sample string 2",
    "description": "sample string 3",
    "code": "sample string 4",
    "_parent_id": "df49a54c-20d0-455a-8b4e-1aed685dc9da",
    "_parent_code": "sample string 6",
    "sales_organization_id": "e0f61a35-34f1-40e6-bb5b-91feeda47749",
    "sales_organization_code": "sample string 8",
    "sales_organization": {
      "id": "8f9ee630-2973-4913-a705-4395b058c0c9",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "5ea229d0-20be-4856-b858-d3c522f99bbd",
      "db_currency_id": "f7cbcd62-f90c-4c24-a1bd-f07866b29091",
      "db_language_id": "231330ff-9104-4f71-8589-f34ae9321dbb",
      "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-17T02:07:16.9306671+00:00"
    },
    "modified_dateutc": "2024-02-17T02:07:16.9306671+00:00"
  },
  "equipment_model_id": "2370cbc2-52f9-47c5-adee-5f6384c11795",
  "equipment_model_code": "sample string 8",
  "equipment_model": {
    "id": "75c2bd09-cc98-412f-a41b-b6b06ba05e87",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "equipment_brand_id": "972f158f-b10f-48cc-a8ea-ffb95d0d58bf",
    "equipment_brand_code": "sample string 6",
    "equipment_brand": {
      "id": "38893262-fb86-456d-9cad-0bf7ba578f1a",
      "name": "sample string 2",
      "code": "sample string 3",
      "sales_organization_id": "0724654e-182f-4c88-abbf-3f73b5405fb7",
      "sales_organization_code": "sample string 5",
      "sales_organization": {
        "id": "8f9ee630-2973-4913-a705-4395b058c0c9",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "5ea229d0-20be-4856-b858-d3c522f99bbd",
        "db_currency_id": "f7cbcd62-f90c-4c24-a1bd-f07866b29091",
        "db_language_id": "231330ff-9104-4f71-8589-f34ae9321dbb",
        "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-17T02:07:16.9306671+00:00"
      },
      "modified_dateutc": "2024-02-17T02:07:16.9306671+00:00"
    },
    "equipment_family_id": "9371da3f-3307-47bc-8c58-7dd53e225b92",
    "equipment_family_code": "sample string 8",
    "equipment_family": {
      "id": "a015f894-750f-4c17-afc8-c9a18768d980",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "_parent_id": "df49a54c-20d0-455a-8b4e-1aed685dc9da",
      "_parent_code": "sample string 6",
      "sales_organization_id": "e0f61a35-34f1-40e6-bb5b-91feeda47749",
      "sales_organization_code": "sample string 8",
      "sales_organization": {
        "id": "8f9ee630-2973-4913-a705-4395b058c0c9",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "5ea229d0-20be-4856-b858-d3c522f99bbd",
        "db_currency_id": "f7cbcd62-f90c-4c24-a1bd-f07866b29091",
        "db_language_id": "231330ff-9104-4f71-8589-f34ae9321dbb",
        "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-17T02:07:16.9306671+00:00"
      },
      "modified_dateutc": "2024-02-17T02:07:16.9306671+00:00"
    },
    "date_in_production_since": "2024-02-17T02:07:16.9306671+00:00",
    "date_out_of_production_since": "2024-02-17T02:07:16.9306671+00:00",
    "date_end_support": "2024-02-17T02:07:16.9306671+00:00",
    "sales_organization_id": "b4146c0c-9f3e-4b6e-8eb3-8e55ec91a171",
    "sales_organization_code": "sample string 13",
    "sales_organization": {
      "id": "8f9ee630-2973-4913-a705-4395b058c0c9",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "5ea229d0-20be-4856-b858-d3c522f99bbd",
      "db_currency_id": "f7cbcd62-f90c-4c24-a1bd-f07866b29091",
      "db_language_id": "231330ff-9104-4f71-8589-f34ae9321dbb",
      "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-17T02:07:16.9306671+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-17T02:07:16.9306671+00:00"
  },
  "project_status_id": "e8acaebf-0f95-45f5-b4e1-8eaf21b08e7a",
  "project_status_code": "sample string 10",
  "project_status": {
    "id": "e12ace3c-0a76-49fe-99cb-0de6f1f5003f",
    "name": "sample string 2",
    "is_default": true,
    "is_closed": true,
    "sales_organization_id": "f70d599d-f07a-4643-9061-92fd654a273b",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "8f9ee630-2973-4913-a705-4395b058c0c9",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "5ea229d0-20be-4856-b858-d3c522f99bbd",
      "db_currency_id": "f7cbcd62-f90c-4c24-a1bd-f07866b29091",
      "db_language_id": "231330ff-9104-4f71-8589-f34ae9321dbb",
      "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-17T02:07:16.9306671+00:00"
    },
    "code": "sample string 7",
    "modified_dateutc": "2024-02-17T02:07:16.9306671+00:00"
  },
  "company_id": "01f4ba4c-7ab1-4ec4-8c1d-bf31fa0ab815",
  "company_code": "sample string 12",
  "db_address_id": "da6447b2-221e-4c7d-952e-be0f199f8b9b",
  "db_address_code": "sample string 14",
  "location": "sample string 15",
  "contact_id": "a4e39b42-986c-45f6-ba05-d32b53c1e016",
  "contact_reference_back_office": "sample string 17",
  "owner_user_id": "b29d04c4-bfdb-4a7a-a859-e37b2b1e4748",
  "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-17T02:07:16.9306671+00:00",
  "date_create": "2024-02-17T02:07:16.9306671+00:00",
  "date_update": "2024-02-17T02:07:16.9306671+00:00",
  "updated_by_user_id": "300ee06f-2bce-46a1-a831-e7ae2c722bc5",
  "customer_reference": "sample string 28",
  "warranty_date_until": "2024-02-17T02:07:16.9306671+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-17T00:00:00+00:00",
  "shutdown_consequence": "sample string 35",
  "id2": 36,
  "nb_open_jobs": 37,
  "date_next_job": "2024-02-17T02:07:16.9306671+00:00",
  "date_last_job": "2024-02-17T02:07:16.9306671+00:00",
  "nb_jobs_planned": 40,
  "nb_jobs_tobeplanned": 41,
  "nb_jobs_waitingfurtheraction": 42,
  "back_office_timestamp": "2024-02-17T02:07:16.9306671+00:00",
  "modified_dateutc": "2024-02-17T02:07:16.9306671+00:00",
  "is_mobile_installation": true
}