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": "ef56a477-f9c3-4d64-aff2-6081c01ec5d3", "_parent_id": "4cf9aa1c-7cc5-494f-85ef-29ab27931141", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "667ed3ca-b2ee-4760-865f-69a7c18b8b3c", "project_reference_back_office": "sample string 5", "project": { "id": "f3f2fd72-8f98-4f8d-9780-135433fabfcc", "_parent_id": "77d781b5-9636-497c-85d0-407234bd6999", "root_parent_id": "f0d89acf-dd0c-4944-b697-81efb42d403f", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "4bc12166-771c-417b-bdc0-051ffd74e1a9", "equipment_family_code": "sample string 6", "equipment_family": { "id": "5859a05f-8a0a-463c-97f0-de53f4b97a40", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "af74cbff-e934-4e1b-99f2-23b2b754d34a", "_parent_code": "sample string 6", "sales_organization_id": "d22910fb-255c-4f60-9e06-51b298d4018a", "sales_organization_code": "sample string 8", "sales_organization": { "id": "00f19359-fbbd-4fe5-91ec-de922dcd2566", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8d278be8-95d9-482b-a2a5-9116698b0b02", "db_currency_id": "82e9c329-5da4-4d0d-a41a-418bceeee16f", "db_language_id": "d542a12b-23f9-4bb7-80fb-1a045a6dcc55", "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-01-02T06:50:47.4465844+00:00" }, "modified_dateutc": "2025-01-02T06:50:47.4465844+00:00" }, "equipment_model_id": "9ddef33f-82ed-417c-92eb-d513f18cc258", "equipment_model_code": "sample string 8", "equipment_model": { "id": "85c464c6-022c-496e-8905-7f3002cf37e0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "20d39d9b-cd99-4b30-8cf8-48be311c85dd", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "96970271-78d3-4140-ace9-9a3e29ba9150", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "3f39d6c2-0c6a-41a4-ba6b-cc6a9ae6f2a2", "sales_organization_code": "sample string 5", "sales_organization": { "id": "00f19359-fbbd-4fe5-91ec-de922dcd2566", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8d278be8-95d9-482b-a2a5-9116698b0b02", "db_currency_id": "82e9c329-5da4-4d0d-a41a-418bceeee16f", "db_language_id": "d542a12b-23f9-4bb7-80fb-1a045a6dcc55", "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-01-02T06:50:47.4465844+00:00" }, "modified_dateutc": "2025-01-02T06:50:47.4465844+00:00" }, "equipment_family_id": "d500141b-b3d2-4bf3-9700-b0b902e12484", "equipment_family_code": "sample string 8", "equipment_family": { "id": "5859a05f-8a0a-463c-97f0-de53f4b97a40", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "af74cbff-e934-4e1b-99f2-23b2b754d34a", "_parent_code": "sample string 6", "sales_organization_id": "d22910fb-255c-4f60-9e06-51b298d4018a", "sales_organization_code": "sample string 8", "sales_organization": { "id": "00f19359-fbbd-4fe5-91ec-de922dcd2566", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8d278be8-95d9-482b-a2a5-9116698b0b02", "db_currency_id": "82e9c329-5da4-4d0d-a41a-418bceeee16f", "db_language_id": "d542a12b-23f9-4bb7-80fb-1a045a6dcc55", "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-01-02T06:50:47.4465844+00:00" }, "modified_dateutc": "2025-01-02T06:50:47.4465844+00:00" }, "date_in_production_since": "2025-01-02T06:50:47.4465844+00:00", "date_out_of_production_since": "2025-01-02T06:50:47.4465844+00:00", "date_end_support": "2025-01-02T06:50:47.4465844+00:00", "sales_organization_id": "6ea421fe-c57b-4280-878c-e62bb0d3656b", "sales_organization_code": "sample string 13", "sales_organization": { "id": "00f19359-fbbd-4fe5-91ec-de922dcd2566", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8d278be8-95d9-482b-a2a5-9116698b0b02", "db_currency_id": "82e9c329-5da4-4d0d-a41a-418bceeee16f", "db_language_id": "d542a12b-23f9-4bb7-80fb-1a045a6dcc55", "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-01-02T06:50:47.4465844+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-01-02T06:50:47.4465844+00:00" }, "project_status_id": "d23c267e-a58d-4ea4-bd9e-c05fafa881a2", "project_status_code": "sample string 10", "project_status": { "id": "4727bbce-1e9c-484c-b7f8-5976bc868aab", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "1b76237a-0ad9-4d2a-9d34-444096960fbf", "sales_organization_code": "sample string 6", "sales_organization": { "id": "00f19359-fbbd-4fe5-91ec-de922dcd2566", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8d278be8-95d9-482b-a2a5-9116698b0b02", "db_currency_id": "82e9c329-5da4-4d0d-a41a-418bceeee16f", "db_language_id": "d542a12b-23f9-4bb7-80fb-1a045a6dcc55", "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-01-02T06:50:47.4465844+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-01-02T06:50:47.4465844+00:00" }, "company_id": "8b178c20-73c1-4d5e-be53-95cb2a51a8a2", "company_code": "sample string 12", "db_address_id": "729fd50b-4e72-4f3b-b750-bd5a09a16eac", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "4c7341f3-86a4-4c49-860f-dcfc316732e7", "contact_reference_back_office": "sample string 17", "owner_user_id": "5d27ae61-05ce-4b65-a6ba-285489f2a9cb", "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-01-02T06:50:47.4465844+00:00", "date_create": "2025-01-02T06:50:47.4465844+00:00", "date_update": "2025-01-02T06:50:47.4465844+00:00", "updated_by_user_id": "6e28a7e9-9066-4c3c-a3c1-b115edaeaad8", "customer_reference": "sample string 28", "warranty_date_until": "2025-01-02T06:50:47.4465844+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-01-02T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-01-02T06:50:47.4465844+00:00", "date_last_job": "2025-01-02T06:50:47.4465844+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-01-02T06:50:47.4465844+00:00", "modified_dateutc": "2025-01-02T06:50:47.4465844+00:00", "is_mobile_installation": true }, "job_type_id": "2f667133-1565-4045-9c7d-3517ea7fe1fc", "job_type_code": "sample string 7", "job_type": { "id": "deba1025-e237-4258-af77-e14ec8af284e", "name": "sample string 2", "sales_organization_id": "1033b3b8-bc84-447b-96c1-739dae661152", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-01-02T06:50:47.4465844+00:00", "code": "sample string 7" }, "job_priority_id": "6895e885-78bd-4173-b15f-23ceb69a2866", "job_priority_code": "sample string 9", "job_priority": { "id": "67f7e9cb-ee91-45fa-8575-ee1ccc43faff", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "b9e202e4-3373-49c7-9699-8efc4937b5b5", "sales_organization_code": "sample string 6", "sales_organization": { "id": "00f19359-fbbd-4fe5-91ec-de922dcd2566", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8d278be8-95d9-482b-a2a5-9116698b0b02", "db_currency_id": "82e9c329-5da4-4d0d-a41a-418bceeee16f", "db_language_id": "d542a12b-23f9-4bb7-80fb-1a045a6dcc55", "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-01-02T06:50:47.4465844+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-01-02T06:50:47.4465844+00:00" }, "job_status_id": "ddbe1ff8-e8e9-4a23-b12d-2716ad2cf7ad", "job_status_code": "sample string 11", "db_address_id": "2a189981-c2f1-49d1-8100-4f1c26801107", "contact_id": "aa40881b-136e-4c22-bfac-87760d5a0dbd", "requested_by_company_id": "2385d423-a4cc-4592-92b4-fc516cec6de0", "requested_by_contact_id": "f48e017c-c799-42a1-af37-bb3cded96ab0", "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-01-02T06:50:47.4465844+00:00", "due_date": "2025-01-02T06:50:47.4465844+00:00", "date_create": "2025-01-02T06:50:47.4465844+00:00", "date_update": "2025-01-02T06:50:47.4465844+00:00", "date_closed": "2025-01-02T06:50:47.4465844+00:00", "suggested_user_id": "419f6248-b5b8-4721-8e81-cda95a0e63bd", "suggested_user_code": "sample string 29", "suggested_user": { "id": "adc6b573-24a4-4dcd-92be-d511e64bec29", "db_language_id": "7099bc28-bb9a-403b-a539-afad34bbd81f", "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-01-02T06:50:47.4465844+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "305fcb4c-a631-4ffd-8aa2-216afd7a8607", "sales_organization": { "id": "00f19359-fbbd-4fe5-91ec-de922dcd2566", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8d278be8-95d9-482b-a2a5-9116698b0b02", "db_currency_id": "82e9c329-5da4-4d0d-a41a-418bceeee16f", "db_language_id": "d542a12b-23f9-4bb7-80fb-1a045a6dcc55", "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-01-02T06:50:47.4465844+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "fa1c610a-6e9d-46ba-9794-01d88d4faa8a", "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": "eb782a9a-082b-46e5-a576-9097db42e4e3", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-01-02T06:50:47.4465844+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "456b7659-b002-4c34-aecd-4212594c45ed" }, "suggested_date_start": "2025-01-02T06:50:47.4465844+00:00", "skill_id": "86f8d9e2-37ad-408a-bb11-68d56c225e41", "skill_code": "sample string 32", "skill": { "id": "274cb24c-972c-42c3-83b6-02f69cf66123", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "85f5dec3-4bf1-447f-ad7a-1a51537266b4", "sales_organization_code": "sample string 6", "sales_organization": { "id": "00f19359-fbbd-4fe5-91ec-de922dcd2566", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8d278be8-95d9-482b-a2a5-9116698b0b02", "db_currency_id": "82e9c329-5da4-4d0d-a41a-418bceeee16f", "db_language_id": "d542a12b-23f9-4bb7-80fb-1a045a6dcc55", "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-01-02T06:50:47.4465844+00:00" }, "modified_dateutc": "2025-01-02T06:50:47.4465844+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "4243c53b-5d16-41b7-a74b-18d07453baaa", "date_reported_by_company": "2025-01-02T06:50:47.4465844+00:00", "id2": 36, "company_id": "dcd6bfa2-d5a4-4d36-a434-c0a6f92f72d0", "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": "dfcd19f9-d276-40a9-957f-728b6eef794d", "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-01-02T06:50:47.4465844+00:00" }