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": "75cde235-1d29-4374-ad53-a5e21817dd9b", "_parent_id": "228fcd78-9a96-4559-ac7b-88afe91a2605", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "6d7f1031-0b71-4d9f-8be6-3166ed808d9d", "project_reference_back_office": "sample string 5", "project": { "id": "ddfbb61c-5e46-480b-8676-bbabe5652f68", "_parent_id": "e61a208c-42f3-4d77-b71f-cd246eb0d2cb", "root_parent_id": "3c7aafea-829b-42d4-8c2f-158b02c24eba", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "98af70b3-7f62-4137-89b5-ff299c96d1ee", "equipment_family_code": "sample string 6", "equipment_family": { "id": "6f051b87-d62f-45d6-a64a-6d4df4f62f2c", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "6cacd5ca-278b-4ee6-ab5e-28ae9db86b30", "_parent_code": "sample string 6", "sales_organization_id": "61159911-0900-4a89-9d51-bf0c7b4a0cb4", "sales_organization_code": "sample string 8", "sales_organization": { "id": "a8f2b30a-789e-4141-9529-3dc9af26752e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b6f4ea65-3186-434c-971a-0cdcec3b6141", "db_currency_id": "2e9e4f41-6c36-44e8-a8d4-02bbeaabc901", "db_language_id": "420a2036-b1de-48c8-aae2-2848ea3a401b", "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-16T11:13:11.4479763+00:00" }, "modified_dateutc": "2025-10-16T11:13:11.4479763+00:00" }, "equipment_model_id": "7c189b37-5737-44a4-9258-81d03d9e1f6f", "equipment_model_code": "sample string 8", "equipment_model": { "id": "e73301b3-e8cd-4465-a22b-2785e8ef2a1d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "ce414212-33d0-433a-b713-6a1ae5e02cdd", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "bd67d5c0-505e-46c8-8143-2080d2320b7b", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "bec0f810-8cb7-4b1e-a660-47c8622ed891", "sales_organization_code": "sample string 5", "sales_organization": { "id": "a8f2b30a-789e-4141-9529-3dc9af26752e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b6f4ea65-3186-434c-971a-0cdcec3b6141", "db_currency_id": "2e9e4f41-6c36-44e8-a8d4-02bbeaabc901", "db_language_id": "420a2036-b1de-48c8-aae2-2848ea3a401b", "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-16T11:13:11.4479763+00:00" }, "modified_dateutc": "2025-10-16T11:13:11.4479763+00:00" }, "equipment_family_id": "cbc2edd1-64a6-4e72-996b-3a2d32ad67e4", "equipment_family_code": "sample string 8", "equipment_family": { "id": "6f051b87-d62f-45d6-a64a-6d4df4f62f2c", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "6cacd5ca-278b-4ee6-ab5e-28ae9db86b30", "_parent_code": "sample string 6", "sales_organization_id": "61159911-0900-4a89-9d51-bf0c7b4a0cb4", "sales_organization_code": "sample string 8", "sales_organization": { "id": "a8f2b30a-789e-4141-9529-3dc9af26752e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b6f4ea65-3186-434c-971a-0cdcec3b6141", "db_currency_id": "2e9e4f41-6c36-44e8-a8d4-02bbeaabc901", "db_language_id": "420a2036-b1de-48c8-aae2-2848ea3a401b", "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-16T11:13:11.4479763+00:00" }, "modified_dateutc": "2025-10-16T11:13:11.4479763+00:00" }, "date_in_production_since": "2025-10-16T11:13:11.4479763+00:00", "date_out_of_production_since": "2025-10-16T11:13:11.4479763+00:00", "date_end_support": "2025-10-16T11:13:11.4479763+00:00", "sales_organization_id": "da18ec34-368a-4397-af70-5c0717c7a8d1", "sales_organization_code": "sample string 13", "sales_organization": { "id": "a8f2b30a-789e-4141-9529-3dc9af26752e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b6f4ea65-3186-434c-971a-0cdcec3b6141", "db_currency_id": "2e9e4f41-6c36-44e8-a8d4-02bbeaabc901", "db_language_id": "420a2036-b1de-48c8-aae2-2848ea3a401b", "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-16T11:13:11.4479763+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-16T11:13:11.4479763+00:00" }, "project_status_id": "0cdf2777-0702-4af4-8b7b-ac9f3223cbc0", "project_status_code": "sample string 10", "project_status": { "id": "b6625e4c-f1f2-4f01-92a9-738a8717beb8", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "44affcfa-b94f-424a-85f4-433676263f66", "sales_organization_code": "sample string 6", "sales_organization": { "id": "a8f2b30a-789e-4141-9529-3dc9af26752e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b6f4ea65-3186-434c-971a-0cdcec3b6141", "db_currency_id": "2e9e4f41-6c36-44e8-a8d4-02bbeaabc901", "db_language_id": "420a2036-b1de-48c8-aae2-2848ea3a401b", "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-16T11:13:11.4479763+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-16T11:13:11.4479763+00:00" }, "company_id": "00721c5c-9aa3-442b-8e8d-75aa205e8025", "company_code": "sample string 12", "db_address_id": "75fdeda5-1b84-48bf-a07b-509054c3fa95", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "949ceee5-40d2-4b43-b6b4-0fe995584412", "contact_reference_back_office": "sample string 17", "owner_user_id": "92b47a6c-b0b4-47ee-b041-2dd0ad80160c", "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-16T11:13:11.4479763+00:00", "date_create": "2025-10-16T11:13:11.4479763+00:00", "date_update": "2025-10-16T11:13:11.4479763+00:00", "updated_by_user_id": "4fc0773e-5f23-428d-9e13-8bf22ed34b3c", "customer_reference": "sample string 28", "warranty_date_until": "2025-10-16T11:13:11.4479763+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-16T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-10-16T11:13:11.4479763+00:00", "date_last_job": "2025-10-16T11:13:11.4479763+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-10-16T11:13:11.4479763+00:00", "modified_dateutc": "2025-10-16T11:13:11.4479763+00:00", "is_mobile_installation": true }, "job_type_id": "0953b888-d587-4ea8-9253-cc83eb7d4190", "job_type_code": "sample string 7", "job_type": { "id": "f835a890-c509-49d3-8cfe-0430f69da24c", "name": "sample string 2", "sales_organization_id": "756e9b9e-0a86-4918-93f9-fd4f5ad4344e", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-10-16T11:13:11.4635983+00:00", "code": "sample string 7" }, "job_priority_id": "38f85ec6-3bdf-4c87-b749-73c75ef9d547", "job_priority_code": "sample string 9", "job_priority": { "id": "ce46a017-4415-4759-995d-15a7f3765f2b", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "e2394549-bf8b-4cb4-af72-76cbd62d35e2", "sales_organization_code": "sample string 6", "sales_organization": { "id": "a8f2b30a-789e-4141-9529-3dc9af26752e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b6f4ea65-3186-434c-971a-0cdcec3b6141", "db_currency_id": "2e9e4f41-6c36-44e8-a8d4-02bbeaabc901", "db_language_id": "420a2036-b1de-48c8-aae2-2848ea3a401b", "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-16T11:13:11.4479763+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-16T11:13:11.4635983+00:00" }, "job_status_id": "194eb8d5-25ee-463f-aa09-f463913b1802", "job_status_code": "sample string 11", "db_address_id": "22309850-af52-4772-b88d-4b3484817730", "contact_id": "2b88f8e8-7003-454c-a1ef-7eb210f67a43", "requested_by_company_id": "fd95b56a-8a11-419c-9585-fc9aae254303", "requested_by_contact_id": "4ba84589-7265-44eb-a943-41d61e2e601f", "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-16T11:13:11.4635983+00:00", "due_date": "2025-10-16T11:13:11.4635983+00:00", "date_create": "2025-10-16T11:13:11.4635983+00:00", "date_update": "2025-10-16T11:13:11.4635983+00:00", "date_closed": "2025-10-16T11:13:11.4635983+00:00", "suggested_user_id": "dbf694a3-7d5c-44f7-9224-03ff889b125c", "suggested_user_code": "sample string 29", "suggested_user": { "id": "8c11c26b-7ee7-4b1a-a411-76d957a80df4", "db_language_id": "efe00fbf-cf33-4474-90bd-3dfcbc79bac7", "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-16T11:13:11.4635983+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "69be78b2-5bf2-4761-bf21-a2438f8ca285", "sales_organization": { "id": "a8f2b30a-789e-4141-9529-3dc9af26752e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b6f4ea65-3186-434c-971a-0cdcec3b6141", "db_currency_id": "2e9e4f41-6c36-44e8-a8d4-02bbeaabc901", "db_language_id": "420a2036-b1de-48c8-aae2-2848ea3a401b", "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-16T11:13:11.4479763+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "43b544fe-9dcb-4d37-939e-549db54ce632", "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": "3ba03df1-da36-4a51-9d80-c5df3b96932b", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-10-16T11:13:11.4635983+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "7695e04d-3999-4e3c-a826-b6b375ac7679" }, "suggested_date_start": "2025-10-16T11:13:11.4635983+00:00", "skill_id": "2921acef-5af5-40dc-98d5-855c382e0515", "skill_code": "sample string 32", "skill": { "id": "ee292c19-435f-44d1-99d9-d44f3040db4d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "d8374adf-716f-466b-8497-2a45fbf30815", "sales_organization_code": "sample string 6", "sales_organization": { "id": "a8f2b30a-789e-4141-9529-3dc9af26752e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b6f4ea65-3186-434c-971a-0cdcec3b6141", "db_currency_id": "2e9e4f41-6c36-44e8-a8d4-02bbeaabc901", "db_language_id": "420a2036-b1de-48c8-aae2-2848ea3a401b", "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-16T11:13:11.4479763+00:00" }, "modified_dateutc": "2025-10-16T11:13:11.4635983+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "006fe57d-cf07-4b64-ad04-a4e5216c0f51", "date_reported_by_company": "2025-10-16T11:13:11.4635983+00:00", "id2": 36, "company_id": "91ff7338-ed22-41cd-a439-cf1b8b00be34", "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": "1055fc76-8f3d-4f89-8190-f52f925cfafb", "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-16T11:13:11.4635983+00:00" }