Retrieves all the work orders
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
jobs| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier | |
| _parent_id |
Reference to a parent job (in case of Multi Job) |
globally unique identifier | |
| _parent_job |
Embedded entity "job" for parent (multi job level) when adding/updating job |
jobs | |
| _parent_jobs_reference_back_office |
Embedded entity "job" for parent (multi job level) using ERP PK when adding/updating job |
string | |
| project_id |
Foreign key of project for this job |
globally unique identifier |
Optionally required : project_id, project_reference_back_office or project must be provided |
| project_reference_back_office |
Embedded entity "project" using ERP PK when adding/updating job |
string |
Optionally required : project_id, project_reference_back_office or project must be provided |
| project |
Embedded entity "project" when adding/updating job |
project |
Optionally required : project_id, project_reference_back_office or project must be provided |
| job_type_id |
Foreign key of job type for this job |
globally unique identifier |
Optionally required : job_type_id, job_type_code or job_type must be provided |
| job_type_code |
Embedded entity "job_type" using ERP PK when adding/updating job |
string |
Optionally required : job_type_id, job_type_code or job_type must be provided |
| job_type |
Embedded entity "job_type" when adding/updating job |
job_type |
Optionally required : job_type_id, job_type_code or job_type must be provided |
| job_priority_id |
Foreign key of job priority for this job |
globally unique identifier | |
| job_priority_code |
Foreign key of job status for this job. If you don't know the GUID, use job_type_code |
string | |
| job_priority |
Embedded entity "job_priority" when adding/updating job |
job_priority | |
| job_status_id |
Foreign key of job status for this job |
globally unique identifier |
Optionally required : job_status_id or job_status_code must be provided |
| job_status_code |
Foreign key of job status using code. Use "Canceled,ToBePlanned, Waiting, Pooling, Suggested, Activated or Open" If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
string |
Optionally required : job_status_id or job_status_code must be provided |
| db_address_id |
Foreign key of db_address if job is not on a mobile equipment.Must be the address_id of the location or the equipment |
globally unique identifier | |
| contact_id |
Foreign key of contact if the main contact of the job is different than the one of the project |
globally unique identifier | |
| requested_by_company_id |
Foreign key of company if a specific company makes the request for this job |
globally unique identifier | |
| requested_by_contact_id |
Foreign key of contact to specify why contact of the requested_company_id makes the request |
globally unique identifier | |
| reference_back_office |
The Id/Ref of the back office for this job. Used by Embedded entity |
string |
Max length: 50 |
| name |
Name of the Job |
string |
Required Max length: 255 |
| description |
Description of the job |
string |
Max length: 4000 |
| working_sequence |
In case of mutli job, they will be ordered by this sequence |
integer | |
| internal_memo |
Internal field for communication between BackOffice/Planners/Technicians |
string | |
| prejob_information |
Information usefull for the technician before start (Call the customer,...) |
string | |
| estimated_time |
Estimation of the time needed (in minute). Will be used for planning and statistic |
integer | |
| earliest_date_plannable |
Use this field if there is a minimum date for the planning (Not Before) |
date | |
| due_date |
Deadline of Max date for the planning (Not After) |
date | |
| date_create |
Creation date+time |
date | |
| date_update |
Update date+time |
date | |
| date_closed |
Date+time job goes to completed |
date | |
| suggested_user_id |
Foreign key of user if there is a suggested user (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
globally unique identifier | |
| suggested_user_code |
Embedded entity "suggested user" using ERP PK when adding/updating job |
string | |
| suggested_user |
Embedded entity "sugessted user" when adding/updating job |
user | |
| suggested_date_start |
Suggested date+time start (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
date | |
| skill_id |
Foreign key of skill if the job requires a specific skill (used for planning) |
globally unique identifier | |
| skill_code |
Embedded entity "skill" using ERP PK when adding/updating job |
string | |
| skill |
Embedded entity "skill" when adding/updating job |
skill | |
| customer_reference |
Reference of this job for the customer |
string |
Max length: 50 |
| approval_responsible_user_id |
In case of multi user job, foreign key of user that is the "WO Leader" |
globally unique identifier | |
| date_reported_by_company |
Date+time when company reported the problem |
date | |
| id2 |
Internal ID (numeric). Will be used if reference_back_office is empty |
integer | |
| company_id |
This field will be filled automatically based on the project_id |
globally unique identifier | |
| company_code |
This field will be filled automatically based on the project_id |
string | |
| db_address_name |
When mobile equipment, the address to use |
string |
Max length: 100 |
| db_address_street |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
| db_address_street2 |
It is sub street |
string |
Max length: 50 |
| db_address_street_number |
When mobile equipment, the address to use |
string |
Max length: 50 |
| db_address_city |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
| db_address_zip |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
| db_address_db_country_id |
When mobile equipment, the address to use |
globally unique identifier | |
| db_address_db_country_code |
When mobile equipment, the address to use |
string | |
| db_address_phone |
When mobile equipment, the address to use |
string |
Max length: 50 |
| db_address_email |
When mobile equipment, the address to use |
string |
Max length: 250 |
| db_address_latitude_decimal |
Latitude |
decimal number | |
| db_address_longitude_decimal |
Latitude |
decimal number | |
| estimated_quantity_remark |
Description of the parts your technician should use or pick up |
string |
Max length: 4000 |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
{
"id": "20a22075-8110-4ace-a6d0-e83dcac4be55",
"_parent_id": "f222471a-2889-4531-958b-89e24c169c04",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "313643f6-67bd-480c-8f56-763190ed1ea3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d4cb2263-db33-4fe1-9f53-fbed7706e021",
"_parent_id": "1b97de28-7505-4265-b63a-833f8d12ff42",
"root_parent_id": "86f858f7-af0d-4cef-9449-dce4709458d6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "889c96bc-3080-441d-bce0-1d9d3d659442",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ab89ed46-0a9b-43ac-96a3-84e85be1a71d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "39aa4c36-da30-44d2-97f8-f5bb7933bce2",
"_parent_code": "sample string 6",
"sales_organization_id": "63261f05-4376-4753-8e19-63de74b8a627",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ec4db808-740f-45b6-b5c3-66c41061a540",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ebe72bdd-17db-426e-951f-eda27695c03c",
"db_currency_id": "1405e499-d584-428e-ab32-ab2e0343d930",
"db_language_id": "cbda097f-5207-4058-a552-ef3c3b262ed8",
"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": "2026-01-05T04:35:12.6443341+00:00"
},
"modified_dateutc": "2026-01-05T04:35:12.6443341+00:00"
},
"equipment_model_id": "40ef9e21-75e7-4791-87c0-abe8442ef2a6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1850fe9b-8244-4b89-b648-0bc78567970e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bc35e11c-684e-419a-a196-25a6a0eebb6d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "19ba61db-cfa7-4f58-bad5-d309bead2753",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0a3d7005-f53d-40b5-b032-84b1dc20fb01",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ec4db808-740f-45b6-b5c3-66c41061a540",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ebe72bdd-17db-426e-951f-eda27695c03c",
"db_currency_id": "1405e499-d584-428e-ab32-ab2e0343d930",
"db_language_id": "cbda097f-5207-4058-a552-ef3c3b262ed8",
"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": "2026-01-05T04:35:12.6443341+00:00"
},
"modified_dateutc": "2026-01-05T04:35:12.6443341+00:00"
},
"equipment_family_id": "f300633e-b669-4b1d-8637-9c52f9ac684a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ab89ed46-0a9b-43ac-96a3-84e85be1a71d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "39aa4c36-da30-44d2-97f8-f5bb7933bce2",
"_parent_code": "sample string 6",
"sales_organization_id": "63261f05-4376-4753-8e19-63de74b8a627",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ec4db808-740f-45b6-b5c3-66c41061a540",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ebe72bdd-17db-426e-951f-eda27695c03c",
"db_currency_id": "1405e499-d584-428e-ab32-ab2e0343d930",
"db_language_id": "cbda097f-5207-4058-a552-ef3c3b262ed8",
"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": "2026-01-05T04:35:12.6443341+00:00"
},
"modified_dateutc": "2026-01-05T04:35:12.6443341+00:00"
},
"date_in_production_since": "2026-01-05T04:35:12.6443341+00:00",
"date_out_of_production_since": "2026-01-05T04:35:12.6443341+00:00",
"date_end_support": "2026-01-05T04:35:12.6443341+00:00",
"sales_organization_id": "563fa4ee-6e8d-40a5-90b9-e702e3b8cb75",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ec4db808-740f-45b6-b5c3-66c41061a540",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ebe72bdd-17db-426e-951f-eda27695c03c",
"db_currency_id": "1405e499-d584-428e-ab32-ab2e0343d930",
"db_language_id": "cbda097f-5207-4058-a552-ef3c3b262ed8",
"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": "2026-01-05T04:35:12.6443341+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": "2026-01-05T04:35:12.6443341+00:00"
},
"project_status_id": "3bdd2ec7-e296-4b5f-a6fa-3432b7402a43",
"project_status_code": "sample string 10",
"project_status": {
"id": "21239f1f-8b80-4060-9be3-c1f2a1de1e8f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bad78479-e790-4114-86ca-a9f157b39a4b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ec4db808-740f-45b6-b5c3-66c41061a540",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ebe72bdd-17db-426e-951f-eda27695c03c",
"db_currency_id": "1405e499-d584-428e-ab32-ab2e0343d930",
"db_language_id": "cbda097f-5207-4058-a552-ef3c3b262ed8",
"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": "2026-01-05T04:35:12.6443341+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-05T04:35:12.6443341+00:00"
},
"company_id": "24407221-1fcc-4df3-923f-449f4c71fcab",
"company_code": "sample string 12",
"db_address_id": "c478295e-043d-4e23-a18b-7a38a63fe26a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "380b85ea-da7e-4b5b-abc5-776b45d1fb44",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0240a273-12a6-40db-b413-7207413ec1ef",
"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": "2026-01-05T04:35:12.6443341+00:00",
"date_create": "2026-01-05T04:35:12.6443341+00:00",
"date_update": "2026-01-05T04:35:12.6443341+00:00",
"updated_by_user_id": "3c12aa32-2434-44b4-931c-0ab0ec055fa7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-05T04:35:12.6443341+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": "2026-01-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-05T04:35:12.6443341+00:00",
"date_last_job": "2026-01-05T04:35:12.6443341+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-05T04:35:12.6443341+00:00",
"modified_dateutc": "2026-01-05T04:35:12.6443341+00:00",
"is_mobile_installation": true
},
"job_type_id": "4972c6ad-5e0a-44d5-9470-f88dcc7610ae",
"job_type_code": "sample string 7",
"job_type": {
"id": "559e3691-18fb-48a9-91bd-3306fba107e9",
"name": "sample string 2",
"sales_organization_id": "c1a0c7d6-d620-4ffa-b5c2-cd412c7b68e7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-05T04:35:12.6443341+00:00",
"code": "sample string 7"
},
"job_priority_id": "59de8890-9354-45bd-949d-1374774c5b07",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b3a5f733-a6fd-419f-8281-06e75de866b2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4b61d223-3f31-45c1-96ac-c1a6e487b345",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ec4db808-740f-45b6-b5c3-66c41061a540",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ebe72bdd-17db-426e-951f-eda27695c03c",
"db_currency_id": "1405e499-d584-428e-ab32-ab2e0343d930",
"db_language_id": "cbda097f-5207-4058-a552-ef3c3b262ed8",
"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": "2026-01-05T04:35:12.6443341+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-05T04:35:12.6443341+00:00"
},
"job_status_id": "3ad179fc-24f3-4791-9225-2531d41c5ea7",
"job_status_code": "sample string 11",
"db_address_id": "991161b7-6442-45bb-b045-1cdc18d34045",
"contact_id": "6deed1c9-5d3b-45dc-bebc-139420dce4a4",
"requested_by_company_id": "41db9bfc-e4cd-43c3-8a6f-91fa715db05d",
"requested_by_contact_id": "fb31ec77-2e76-4142-880d-fec43953c01e",
"reference_back_office": "sample string 16",
"name": "sample string 17",
"description": "sample string 18",
"working_sequence": 19,
"internal_memo": "sample string 20",
"prejob_information": "sample string 21",
"estimated_time": 22,
"earliest_date_plannable": "2026-01-05T04:35:12.6443341+00:00",
"due_date": "2026-01-05T04:35:12.6443341+00:00",
"date_create": "2026-01-05T04:35:12.6443341+00:00",
"date_update": "2026-01-05T04:35:12.6443341+00:00",
"date_closed": "2026-01-05T04:35:12.6443341+00:00",
"suggested_user_id": "145b857f-0ce5-4e69-855a-c7c5b40deb73",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c7e36c02-2580-4a7e-a71f-fe41902e0edb",
"db_language_id": "4d5de83c-2af1-4439-9a3d-f7703034f271",
"username": "sample string 3",
"firstname": "sample string 4",
"lastname": "sample string 5",
"code": "sample string 6",
"archived": true,
"disabled": true,
"emergency_contact": "sample string 9",
"bankaccount": "sample string 10",
"social_security": "sample string 11",
"place_of_birth": "sample string 12",
"nationality": "sample string 13",
"functions": "sample string 14",
"birthdate": "2026-01-05T04:35:12.6443341+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "12ee11af-4a7b-43c0-9768-ed8b4af5cf15",
"sales_organization": {
"id": "ec4db808-740f-45b6-b5c3-66c41061a540",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ebe72bdd-17db-426e-951f-eda27695c03c",
"db_currency_id": "1405e499-d584-428e-ab32-ab2e0343d930",
"db_language_id": "cbda097f-5207-4058-a552-ef3c3b262ed8",
"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": "2026-01-05T04:35:12.6443341+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "13f2c79c-1acb-440d-8325-d4e4180b3bd8",
"email": "sample string 22",
"phone": "sample string 23",
"fax": "sample string 24",
"mobile": "sample string 25",
"private_email": "sample string 26",
"private_phone": "sample string 27",
"private_fax": "sample string 28",
"private_mobile": "sample string 29",
"private_street": "sample string 30",
"private_street_number": "sample string 31",
"private_city": "sample string 32",
"private_zip": "sample string 33",
"private_db_country_id": "2bd1ca9a-06b0-4f8f-acb9-2410e0ae89d2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-05T04:35:12.6443341+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6aa9fdcb-30ff-402d-93ad-24971b98d8bb"
},
"suggested_date_start": "2026-01-05T04:35:12.6443341+00:00",
"skill_id": "141ee6c9-b760-4947-90e3-da25801f9eaa",
"skill_code": "sample string 32",
"skill": {
"id": "798e864e-bc93-4a30-b57c-67ea2ae4125d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "560a8633-2203-47f1-93c5-4e15ea4fc544",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ec4db808-740f-45b6-b5c3-66c41061a540",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ebe72bdd-17db-426e-951f-eda27695c03c",
"db_currency_id": "1405e499-d584-428e-ab32-ab2e0343d930",
"db_language_id": "cbda097f-5207-4058-a552-ef3c3b262ed8",
"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": "2026-01-05T04:35:12.6443341+00:00"
},
"modified_dateutc": "2026-01-05T04:35:12.6443341+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9aeb28b4-5f4a-452f-8887-8a9c15d43fb7",
"date_reported_by_company": "2026-01-05T04:35:12.6443341+00:00",
"id2": 36,
"company_id": "0182de11-28a1-42ab-82a5-17968915552c",
"company_code": "sample string 38",
"db_address_name": "sample string 39",
"db_address_street": "sample string 40",
"db_address_street2": "sample string 41",
"db_address_street_number": "sample string 42",
"db_address_city": "sample string 43",
"db_address_zip": "sample string 44",
"db_address_db_country_id": "584330dd-f724-4eca-ae39-2b3b192b32fe",
"db_address_db_country_code": "sample string 46",
"db_address_phone": "sample string 47",
"db_address_email": "sample string 48",
"db_address_latitude_decimal": 49.0,
"db_address_longitude_decimal": 50.0,
"estimated_quantity_remark": "sample string 51",
"modified_dateutc": "2026-01-05T04:35:12.6443341+00:00"
}