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": "a5d841a4-5708-4f0b-8aa9-f4fc36c5ac79", "_parent_id": "176e36d2-74af-4c2e-a4a1-bedea41bdd27", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "c7d3202a-a9a4-4e3e-b36b-b3ee0892aacd", "project_reference_back_office": "sample string 5", "project": { "id": "bd6a304f-d89b-4ba3-bd26-e1dad01e2263", "_parent_id": "42a8cf2a-103e-4e5b-94d9-5cbbac902c20", "root_parent_id": "71c23c66-c1f6-4b75-98bc-3e82d270d234", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "7c8b2a9e-cf0e-4679-8aca-f083a1ddb2a1", "equipment_family_code": "sample string 6", "equipment_family": { "id": "d71fbe2c-b40a-4f80-973c-18fff9a125d8", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "c2238604-7d19-4ce6-a471-745ace8aa1cb", "_parent_code": "sample string 6", "sales_organization_id": "8c66c45d-40dc-4bdf-92ee-ef67e6c1c435", "sales_organization_code": "sample string 8", "sales_organization": { "id": "9af4645c-9a2c-49bb-812a-3c9aec6686de", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1140611a-15b2-45e3-bf1a-026171e75447", "db_currency_id": "cf97ce07-a5cb-4773-8527-cb5f9a3627d9", "db_language_id": "647aab65-8b65-4629-b601-43c6f2eea9e8", "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-09-13T22:47:40.8584368+00:00" }, "modified_dateutc": "2025-09-13T22:47:40.8584368+00:00" }, "equipment_model_id": "6e9f286c-5328-492e-bd0e-ea12e8f45d6c", "equipment_model_code": "sample string 8", "equipment_model": { "id": "f4d11e21-f5e4-41d6-9a0f-7fa90523ac4b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "dc9dfea7-cbee-44b5-84cc-640d8e27c9ef", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "f50cab0d-b96a-41dd-8eb6-f83caaf3caaa", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "0b845599-8e1b-40ac-a1b0-64b89462d327", "sales_organization_code": "sample string 5", "sales_organization": { "id": "9af4645c-9a2c-49bb-812a-3c9aec6686de", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1140611a-15b2-45e3-bf1a-026171e75447", "db_currency_id": "cf97ce07-a5cb-4773-8527-cb5f9a3627d9", "db_language_id": "647aab65-8b65-4629-b601-43c6f2eea9e8", "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-09-13T22:47:40.8584368+00:00" }, "modified_dateutc": "2025-09-13T22:47:40.8584368+00:00" }, "equipment_family_id": "be2e711a-756d-44a0-b07c-141b276c3769", "equipment_family_code": "sample string 8", "equipment_family": { "id": "d71fbe2c-b40a-4f80-973c-18fff9a125d8", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "c2238604-7d19-4ce6-a471-745ace8aa1cb", "_parent_code": "sample string 6", "sales_organization_id": "8c66c45d-40dc-4bdf-92ee-ef67e6c1c435", "sales_organization_code": "sample string 8", "sales_organization": { "id": "9af4645c-9a2c-49bb-812a-3c9aec6686de", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1140611a-15b2-45e3-bf1a-026171e75447", "db_currency_id": "cf97ce07-a5cb-4773-8527-cb5f9a3627d9", "db_language_id": "647aab65-8b65-4629-b601-43c6f2eea9e8", "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-09-13T22:47:40.8584368+00:00" }, "modified_dateutc": "2025-09-13T22:47:40.8584368+00:00" }, "date_in_production_since": "2025-09-13T22:47:40.8584368+00:00", "date_out_of_production_since": "2025-09-13T22:47:40.8584368+00:00", "date_end_support": "2025-09-13T22:47:40.8584368+00:00", "sales_organization_id": "a2a03e65-7d48-48dc-bec1-181803dbd3e7", "sales_organization_code": "sample string 13", "sales_organization": { "id": "9af4645c-9a2c-49bb-812a-3c9aec6686de", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1140611a-15b2-45e3-bf1a-026171e75447", "db_currency_id": "cf97ce07-a5cb-4773-8527-cb5f9a3627d9", "db_language_id": "647aab65-8b65-4629-b601-43c6f2eea9e8", "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-09-13T22:47:40.8584368+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-09-13T22:47:40.8584368+00:00" }, "project_status_id": "961d51ea-607f-4178-a041-06547b682c55", "project_status_code": "sample string 10", "project_status": { "id": "450f8c76-474c-43d5-83fb-150c72685ff3", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "76d67383-c200-4220-b55e-b028b02103ff", "sales_organization_code": "sample string 6", "sales_organization": { "id": "9af4645c-9a2c-49bb-812a-3c9aec6686de", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1140611a-15b2-45e3-bf1a-026171e75447", "db_currency_id": "cf97ce07-a5cb-4773-8527-cb5f9a3627d9", "db_language_id": "647aab65-8b65-4629-b601-43c6f2eea9e8", "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-09-13T22:47:40.8584368+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-09-13T22:47:40.8584368+00:00" }, "company_id": "5210528f-9878-4da7-98af-b2af00d339f7", "company_code": "sample string 12", "db_address_id": "696eece2-593f-421c-a8f7-49f80bc63f61", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "4573544d-050b-4acb-9fed-c2d76ba9d768", "contact_reference_back_office": "sample string 17", "owner_user_id": "255486b8-35a4-4e0a-82fc-96a770345a1c", "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-09-13T22:47:40.8584368+00:00", "date_create": "2025-09-13T22:47:40.8584368+00:00", "date_update": "2025-09-13T22:47:40.8584368+00:00", "updated_by_user_id": "af5ffcd5-faee-4a24-946e-4e570a1412a4", "customer_reference": "sample string 28", "warranty_date_until": "2025-09-13T22:47:40.8584368+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-09-13T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-09-13T22:47:40.8584368+00:00", "date_last_job": "2025-09-13T22:47:40.8584368+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-09-13T22:47:40.8584368+00:00", "modified_dateutc": "2025-09-13T22:47:40.8584368+00:00", "is_mobile_installation": true }, "job_type_id": "d9d4c343-4af9-4bd1-a198-b4df92f7f943", "job_type_code": "sample string 7", "job_type": { "id": "0bb6349c-f3f7-4571-b306-1280234af9a5", "name": "sample string 2", "sales_organization_id": "f9e156ac-604e-45b2-bd7a-de2c03b50bf0", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-09-13T22:47:40.8584368+00:00", "code": "sample string 7" }, "job_priority_id": "144639b6-2822-4a72-bc0c-3f17314b9a24", "job_priority_code": "sample string 9", "job_priority": { "id": "70e298a2-a0e4-4a3c-a179-8983c8bba399", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "30a7bf2f-db1c-4e0c-aa44-9c333c47482d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "9af4645c-9a2c-49bb-812a-3c9aec6686de", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1140611a-15b2-45e3-bf1a-026171e75447", "db_currency_id": "cf97ce07-a5cb-4773-8527-cb5f9a3627d9", "db_language_id": "647aab65-8b65-4629-b601-43c6f2eea9e8", "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-09-13T22:47:40.8584368+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-09-13T22:47:40.8584368+00:00" }, "job_status_id": "fab99572-1cac-4573-abcd-8aa78cb6b38c", "job_status_code": "sample string 11", "db_address_id": "2ccf73c2-48c7-4c7f-b709-b3d5cdebce0b", "contact_id": "fb2f812d-e044-4735-9f7a-9f1d45114745", "requested_by_company_id": "1f7dd190-ec3f-42f2-9695-7b52f81a8252", "requested_by_contact_id": "4f47e9c1-c1fd-4890-8976-3d36efc23cf4", "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-09-13T22:47:40.8584368+00:00", "due_date": "2025-09-13T22:47:40.8584368+00:00", "date_create": "2025-09-13T22:47:40.8584368+00:00", "date_update": "2025-09-13T22:47:40.8584368+00:00", "date_closed": "2025-09-13T22:47:40.8584368+00:00", "suggested_user_id": "5e50d9b8-f6a4-4580-b008-b10fa810bde7", "suggested_user_code": "sample string 29", "suggested_user": { "id": "ff5cb930-54cf-4fe8-8c13-3d81f3223ba5", "db_language_id": "80d29101-cb88-46cc-9363-e3f8b1083716", "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-09-13T22:47:40.8584368+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "e5b42047-0436-43e5-ae12-6785ed55ad45", "sales_organization": { "id": "9af4645c-9a2c-49bb-812a-3c9aec6686de", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1140611a-15b2-45e3-bf1a-026171e75447", "db_currency_id": "cf97ce07-a5cb-4773-8527-cb5f9a3627d9", "db_language_id": "647aab65-8b65-4629-b601-43c6f2eea9e8", "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-09-13T22:47:40.8584368+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "11ffb862-b08b-4afc-9e26-afe208eaffa0", "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": "bd4d71a0-285b-4061-9f98-209d5bbebe75", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-09-13T22:47:40.8584368+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "421c0069-5b86-4f12-98fd-7663a6bdd6ba" }, "suggested_date_start": "2025-09-13T22:47:40.8584368+00:00", "skill_id": "d531f8f8-53c5-4704-a188-090cf86d6cd7", "skill_code": "sample string 32", "skill": { "id": "d9c6a1d3-f169-4495-a203-90303a233a20", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "055d2119-e2e3-4a40-94ee-cca584a3cc2b", "sales_organization_code": "sample string 6", "sales_organization": { "id": "9af4645c-9a2c-49bb-812a-3c9aec6686de", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1140611a-15b2-45e3-bf1a-026171e75447", "db_currency_id": "cf97ce07-a5cb-4773-8527-cb5f9a3627d9", "db_language_id": "647aab65-8b65-4629-b601-43c6f2eea9e8", "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-09-13T22:47:40.8584368+00:00" }, "modified_dateutc": "2025-09-13T22:47:40.8584368+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "e9ff5c40-81e7-4e97-8c08-2d7afbcf3d6f", "date_reported_by_company": "2025-09-13T22:47:40.8584368+00:00", "id2": 36, "company_id": "20f99671-8b63-4bb2-b7ca-d83a1e587b5d", "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": "d4d91be5-d6af-4914-ac27-c0d415d38280", "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-09-13T22:47:40.8584368+00:00" }