Retrieves all the work orders
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
jobsName | 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": "dfec3360-9edc-40e5-b7ff-1dff9f26c37a", "_parent_id": "20c33ecc-a2d4-4a55-9333-6f195aea7e35", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "b8d8d656-a266-4e66-9ad7-d75babbc05f2", "project_reference_back_office": "sample string 5", "project": { "id": "d06ffebb-ef92-4fb7-a82b-504697bb912e", "_parent_id": "757aa10e-293c-4d8e-bbdc-ad33af967119", "root_parent_id": "74c64acd-723c-463c-9807-661839da2127", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "d4a660a7-c912-4f23-979e-f763dc187e9e", "equipment_family_code": "sample string 6", "equipment_family": { "id": "56d2b561-6cf3-4ba2-93c2-317c4165b8f3", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "cde960f3-4ee5-4c0b-867c-9e5718a4a23a", "_parent_code": "sample string 6", "sales_organization_id": "a9734e4b-f78a-4b41-b026-b95a1a6aa445", "sales_organization_code": "sample string 8", "sales_organization": { "id": "3f4c40e9-c779-47da-b88e-96262ed50ec8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8f2a2927-f4c8-42b5-8dd3-b5c8ce3b69a1", "db_currency_id": "fa0256e6-b3e1-49d8-8980-ac4d26f67355", "db_language_id": "6752e4dc-aa18-4e6a-ba5a-dc70a04635c8", "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": "2025-10-08T09:40:07.4752764+00:00" }, "modified_dateutc": "2025-10-08T09:40:07.4752764+00:00" }, "equipment_model_id": "24f4342d-3e66-4dd6-8e99-3e62ec756827", "equipment_model_code": "sample string 8", "equipment_model": { "id": "84f29aea-43df-432e-823b-973d36f3bd92", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "7e0b3850-29d2-48a6-b1d6-23295cd7dcde", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "51a6a3a2-3bab-4a4b-a96b-b5249f9dab88", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "b2024fe5-43c6-4f86-bfda-dc1d32c83b74", "sales_organization_code": "sample string 5", "sales_organization": { "id": "3f4c40e9-c779-47da-b88e-96262ed50ec8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8f2a2927-f4c8-42b5-8dd3-b5c8ce3b69a1", "db_currency_id": "fa0256e6-b3e1-49d8-8980-ac4d26f67355", "db_language_id": "6752e4dc-aa18-4e6a-ba5a-dc70a04635c8", "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": "2025-10-08T09:40:07.4752764+00:00" }, "modified_dateutc": "2025-10-08T09:40:07.4752764+00:00" }, "equipment_family_id": "e11e3817-6029-43c0-b0ba-237d33281069", "equipment_family_code": "sample string 8", "equipment_family": { "id": "56d2b561-6cf3-4ba2-93c2-317c4165b8f3", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "cde960f3-4ee5-4c0b-867c-9e5718a4a23a", "_parent_code": "sample string 6", "sales_organization_id": "a9734e4b-f78a-4b41-b026-b95a1a6aa445", "sales_organization_code": "sample string 8", "sales_organization": { "id": "3f4c40e9-c779-47da-b88e-96262ed50ec8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8f2a2927-f4c8-42b5-8dd3-b5c8ce3b69a1", "db_currency_id": "fa0256e6-b3e1-49d8-8980-ac4d26f67355", "db_language_id": "6752e4dc-aa18-4e6a-ba5a-dc70a04635c8", "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": "2025-10-08T09:40:07.4752764+00:00" }, "modified_dateutc": "2025-10-08T09:40:07.4752764+00:00" }, "date_in_production_since": "2025-10-08T09:40:07.4752764+00:00", "date_out_of_production_since": "2025-10-08T09:40:07.4752764+00:00", "date_end_support": "2025-10-08T09:40:07.4752764+00:00", "sales_organization_id": "9d032a76-b3ba-4f5a-86fd-026e16d691a2", "sales_organization_code": "sample string 13", "sales_organization": { "id": "3f4c40e9-c779-47da-b88e-96262ed50ec8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8f2a2927-f4c8-42b5-8dd3-b5c8ce3b69a1", "db_currency_id": "fa0256e6-b3e1-49d8-8980-ac4d26f67355", "db_language_id": "6752e4dc-aa18-4e6a-ba5a-dc70a04635c8", "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": "2025-10-08T09:40:07.4752764+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": "2025-10-08T09:40:07.4752764+00:00" }, "project_status_id": "f4f8e429-5076-4a93-87d0-708f43c32656", "project_status_code": "sample string 10", "project_status": { "id": "c0e786e2-eef2-459e-ad1d-db2ac0cbbac7", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "ea7e9707-c892-450c-a45d-2e8a7b9302c4", "sales_organization_code": "sample string 6", "sales_organization": { "id": "3f4c40e9-c779-47da-b88e-96262ed50ec8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8f2a2927-f4c8-42b5-8dd3-b5c8ce3b69a1", "db_currency_id": "fa0256e6-b3e1-49d8-8980-ac4d26f67355", "db_language_id": "6752e4dc-aa18-4e6a-ba5a-dc70a04635c8", "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": "2025-10-08T09:40:07.4752764+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-08T09:40:07.4752764+00:00" }, "company_id": "a90e0287-b701-4fa8-aa4f-dc5e13d18d9d", "company_code": "sample string 12", "db_address_id": "70ff44b9-e66e-44f9-a70a-87ba7a3f07bc", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "93305cff-fbef-4ea2-a9ca-79d7ffb607bc", "contact_reference_back_office": "sample string 17", "owner_user_id": "17b6620c-2a45-466a-9122-54ea88386ef8", "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": "2025-10-08T09:40:07.4752764+00:00", "date_create": "2025-10-08T09:40:07.4752764+00:00", "date_update": "2025-10-08T09:40:07.4752764+00:00", "updated_by_user_id": "ce639843-29e1-4d3e-8e4f-a9eb46df9a45", "customer_reference": "sample string 28", "warranty_date_until": "2025-10-08T09:40:07.4752764+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": "2025-10-08T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-10-08T09:40:07.4909041+00:00", "date_last_job": "2025-10-08T09:40:07.4909041+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-10-08T09:40:07.4909041+00:00", "modified_dateutc": "2025-10-08T09:40:07.4909041+00:00", "is_mobile_installation": true }, "job_type_id": "a19102df-6516-4bea-ba73-9064d09eaec3", "job_type_code": "sample string 7", "job_type": { "id": "4ee3f245-a2cd-4991-ae8a-40ac952cd167", "name": "sample string 2", "sales_organization_id": "6059b5e7-d766-402b-a0a2-7c3fcce4e2f9", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-10-08T09:40:07.4909041+00:00", "code": "sample string 7" }, "job_priority_id": "39e7a558-a367-4c8f-befd-54687bbc537a", "job_priority_code": "sample string 9", "job_priority": { "id": "d68bfda1-d529-4925-a31e-b36e00df7adc", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "5d1320e4-143e-4769-b5cf-3a8c3271d622", "sales_organization_code": "sample string 6", "sales_organization": { "id": "3f4c40e9-c779-47da-b88e-96262ed50ec8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8f2a2927-f4c8-42b5-8dd3-b5c8ce3b69a1", "db_currency_id": "fa0256e6-b3e1-49d8-8980-ac4d26f67355", "db_language_id": "6752e4dc-aa18-4e6a-ba5a-dc70a04635c8", "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": "2025-10-08T09:40:07.4752764+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-08T09:40:07.4909041+00:00" }, "job_status_id": "cd99ae86-d0b3-4bbb-8789-6bcb504347af", "job_status_code": "sample string 11", "db_address_id": "77802b49-24f7-4b25-b6a4-de5885870455", "contact_id": "ef5cc158-da91-44ce-85e7-b20831a56bd3", "requested_by_company_id": "fa740d1d-195b-4fb5-b471-fb6fffb704c0", "requested_by_contact_id": "7c65cb8f-880d-4e6e-bb2e-d216a16422ff", "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": "2025-10-08T09:40:07.4909041+00:00", "due_date": "2025-10-08T09:40:07.4909041+00:00", "date_create": "2025-10-08T09:40:07.4909041+00:00", "date_update": "2025-10-08T09:40:07.4909041+00:00", "date_closed": "2025-10-08T09:40:07.4909041+00:00", "suggested_user_id": "7129835f-8603-48da-a6ad-ae2b3e6ecc87", "suggested_user_code": "sample string 29", "suggested_user": { "id": "069f5748-85b2-4c13-b3ad-b907093894eb", "db_language_id": "5a4d459f-b58d-4187-9656-df9dc391f511", "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": "2025-10-08T09:40:07.4909041+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "c0593792-580e-49ee-854f-8f07b0b31bb2", "sales_organization": { "id": "3f4c40e9-c779-47da-b88e-96262ed50ec8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8f2a2927-f4c8-42b5-8dd3-b5c8ce3b69a1", "db_currency_id": "fa0256e6-b3e1-49d8-8980-ac4d26f67355", "db_language_id": "6752e4dc-aa18-4e6a-ba5a-dc70a04635c8", "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": "2025-10-08T09:40:07.4752764+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "d60a0ec2-80c1-48bb-b683-5c3ff12f4dff", "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": "7c7409b4-b69a-4df5-bfb3-2ff9e8b1e98c", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-10-08T09:40:07.4909041+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "5e20438e-c510-426c-81d9-80ddfa08e928" }, "suggested_date_start": "2025-10-08T09:40:07.4909041+00:00", "skill_id": "4f453e34-3987-4e3e-b3fe-26b7646affc9", "skill_code": "sample string 32", "skill": { "id": "5b9b0f52-fb7e-460e-bab0-6a206921758e", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "b7d13d6f-8f26-4eb0-b7fd-20b5defaab9a", "sales_organization_code": "sample string 6", "sales_organization": { "id": "3f4c40e9-c779-47da-b88e-96262ed50ec8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8f2a2927-f4c8-42b5-8dd3-b5c8ce3b69a1", "db_currency_id": "fa0256e6-b3e1-49d8-8980-ac4d26f67355", "db_language_id": "6752e4dc-aa18-4e6a-ba5a-dc70a04635c8", "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": "2025-10-08T09:40:07.4752764+00:00" }, "modified_dateutc": "2025-10-08T09:40:07.4909041+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "051ee7be-991a-473b-88b4-7c52a6a70061", "date_reported_by_company": "2025-10-08T09:40:07.4909041+00:00", "id2": 36, "company_id": "b5a4326b-0bfb-478b-b178-a0f5d529030f", "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": "e050eb03-a3ff-4cbe-aa5f-98d72e0ae31c", "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": "2025-10-08T09:40:07.4909041+00:00" }