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": "e103ff78-fd73-467c-96cd-dd21c852b269", "_parent_id": "8c179bec-7f01-4105-b9e1-768e5e86cd03", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "e5cfb74c-0a81-4e3c-8c2b-8c5b240dafd4", "project_reference_back_office": "sample string 5", "project": { "id": "648081ec-3a2e-4a35-9050-96d0e4ae9dbe", "_parent_id": "116155ee-63b0-4327-a7dd-1f592747998c", "root_parent_id": "cdfc88d6-8a2a-4ac2-8847-21fddb88a992", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "38fb2db1-f845-4bf5-b16d-9a9fa8ec070b", "equipment_family_code": "sample string 6", "equipment_family": { "id": "4e75185a-db49-481f-b014-1213a0357707", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "e3f66b33-0868-429a-91df-0b87741466d9", "_parent_code": "sample string 6", "sales_organization_id": "fe7b6661-f0b9-440c-a5a7-80a810bda338", "sales_organization_code": "sample string 8", "sales_organization": { "id": "59d094c9-6c29-4c73-b311-31fc7c6486b2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "619bbe67-5f2c-4527-b27f-0e2969c22f50", "db_currency_id": "dee21b79-c9ce-4c87-b85f-ed86c7e0b1db", "db_language_id": "59cb0dd1-a509-4a2a-902f-6bc840cc938c", "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-18T02:54:33.1117713+00:00" }, "modified_dateutc": "2025-07-18T02:54:33.1117713+00:00" }, "equipment_model_id": "52a3eee2-4365-420a-87b5-b8c748c59d7b", "equipment_model_code": "sample string 8", "equipment_model": { "id": "b83b7f13-860f-4176-b8ca-cfdcff427f0d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "68973919-25b6-445d-9860-18b505748604", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "183a2edb-4ba6-4331-84e6-92aa73371db6", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "311a054f-e0b8-4ca0-995a-7dfeced28293", "sales_organization_code": "sample string 5", "sales_organization": { "id": "59d094c9-6c29-4c73-b311-31fc7c6486b2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "619bbe67-5f2c-4527-b27f-0e2969c22f50", "db_currency_id": "dee21b79-c9ce-4c87-b85f-ed86c7e0b1db", "db_language_id": "59cb0dd1-a509-4a2a-902f-6bc840cc938c", "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-18T02:54:33.1117713+00:00" }, "modified_dateutc": "2025-07-18T02:54:33.1117713+00:00" }, "equipment_family_id": "63d3aa1a-2deb-46f5-a064-68eb783139f8", "equipment_family_code": "sample string 8", "equipment_family": { "id": "4e75185a-db49-481f-b014-1213a0357707", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "e3f66b33-0868-429a-91df-0b87741466d9", "_parent_code": "sample string 6", "sales_organization_id": "fe7b6661-f0b9-440c-a5a7-80a810bda338", "sales_organization_code": "sample string 8", "sales_organization": { "id": "59d094c9-6c29-4c73-b311-31fc7c6486b2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "619bbe67-5f2c-4527-b27f-0e2969c22f50", "db_currency_id": "dee21b79-c9ce-4c87-b85f-ed86c7e0b1db", "db_language_id": "59cb0dd1-a509-4a2a-902f-6bc840cc938c", "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-18T02:54:33.1117713+00:00" }, "modified_dateutc": "2025-07-18T02:54:33.1117713+00:00" }, "date_in_production_since": "2025-07-18T02:54:33.1117713+00:00", "date_out_of_production_since": "2025-07-18T02:54:33.1117713+00:00", "date_end_support": "2025-07-18T02:54:33.1117713+00:00", "sales_organization_id": "4dc7e6ac-5548-4e80-bb40-0cd4a4117dde", "sales_organization_code": "sample string 13", "sales_organization": { "id": "59d094c9-6c29-4c73-b311-31fc7c6486b2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "619bbe67-5f2c-4527-b27f-0e2969c22f50", "db_currency_id": "dee21b79-c9ce-4c87-b85f-ed86c7e0b1db", "db_language_id": "59cb0dd1-a509-4a2a-902f-6bc840cc938c", "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-18T02:54:33.1117713+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-18T02:54:33.1117713+00:00" }, "project_status_id": "502dc48f-98c9-41ac-b237-213ce16ff563", "project_status_code": "sample string 10", "project_status": { "id": "51d2e552-f345-4188-8919-1a56aae68520", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "e93cda9f-2640-49fe-8447-cbe7bb80cb4b", "sales_organization_code": "sample string 6", "sales_organization": { "id": "59d094c9-6c29-4c73-b311-31fc7c6486b2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "619bbe67-5f2c-4527-b27f-0e2969c22f50", "db_currency_id": "dee21b79-c9ce-4c87-b85f-ed86c7e0b1db", "db_language_id": "59cb0dd1-a509-4a2a-902f-6bc840cc938c", "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-18T02:54:33.1117713+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-18T02:54:33.1117713+00:00" }, "company_id": "a081bd22-d47b-4ed5-97cd-8afec16fc57a", "company_code": "sample string 12", "db_address_id": "6706f749-7952-47cd-a958-679fddfa91c1", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "8eb71a88-6547-46cb-b0af-85c330b26d04", "contact_reference_back_office": "sample string 17", "owner_user_id": "673d27b3-eb4c-4751-8063-83aae543dd0e", "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-18T02:54:33.1117713+00:00", "date_create": "2025-07-18T02:54:33.1117713+00:00", "date_update": "2025-07-18T02:54:33.1117713+00:00", "updated_by_user_id": "0840f17c-1069-43cf-b6ff-8b9157068eb9", "customer_reference": "sample string 28", "warranty_date_until": "2025-07-18T02:54:33.1117713+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-18T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-07-18T02:54:33.1117713+00:00", "date_last_job": "2025-07-18T02:54:33.1117713+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-07-18T02:54:33.1117713+00:00", "modified_dateutc": "2025-07-18T02:54:33.1117713+00:00", "is_mobile_installation": true }, "job_type_id": "fe72917b-bc93-4c34-80fe-f6228f3408a3", "job_type_code": "sample string 7", "job_type": { "id": "01ae6c0e-4be4-4f9f-bbb9-8e29b201ab59", "name": "sample string 2", "sales_organization_id": "c62ead8a-8267-4b7e-8376-25d6e32b7cd4", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-07-18T02:54:33.1117713+00:00", "code": "sample string 7" }, "job_priority_id": "6213a2f8-1f43-4893-ae34-43dcf0ccc11d", "job_priority_code": "sample string 9", "job_priority": { "id": "1cdaac56-aa6e-4720-bd7d-d379281a211a", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "6f6c8c38-d5af-468e-bb6f-d43765a9b3b3", "sales_organization_code": "sample string 6", "sales_organization": { "id": "59d094c9-6c29-4c73-b311-31fc7c6486b2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "619bbe67-5f2c-4527-b27f-0e2969c22f50", "db_currency_id": "dee21b79-c9ce-4c87-b85f-ed86c7e0b1db", "db_language_id": "59cb0dd1-a509-4a2a-902f-6bc840cc938c", "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-18T02:54:33.1117713+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-18T02:54:33.1117713+00:00" }, "job_status_id": "a5a1b1c7-c2d1-43fa-a512-b388f9d85797", "job_status_code": "sample string 11", "db_address_id": "a74c8ce5-1a55-412d-8425-82a1b7d30698", "contact_id": "3e8bc40c-394b-4ddd-adce-5152160723b3", "requested_by_company_id": "92dda80e-949a-4bf2-b712-7b77c0ef94ee", "requested_by_contact_id": "afb4179c-2dd3-4d2a-8407-16729fed7031", "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-18T02:54:33.1117713+00:00", "due_date": "2025-07-18T02:54:33.1117713+00:00", "date_create": "2025-07-18T02:54:33.1117713+00:00", "date_update": "2025-07-18T02:54:33.1117713+00:00", "date_closed": "2025-07-18T02:54:33.1117713+00:00", "suggested_user_id": "309b994b-d292-49ca-90e8-5cf69a63681e", "suggested_user_code": "sample string 29", "suggested_user": { "id": "89e52b01-51c4-4069-b25a-ecbbe905ce76", "db_language_id": "8275f17e-91f5-4347-8352-d6bde2d681cc", "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-18T02:54:33.1117713+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "02cceb0f-5f4b-425e-a6b0-8d6d24f9cbd0", "sales_organization": { "id": "59d094c9-6c29-4c73-b311-31fc7c6486b2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "619bbe67-5f2c-4527-b27f-0e2969c22f50", "db_currency_id": "dee21b79-c9ce-4c87-b85f-ed86c7e0b1db", "db_language_id": "59cb0dd1-a509-4a2a-902f-6bc840cc938c", "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-18T02:54:33.1117713+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "1c38e66d-5af5-43cb-a0a9-d20dac5818e6", "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": "0c84c049-c42d-4688-9cbb-6f9e1981d1b8", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-07-18T02:54:33.1117713+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "5ccc2003-e841-4aee-bf8e-6d1f1fdd25d7" }, "suggested_date_start": "2025-07-18T02:54:33.1117713+00:00", "skill_id": "a1916f5c-5bf3-4bdc-838b-043c48e28584", "skill_code": "sample string 32", "skill": { "id": "4ef25df3-8556-4bde-9b86-4607dbda1fa4", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "adce8275-e7ac-4535-90bc-7efa19da07cf", "sales_organization_code": "sample string 6", "sales_organization": { "id": "59d094c9-6c29-4c73-b311-31fc7c6486b2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "619bbe67-5f2c-4527-b27f-0e2969c22f50", "db_currency_id": "dee21b79-c9ce-4c87-b85f-ed86c7e0b1db", "db_language_id": "59cb0dd1-a509-4a2a-902f-6bc840cc938c", "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-18T02:54:33.1117713+00:00" }, "modified_dateutc": "2025-07-18T02:54:33.1117713+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "91e4de79-0510-4861-83b1-ecd65b70c832", "date_reported_by_company": "2025-07-18T02:54:33.1117713+00:00", "id2": 36, "company_id": "34208e66-183f-4a2f-8f4b-4ea4ea08f255", "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": "6469dd65-9207-4d4a-8d95-f86bb1ed4e5c", "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-18T02:54:33.1117713+00:00" }