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": "0c5433c8-981b-497c-af95-1cf35f9b4f16",
  "_parent_id": "c4c072bb-3f0e-4bad-990b-3604bb01aa79",
  "root_parent_id": "83c8b7d3-ec26-49bf-8e3b-ed45b6d8d351",
  "_parent_reference_back_office": "sample string 4",
  "equipment_family_id": "2e3fd140-92d8-4e3d-862f-e021b2bf0326",
  "equipment_family_code": "sample string 6",
  "equipment_family": {
    "id": "88d66c9c-2182-4d05-aeb0-b2f3153d6ab8",
    "name": "sample string 2",
    "description": "sample string 3",
    "code": "sample string 4",
    "_parent_id": "e6099af8-51fc-4ce6-819c-869e504dbfe3",
    "_parent_code": "sample string 6",
    "sales_organization_id": "c037e50c-e6b8-4ad4-b805-4d099467e423",
    "sales_organization_code": "sample string 8",
    "sales_organization": {
      "id": "24d59188-c6ae-4403-ae26-f63820c2aef7",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "9cae2e02-2036-47a2-aa6a-872953644f28",
      "db_currency_id": "f6a72a73-5cb3-429b-b9ae-32d41c17971d",
      "db_language_id": "5befa431-7016-4b03-819f-a080e808284e",
      "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": "2023-03-30T20:59:00.6910514+00:00"
    },
    "modified_dateutc": "2023-03-30T20:59:00.6910514+00:00"
  },
  "equipment_model_id": "b0dac167-4c96-4c06-a140-ea3ef834b6ba",
  "equipment_model_code": "sample string 8",
  "equipment_model": {
    "id": "d723e279-b94f-40a3-84ca-641a1661aa8e",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "equipment_brand_id": "9de262c0-ad64-4e3e-b9be-ca9bc16cd15c",
    "equipment_brand_code": "sample string 6",
    "equipment_brand": {
      "id": "70ff92b8-d113-49ec-9b05-60fd99b521af",
      "name": "sample string 2",
      "code": "sample string 3",
      "sales_organization_id": "f239aae0-077c-4aef-a9f1-9dd91e39eaf4",
      "sales_organization_code": "sample string 5",
      "sales_organization": {
        "id": "24d59188-c6ae-4403-ae26-f63820c2aef7",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "9cae2e02-2036-47a2-aa6a-872953644f28",
        "db_currency_id": "f6a72a73-5cb3-429b-b9ae-32d41c17971d",
        "db_language_id": "5befa431-7016-4b03-819f-a080e808284e",
        "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": "2023-03-30T20:59:00.6910514+00:00"
      },
      "modified_dateutc": "2023-03-30T20:59:00.6910514+00:00"
    },
    "equipment_family_id": "008625d3-c6ac-4b55-834d-752eda8a7d25",
    "equipment_family_code": "sample string 8",
    "equipment_family": {
      "id": "88d66c9c-2182-4d05-aeb0-b2f3153d6ab8",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "_parent_id": "e6099af8-51fc-4ce6-819c-869e504dbfe3",
      "_parent_code": "sample string 6",
      "sales_organization_id": "c037e50c-e6b8-4ad4-b805-4d099467e423",
      "sales_organization_code": "sample string 8",
      "sales_organization": {
        "id": "24d59188-c6ae-4403-ae26-f63820c2aef7",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "9cae2e02-2036-47a2-aa6a-872953644f28",
        "db_currency_id": "f6a72a73-5cb3-429b-b9ae-32d41c17971d",
        "db_language_id": "5befa431-7016-4b03-819f-a080e808284e",
        "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": "2023-03-30T20:59:00.6910514+00:00"
      },
      "modified_dateutc": "2023-03-30T20:59:00.6910514+00:00"
    },
    "date_in_production_since": "2023-03-30T20:59:00.6910514+00:00",
    "date_out_of_production_since": "2023-03-30T20:59:00.6910514+00:00",
    "date_end_support": "2023-03-30T20:59:00.6910514+00:00",
    "sales_organization_id": "da562304-0880-460c-9afd-89f784872f04",
    "sales_organization_code": "sample string 13",
    "sales_organization": {
      "id": "24d59188-c6ae-4403-ae26-f63820c2aef7",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "9cae2e02-2036-47a2-aa6a-872953644f28",
      "db_currency_id": "f6a72a73-5cb3-429b-b9ae-32d41c17971d",
      "db_language_id": "5befa431-7016-4b03-819f-a080e808284e",
      "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": "2023-03-30T20:59:00.6910514+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": "2023-03-30T20:59:00.6910514+00:00"
  },
  "project_status_id": "a14e1192-6be6-4032-b73b-2e27468c3c52",
  "project_status_code": "sample string 10",
  "project_status": {
    "id": "8cc2c51a-6f97-4aa5-b9e0-0e6cab3d872a",
    "name": "sample string 2",
    "is_default": true,
    "is_closed": true,
    "sales_organization_id": "13624d06-11e7-4482-b8f0-d7642efcd12d",
    "sales_organization_code": "sample string 6",
    "sales_organization": {
      "id": "24d59188-c6ae-4403-ae26-f63820c2aef7",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "9cae2e02-2036-47a2-aa6a-872953644f28",
      "db_currency_id": "f6a72a73-5cb3-429b-b9ae-32d41c17971d",
      "db_language_id": "5befa431-7016-4b03-819f-a080e808284e",
      "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": "2023-03-30T20:59:00.6910514+00:00"
    },
    "code": "sample string 7",
    "modified_dateutc": "2023-03-30T20:59:00.6910514+00:00"
  },
  "company_id": "3851bf81-47c8-4458-b0bc-af2be1e6d647",
  "company_code": "sample string 12",
  "db_address_id": "17bad650-4f55-4f3b-9bbd-eee4fec3b920",
  "db_address_code": "sample string 14",
  "location": "sample string 15",
  "contact_id": "e4d00838-0ef7-4bb6-9fae-0d4089f7d5fc",
  "contact_reference_back_office": "sample string 17",
  "owner_user_id": "e232e8ea-d349-4096-9060-8ae427eef847",
  "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": "2023-03-30T20:59:00.6910514+00:00",
  "date_create": "2023-03-30T20:59:00.6910514+00:00",
  "date_update": "2023-03-30T20:59:00.6910514+00:00",
  "updated_by_user_id": "8424401e-ad6e-40bd-a601-5c2de08d2b50",
  "customer_reference": "sample string 28",
  "warranty_date_until": "2023-03-30T20:59:00.6910514+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": "2023-03-30T00:00:00+00:00",
  "shutdown_consequence": "sample string 35",
  "id2": 36,
  "nb_open_jobs": 37,
  "date_next_job": "2023-03-30T20:59:00.6910514+00:00",
  "date_last_job": "2023-03-30T20:59:00.6910514+00:00",
  "nb_jobs_planned": 40,
  "nb_jobs_tobeplanned": 41,
  "nb_jobs_waitingfurtheraction": 42,
  "back_office_timestamp": "2023-03-30T20:59:00.6910514+00:00",
  "modified_dateutc": "2023-03-30T20:59:00.6910514+00:00",
  "is_mobile_installation": true
}