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": "406f8994-4b29-4b50-abae-e78d6359ef5d", "_parent_id": "220b4f22-1c6d-4217-90a7-e2dcb523993c", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "ffd9b6e9-39ec-4c98-9d88-96b3c7075d18", "project_reference_back_office": "sample string 5", "project": { "id": "be97cb88-2de6-4363-a6b0-9c753620278f", "_parent_id": "da6f0f7c-b7b3-4127-9a54-8e13521794da", "root_parent_id": "83a6425d-8809-469f-8df0-58046119b3d2", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "ef7a98e2-6a14-4496-a2e9-d85a63cc31fc", "equipment_family_code": "sample string 6", "equipment_family": { "id": "6d32c4e5-2a87-47fb-80ba-181a68e0d061", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "a819a815-0541-403b-8c1a-b015a8a849cc", "_parent_code": "sample string 6", "sales_organization_id": "59caaedd-560c-41e2-ad6e-7bb00067b03f", "sales_organization_code": "sample string 8", "sales_organization": { "id": "9cb3825d-49aa-4fba-8b6e-5416cb072d87", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2b41cc4d-003e-440c-9c0b-59e236cf9531", "db_currency_id": "d5afbb43-eb5b-4600-baa2-3f2d748d754e", "db_language_id": "3770b401-7632-43cd-97b7-02b372844558", "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-08T18:24:37.3089212+00:00" }, "modified_dateutc": "2025-10-08T18:24:37.3089212+00:00" }, "equipment_model_id": "25365212-0773-408f-8dd2-5b990e31a94c", "equipment_model_code": "sample string 8", "equipment_model": { "id": "d8b99acd-7bec-4a35-8d4e-a9f6a11928cb", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "6d41761e-1dac-44b4-b117-7bc9eeaa2554", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "8a507005-0630-43d4-aa43-122c116a566a", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "33576500-1d4a-420f-90b2-03d061ca1b0a", "sales_organization_code": "sample string 5", "sales_organization": { "id": "9cb3825d-49aa-4fba-8b6e-5416cb072d87", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2b41cc4d-003e-440c-9c0b-59e236cf9531", "db_currency_id": "d5afbb43-eb5b-4600-baa2-3f2d748d754e", "db_language_id": "3770b401-7632-43cd-97b7-02b372844558", "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-08T18:24:37.3089212+00:00" }, "modified_dateutc": "2025-10-08T18:24:37.3089212+00:00" }, "equipment_family_id": "fbe3eee1-aae3-43ae-804c-8a029027362e", "equipment_family_code": "sample string 8", "equipment_family": { "id": "6d32c4e5-2a87-47fb-80ba-181a68e0d061", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "a819a815-0541-403b-8c1a-b015a8a849cc", "_parent_code": "sample string 6", "sales_organization_id": "59caaedd-560c-41e2-ad6e-7bb00067b03f", "sales_organization_code": "sample string 8", "sales_organization": { "id": "9cb3825d-49aa-4fba-8b6e-5416cb072d87", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2b41cc4d-003e-440c-9c0b-59e236cf9531", "db_currency_id": "d5afbb43-eb5b-4600-baa2-3f2d748d754e", "db_language_id": "3770b401-7632-43cd-97b7-02b372844558", "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-08T18:24:37.3089212+00:00" }, "modified_dateutc": "2025-10-08T18:24:37.3089212+00:00" }, "date_in_production_since": "2025-10-08T18:24:37.3089212+00:00", "date_out_of_production_since": "2025-10-08T18:24:37.3089212+00:00", "date_end_support": "2025-10-08T18:24:37.3089212+00:00", "sales_organization_id": "52dc5caf-aa28-4eb1-b2df-1d99dbd61ebc", "sales_organization_code": "sample string 13", "sales_organization": { "id": "9cb3825d-49aa-4fba-8b6e-5416cb072d87", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2b41cc4d-003e-440c-9c0b-59e236cf9531", "db_currency_id": "d5afbb43-eb5b-4600-baa2-3f2d748d754e", "db_language_id": "3770b401-7632-43cd-97b7-02b372844558", "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-08T18:24:37.3089212+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-08T18:24:37.3089212+00:00" }, "project_status_id": "7de894e1-be9d-40a9-8d80-222d958c0456", "project_status_code": "sample string 10", "project_status": { "id": "c7d58db8-d35d-4262-8c16-c32120df97f5", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "62bbfeb6-c714-4efe-8026-831d487deda6", "sales_organization_code": "sample string 6", "sales_organization": { "id": "9cb3825d-49aa-4fba-8b6e-5416cb072d87", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2b41cc4d-003e-440c-9c0b-59e236cf9531", "db_currency_id": "d5afbb43-eb5b-4600-baa2-3f2d748d754e", "db_language_id": "3770b401-7632-43cd-97b7-02b372844558", "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-08T18:24:37.3089212+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-08T18:24:37.3089212+00:00" }, "company_id": "b07e18d6-41e8-4679-9c80-5b7589eca4f5", "company_code": "sample string 12", "db_address_id": "3a505bf5-1b4d-4f0a-ac4d-e61aa7a18389", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "86988221-fb69-460a-8696-bf8f6da0c18e", "contact_reference_back_office": "sample string 17", "owner_user_id": "7d81c4c8-c832-48a9-bf74-bcbb5d54a017", "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-08T18:24:37.3089212+00:00", "date_create": "2025-10-08T18:24:37.3089212+00:00", "date_update": "2025-10-08T18:24:37.3089212+00:00", "updated_by_user_id": "f5ca8611-c3ee-4f00-92a3-95e935bfb28b", "customer_reference": "sample string 28", "warranty_date_until": "2025-10-08T18:24:37.3089212+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-08T18:24:37.3089212+00:00", "date_last_job": "2025-10-08T18:24:37.3089212+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-10-08T18:24:37.3089212+00:00", "modified_dateutc": "2025-10-08T18:24:37.3089212+00:00", "is_mobile_installation": true }, "job_type_id": "2abc222c-696e-41d6-985c-85a4cb3c99a3", "job_type_code": "sample string 7", "job_type": { "id": "78e68d89-16f4-43dd-a957-ed33a54ce09b", "name": "sample string 2", "sales_organization_id": "ce60ee7c-478d-4446-89fa-d96e3056ef4d", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-10-08T18:24:37.3089212+00:00", "code": "sample string 7" }, "job_priority_id": "eb0df733-d419-42a6-9593-bc0d7e4c59f8", "job_priority_code": "sample string 9", "job_priority": { "id": "c2aaef2a-e454-4025-8cd0-0280163ded47", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "86c2b375-a1ba-43a7-a163-10938aa88e18", "sales_organization_code": "sample string 6", "sales_organization": { "id": "9cb3825d-49aa-4fba-8b6e-5416cb072d87", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2b41cc4d-003e-440c-9c0b-59e236cf9531", "db_currency_id": "d5afbb43-eb5b-4600-baa2-3f2d748d754e", "db_language_id": "3770b401-7632-43cd-97b7-02b372844558", "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-08T18:24:37.3089212+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-08T18:24:37.3089212+00:00" }, "job_status_id": "9e777f2e-af38-4e0b-a498-a0b9eef7d368", "job_status_code": "sample string 11", "db_address_id": "034a4c38-2bc4-4349-ba01-35ab6800112c", "contact_id": "242926b2-8e66-4905-8526-b6e925ef674b", "requested_by_company_id": "5bb6d7e5-6e15-4202-a01d-89f8ea590ac5", "requested_by_contact_id": "dfc90e82-dabf-4168-a7d5-93d60b961ae7", "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-08T18:24:37.3089212+00:00", "due_date": "2025-10-08T18:24:37.3089212+00:00", "date_create": "2025-10-08T18:24:37.3089212+00:00", "date_update": "2025-10-08T18:24:37.3089212+00:00", "date_closed": "2025-10-08T18:24:37.3089212+00:00", "suggested_user_id": "522a990f-c600-4e46-a0b7-99fb60910b61", "suggested_user_code": "sample string 29", "suggested_user": { "id": "7fc424ae-d6de-4ba2-b140-c81d6536b8db", "db_language_id": "59eb2479-39fc-416b-96c7-bcbd41398c6c", "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-08T18:24:37.3089212+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "0feeef15-2f5e-4ced-8c99-cfe2b5a9f5e5", "sales_organization": { "id": "9cb3825d-49aa-4fba-8b6e-5416cb072d87", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2b41cc4d-003e-440c-9c0b-59e236cf9531", "db_currency_id": "d5afbb43-eb5b-4600-baa2-3f2d748d754e", "db_language_id": "3770b401-7632-43cd-97b7-02b372844558", "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-08T18:24:37.3089212+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "2a589401-369e-45d5-89b3-9e6285466a85", "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": "8a2aae9d-6d71-44b3-a6e1-e96350480186", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-10-08T18:24:37.3089212+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "77412997-1e91-4332-b35b-0df5b3d22da2" }, "suggested_date_start": "2025-10-08T18:24:37.3089212+00:00", "skill_id": "b7cf7bca-0931-4d64-87a7-83e3895ce138", "skill_code": "sample string 32", "skill": { "id": "b8b2e1a1-2852-43b3-b97a-8629c26abf5c", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "b36a2924-636b-44e5-b5e1-c148604232a8", "sales_organization_code": "sample string 6", "sales_organization": { "id": "9cb3825d-49aa-4fba-8b6e-5416cb072d87", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2b41cc4d-003e-440c-9c0b-59e236cf9531", "db_currency_id": "d5afbb43-eb5b-4600-baa2-3f2d748d754e", "db_language_id": "3770b401-7632-43cd-97b7-02b372844558", "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-08T18:24:37.3089212+00:00" }, "modified_dateutc": "2025-10-08T18:24:37.3089212+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "be90da70-55f8-43f1-89e0-1c6553adccfc", "date_reported_by_company": "2025-10-08T18:24:37.3089212+00:00", "id2": 36, "company_id": "2d62f1da-dd6d-4e88-a7c2-5129812c06cc", "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": "7d2900d3-f6ee-451a-9514-58b3b9f687e3", "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-08T18:24:37.3089212+00:00" }