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": "146d6811-ead3-4a0d-bfd3-840aa28d9cd2", "_parent_id": "b92c5868-9b1f-47c4-80fe-a8a69e113e2d", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "093409e8-e353-49b3-9d85-42f8ed0d12a6", "project_reference_back_office": "sample string 5", "project": { "id": "07b81195-15d1-478c-a9bf-39aa133017dd", "_parent_id": "034ae127-2804-4eca-bf48-2877955e9314", "root_parent_id": "29c492c3-4b38-4bfe-9aa5-f1d863dbe985", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "f3824ed8-37ca-41b3-874f-76f056baf70b", "equipment_family_code": "sample string 6", "equipment_family": { "id": "6dc478a5-7b02-4e8c-88a2-8c98068e8c08", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "c77807c0-5e21-4867-a105-3d57de59f761", "_parent_code": "sample string 6", "sales_organization_id": "8221ee3e-ac49-4548-a498-5024036b7ce9", "sales_organization_code": "sample string 8", "sales_organization": { "id": "ad0a1011-904b-44a1-ad8a-f17d45460a44", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "82b94a61-cffa-4181-8d8c-60a5214c7830", "db_currency_id": "480523c1-2ef8-4c81-b815-af8c7d0f4fba", "db_language_id": "c0a07177-2a82-4943-952a-5236aa4f289d", "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-07-05T17:34:11.4560368+00:00" }, "modified_dateutc": "2025-07-05T17:34:11.4560368+00:00" }, "equipment_model_id": "c9f60fc0-d2e1-4cbe-bb96-cb9de245ca54", "equipment_model_code": "sample string 8", "equipment_model": { "id": "781ba918-00e0-4341-8a17-ba3e1242eb6a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "a7c1401c-02d9-458e-8565-c1111948c856", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "a35070ea-226f-452f-a915-724a3ad4c934", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "46a0f469-a5da-4428-ab09-6e6d356f75d0", "sales_organization_code": "sample string 5", "sales_organization": { "id": "ad0a1011-904b-44a1-ad8a-f17d45460a44", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "82b94a61-cffa-4181-8d8c-60a5214c7830", "db_currency_id": "480523c1-2ef8-4c81-b815-af8c7d0f4fba", "db_language_id": "c0a07177-2a82-4943-952a-5236aa4f289d", "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-07-05T17:34:11.4560368+00:00" }, "modified_dateutc": "2025-07-05T17:34:11.4560368+00:00" }, "equipment_family_id": "0e366075-cc53-4e4d-8615-80ea9da91519", "equipment_family_code": "sample string 8", "equipment_family": { "id": "6dc478a5-7b02-4e8c-88a2-8c98068e8c08", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "c77807c0-5e21-4867-a105-3d57de59f761", "_parent_code": "sample string 6", "sales_organization_id": "8221ee3e-ac49-4548-a498-5024036b7ce9", "sales_organization_code": "sample string 8", "sales_organization": { "id": "ad0a1011-904b-44a1-ad8a-f17d45460a44", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "82b94a61-cffa-4181-8d8c-60a5214c7830", "db_currency_id": "480523c1-2ef8-4c81-b815-af8c7d0f4fba", "db_language_id": "c0a07177-2a82-4943-952a-5236aa4f289d", "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-07-05T17:34:11.4560368+00:00" }, "modified_dateutc": "2025-07-05T17:34:11.4560368+00:00" }, "date_in_production_since": "2025-07-05T17:34:11.4560368+00:00", "date_out_of_production_since": "2025-07-05T17:34:11.4560368+00:00", "date_end_support": "2025-07-05T17:34:11.4716633+00:00", "sales_organization_id": "02ef67ff-eead-4f99-ad4b-30584957abad", "sales_organization_code": "sample string 13", "sales_organization": { "id": "ad0a1011-904b-44a1-ad8a-f17d45460a44", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "82b94a61-cffa-4181-8d8c-60a5214c7830", "db_currency_id": "480523c1-2ef8-4c81-b815-af8c7d0f4fba", "db_language_id": "c0a07177-2a82-4943-952a-5236aa4f289d", "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-07-05T17:34:11.4560368+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-07-05T17:34:11.4716633+00:00" }, "project_status_id": "3eccd6d9-6a1f-4a46-81a4-9828651bd361", "project_status_code": "sample string 10", "project_status": { "id": "bd6e8420-33b8-4e63-a57d-edd602cc0dbc", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "aac05b71-8b07-4237-b163-8c7731748479", "sales_organization_code": "sample string 6", "sales_organization": { "id": "ad0a1011-904b-44a1-ad8a-f17d45460a44", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "82b94a61-cffa-4181-8d8c-60a5214c7830", "db_currency_id": "480523c1-2ef8-4c81-b815-af8c7d0f4fba", "db_language_id": "c0a07177-2a82-4943-952a-5236aa4f289d", "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-07-05T17:34:11.4560368+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-05T17:34:11.4716633+00:00" }, "company_id": "73a4030b-3286-4548-b194-642a60c3899e", "company_code": "sample string 12", "db_address_id": "139827ab-c2f8-49a0-ab0b-24ede937a05c", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "3c16ea62-73da-45d7-9307-9f4dfc0b1ba7", "contact_reference_back_office": "sample string 17", "owner_user_id": "e1f220b6-90f2-4431-a643-f1a7fd55021f", "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-07-05T17:34:11.4716633+00:00", "date_create": "2025-07-05T17:34:11.4716633+00:00", "date_update": "2025-07-05T17:34:11.4716633+00:00", "updated_by_user_id": "55fb7101-4366-44f3-8b2e-63be7a2593c9", "customer_reference": "sample string 28", "warranty_date_until": "2025-07-05T17:34:11.4716633+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-07-05T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-07-05T17:34:11.4716633+00:00", "date_last_job": "2025-07-05T17:34:11.4716633+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-07-05T17:34:11.4716633+00:00", "modified_dateutc": "2025-07-05T17:34:11.4716633+00:00", "is_mobile_installation": true }, "job_type_id": "3d3d730a-9ad1-4163-b3d8-065383c89348", "job_type_code": "sample string 7", "job_type": { "id": "a93ea078-017a-4927-8245-64717d40b2d4", "name": "sample string 2", "sales_organization_id": "8374bfbd-3589-4a42-9276-fc078d80be4d", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-07-05T17:34:11.4716633+00:00", "code": "sample string 7" }, "job_priority_id": "6cb1f4fc-e679-44be-8c81-bf1ca47bc6da", "job_priority_code": "sample string 9", "job_priority": { "id": "599c1e66-ec76-4c6d-a752-4f1d04a960b7", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "5ba84559-dbca-4b8f-bd5b-ea758855760f", "sales_organization_code": "sample string 6", "sales_organization": { "id": "ad0a1011-904b-44a1-ad8a-f17d45460a44", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "82b94a61-cffa-4181-8d8c-60a5214c7830", "db_currency_id": "480523c1-2ef8-4c81-b815-af8c7d0f4fba", "db_language_id": "c0a07177-2a82-4943-952a-5236aa4f289d", "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-07-05T17:34:11.4560368+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-05T17:34:11.4716633+00:00" }, "job_status_id": "bde61bf9-390b-46b0-80f1-de7c0901ca73", "job_status_code": "sample string 11", "db_address_id": "a3fd700d-ae5d-4004-8058-414223425744", "contact_id": "9ae45f7d-ddd5-4b76-8be0-b608500602bd", "requested_by_company_id": "dc76e92d-a54c-4918-b9cb-9548e55d5bd6", "requested_by_contact_id": "32f0b14a-7fc1-4db6-a727-f2e54004fafd", "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-07-05T17:34:11.4716633+00:00", "due_date": "2025-07-05T17:34:11.4716633+00:00", "date_create": "2025-07-05T17:34:11.4716633+00:00", "date_update": "2025-07-05T17:34:11.4716633+00:00", "date_closed": "2025-07-05T17:34:11.4716633+00:00", "suggested_user_id": "74d05073-30ed-4bba-87fc-0a167bbc55ad", "suggested_user_code": "sample string 29", "suggested_user": { "id": "297cc81f-6d89-45b8-843e-2f445a0f670f", "db_language_id": "972b79bd-e1f5-4837-b6ac-eea62ed5494e", "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-07-05T17:34:11.4716633+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "807f4ff5-05f0-47c7-aecc-07d907bcab58", "sales_organization": { "id": "ad0a1011-904b-44a1-ad8a-f17d45460a44", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "82b94a61-cffa-4181-8d8c-60a5214c7830", "db_currency_id": "480523c1-2ef8-4c81-b815-af8c7d0f4fba", "db_language_id": "c0a07177-2a82-4943-952a-5236aa4f289d", "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-07-05T17:34:11.4560368+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "a1512142-32a5-4abd-acd1-fc76999b6c4d", "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": "302bf474-39e2-4c25-b417-e114308aea0e", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-07-05T17:34:11.4716633+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "03fb3d6a-3338-4f67-ab3d-d0c889aa0ad9" }, "suggested_date_start": "2025-07-05T17:34:11.4716633+00:00", "skill_id": "54cfd9bf-c326-46a1-b360-8ba847379456", "skill_code": "sample string 32", "skill": { "id": "c8eb9ad7-d17f-49ec-b60c-7f72c44a00a4", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "5f1bd2e0-f25f-4741-8a03-792a5d7b486e", "sales_organization_code": "sample string 6", "sales_organization": { "id": "ad0a1011-904b-44a1-ad8a-f17d45460a44", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "82b94a61-cffa-4181-8d8c-60a5214c7830", "db_currency_id": "480523c1-2ef8-4c81-b815-af8c7d0f4fba", "db_language_id": "c0a07177-2a82-4943-952a-5236aa4f289d", "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-07-05T17:34:11.4560368+00:00" }, "modified_dateutc": "2025-07-05T17:34:11.4716633+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "70fdd6bf-692a-4f7a-9b0c-160a155ea59a", "date_reported_by_company": "2025-07-05T17:34:11.4716633+00:00", "id2": 36, "company_id": "3aaf8185-2605-4372-9ff7-de7ff98efdbd", "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": "02815152-58df-4663-9e6c-94ab7b6ac32f", "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-07-05T17:34:11.4716633+00:00" }