Retrieves the work order with the specified key
Request Information
URI Parameters :
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
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": "28cfa124-8bc2-40c1-a908-a69dc12cabb8", "_parent_id": "2b2d5fe9-99d6-4f18-9dfb-3521adbe701a", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "d74af05d-1546-485d-96a6-7d1116f2bc07", "project_reference_back_office": "sample string 5", "project": { "id": "ecf4cf2e-dfad-43a3-b61a-53b815ce3dc5", "_parent_id": "97760464-a48f-449d-8738-529c25da3120", "root_parent_id": "1074530b-26c8-4f6c-8ee0-39eadaea88e5", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "7fa88961-03e6-4dad-9103-6affd6020b08", "equipment_family_code": "sample string 6", "equipment_family": { "id": "2d8e941d-a83f-4aad-8b2b-94581d091322", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "950bc002-b4d9-4e66-bdb8-9eede1356878", "_parent_code": "sample string 6", "sales_organization_id": "fba4a564-3c70-412d-affd-ca5f033bed1d", "sales_organization_code": "sample string 8", "sales_organization": { "id": "0bf3bdcc-c8e9-41ba-9bac-ebe8e713a052", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b0980594-3670-4240-aef6-8e664a2aa280", "db_currency_id": "f61d9463-2202-43ad-967e-4100612befe7", "db_language_id": "0c1c02a7-51fc-4e18-8a9f-74f44d118113", "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-02T21:13:38.9661424+00:00" }, "modified_dateutc": "2025-10-02T21:13:38.9661424+00:00" }, "equipment_model_id": "475fb9a0-640f-461b-9d11-546bacc8c738", "equipment_model_code": "sample string 8", "equipment_model": { "id": "0e4f5966-1b9a-4e1c-9c9f-45d2baa56f08", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "c6cd9605-916a-4708-b4a7-d0533a291f5b", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "4c11fbe1-ce82-4838-baab-bb95e104f0a7", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "10352536-763a-43b9-a17e-55545092f574", "sales_organization_code": "sample string 5", "sales_organization": { "id": "0bf3bdcc-c8e9-41ba-9bac-ebe8e713a052", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b0980594-3670-4240-aef6-8e664a2aa280", "db_currency_id": "f61d9463-2202-43ad-967e-4100612befe7", "db_language_id": "0c1c02a7-51fc-4e18-8a9f-74f44d118113", "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-02T21:13:38.9661424+00:00" }, "modified_dateutc": "2025-10-02T21:13:38.9661424+00:00" }, "equipment_family_id": "d19bfb12-9ad2-47fe-815c-e635694c7864", "equipment_family_code": "sample string 8", "equipment_family": { "id": "2d8e941d-a83f-4aad-8b2b-94581d091322", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "950bc002-b4d9-4e66-bdb8-9eede1356878", "_parent_code": "sample string 6", "sales_organization_id": "fba4a564-3c70-412d-affd-ca5f033bed1d", "sales_organization_code": "sample string 8", "sales_organization": { "id": "0bf3bdcc-c8e9-41ba-9bac-ebe8e713a052", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b0980594-3670-4240-aef6-8e664a2aa280", "db_currency_id": "f61d9463-2202-43ad-967e-4100612befe7", "db_language_id": "0c1c02a7-51fc-4e18-8a9f-74f44d118113", "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-02T21:13:38.9661424+00:00" }, "modified_dateutc": "2025-10-02T21:13:38.9661424+00:00" }, "date_in_production_since": "2025-10-02T21:13:38.9661424+00:00", "date_out_of_production_since": "2025-10-02T21:13:38.9661424+00:00", "date_end_support": "2025-10-02T21:13:38.9661424+00:00", "sales_organization_id": "bfb46c0c-c274-494b-a38d-2ed6a421699c", "sales_organization_code": "sample string 13", "sales_organization": { "id": "0bf3bdcc-c8e9-41ba-9bac-ebe8e713a052", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b0980594-3670-4240-aef6-8e664a2aa280", "db_currency_id": "f61d9463-2202-43ad-967e-4100612befe7", "db_language_id": "0c1c02a7-51fc-4e18-8a9f-74f44d118113", "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-02T21:13:38.9661424+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-02T21:13:38.9661424+00:00" }, "project_status_id": "2ea7056e-952c-4553-ae7a-a59fcbdd4bb6", "project_status_code": "sample string 10", "project_status": { "id": "80b1d3b3-8810-43d1-b597-a64cee24272f", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "4872f429-d521-41ea-b1e1-afe6d8f77f60", "sales_organization_code": "sample string 6", "sales_organization": { "id": "0bf3bdcc-c8e9-41ba-9bac-ebe8e713a052", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b0980594-3670-4240-aef6-8e664a2aa280", "db_currency_id": "f61d9463-2202-43ad-967e-4100612befe7", "db_language_id": "0c1c02a7-51fc-4e18-8a9f-74f44d118113", "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-02T21:13:38.9661424+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-02T21:13:38.9661424+00:00" }, "company_id": "9ce583bb-b491-4506-9f0e-453a07288c0e", "company_code": "sample string 12", "db_address_id": "0ac89fd7-1935-4c1f-ac5f-c6c60e9a718f", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "d2eaf5c3-3b14-4ca2-9fd5-6310ba59ace4", "contact_reference_back_office": "sample string 17", "owner_user_id": "fafd9d84-e002-43b4-b2b9-4f61efd7bb56", "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-02T21:13:38.9661424+00:00", "date_create": "2025-10-02T21:13:38.9661424+00:00", "date_update": "2025-10-02T21:13:38.9661424+00:00", "updated_by_user_id": "91063f00-9071-48ee-b7c2-f96ef07b7361", "customer_reference": "sample string 28", "warranty_date_until": "2025-10-02T21:13:38.9661424+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-02T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-10-02T21:13:38.9661424+00:00", "date_last_job": "2025-10-02T21:13:38.9661424+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-10-02T21:13:38.9661424+00:00", "modified_dateutc": "2025-10-02T21:13:38.9661424+00:00", "is_mobile_installation": true }, "job_type_id": "2cc96291-46b2-48d2-9b24-8cac6c922725", "job_type_code": "sample string 7", "job_type": { "id": "2eccb052-e5f7-4962-9ce1-6d9cbb37e0cb", "name": "sample string 2", "sales_organization_id": "68c08335-73fc-4655-b16e-c61952c229cf", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-10-02T21:13:38.9661424+00:00", "code": "sample string 7" }, "job_priority_id": "64943cb0-7752-41ed-be4c-ebc311e5f445", "job_priority_code": "sample string 9", "job_priority": { "id": "c0ecd71e-f05a-4c5a-a304-82a8132165dc", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "c87e4bb8-f428-4531-bb68-51ee31f56d02", "sales_organization_code": "sample string 6", "sales_organization": { "id": "0bf3bdcc-c8e9-41ba-9bac-ebe8e713a052", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b0980594-3670-4240-aef6-8e664a2aa280", "db_currency_id": "f61d9463-2202-43ad-967e-4100612befe7", "db_language_id": "0c1c02a7-51fc-4e18-8a9f-74f44d118113", "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-02T21:13:38.9661424+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-02T21:13:38.9661424+00:00" }, "job_status_id": "d3d98527-99f9-4330-9163-27e7d8068659", "job_status_code": "sample string 11", "db_address_id": "b0c2491e-9bda-4a38-9824-e9d6f3f440fc", "contact_id": "fb2a23ed-f5eb-424f-84c8-63c341fc8c14", "requested_by_company_id": "f0704ff2-3074-431f-a4ae-fd74cfe396a5", "requested_by_contact_id": "e8b4e5bc-3afe-44ca-8d4e-99c92cca8f52", "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-02T21:13:38.9661424+00:00", "due_date": "2025-10-02T21:13:38.9661424+00:00", "date_create": "2025-10-02T21:13:38.9661424+00:00", "date_update": "2025-10-02T21:13:38.9661424+00:00", "date_closed": "2025-10-02T21:13:38.9661424+00:00", "suggested_user_id": "d77d764a-4956-4e60-96aa-630ff941a541", "suggested_user_code": "sample string 29", "suggested_user": { "id": "6507dc94-387d-445d-a6c3-c737574cf64d", "db_language_id": "1a679622-bdbb-4936-ba9b-1c67c191dd10", "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-02T21:13:38.9661424+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "c7a50c27-806d-4ce3-b69e-07bf3138c919", "sales_organization": { "id": "0bf3bdcc-c8e9-41ba-9bac-ebe8e713a052", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b0980594-3670-4240-aef6-8e664a2aa280", "db_currency_id": "f61d9463-2202-43ad-967e-4100612befe7", "db_language_id": "0c1c02a7-51fc-4e18-8a9f-74f44d118113", "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-02T21:13:38.9661424+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "5fc4b4a8-0188-4786-af90-3b248a15d9fc", "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": "3927bfaa-c314-489f-8add-32c5c06c4301", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-10-02T21:13:38.9661424+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "e5601195-e880-49e2-b4e3-74be30120119" }, "suggested_date_start": "2025-10-02T21:13:38.9661424+00:00", "skill_id": "00cf631d-ee78-4758-8bb8-9f866827f620", "skill_code": "sample string 32", "skill": { "id": "ee69ee87-2995-4597-9b53-79054f5e7697", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "ea239372-d6bc-4b12-bf6f-bf773ecad2ac", "sales_organization_code": "sample string 6", "sales_organization": { "id": "0bf3bdcc-c8e9-41ba-9bac-ebe8e713a052", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b0980594-3670-4240-aef6-8e664a2aa280", "db_currency_id": "f61d9463-2202-43ad-967e-4100612befe7", "db_language_id": "0c1c02a7-51fc-4e18-8a9f-74f44d118113", "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-02T21:13:38.9661424+00:00" }, "modified_dateutc": "2025-10-02T21:13:38.9661424+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "170b1543-18d1-4bfb-adb5-d21c00219c84", "date_reported_by_company": "2025-10-02T21:13:38.9661424+00:00", "id2": 36, "company_id": "30475588-8277-46b1-b719-038f70d95ce6", "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": "eb6e2717-c5c5-4109-ae20-5462882192ed", "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-02T21:13:38.9661424+00:00" }