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": "3d4fe30e-5ed4-4784-90b6-a311288169f3", "_parent_id": "a4e05f0f-f765-4163-8b34-c603a43abc85", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "9e4789b4-1cff-4a24-968f-8421446fd01e", "project_reference_back_office": "sample string 5", "project": { "id": "9a412be6-8d0c-4c70-9acc-038089cb49aa", "_parent_id": "2227ed1d-58f6-49d7-adf9-a29a2ce27e99", "root_parent_id": "87c4a457-6ff6-4d2c-884b-a659449bd4ec", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "795a2ed5-8e0a-435d-86c0-c8f70d443817", "equipment_family_code": "sample string 6", "equipment_family": { "id": "3f817945-f93b-4c59-9b3e-d55ff2ed98eb", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "a7702aa4-e685-45a1-a4f7-e84986431d79", "_parent_code": "sample string 6", "sales_organization_id": "27fdf5da-9cf0-4214-aa41-3381d43c8986", "sales_organization_code": "sample string 8", "sales_organization": { "id": "d342caff-747c-4850-beec-b0639798c67c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8b492747-eead-4aaa-a7f7-da793aa70607", "db_currency_id": "3ab1d427-8bf4-423d-a949-ffaf2bfd8556", "db_language_id": "e0154637-8502-4a69-84bc-88228fae9616", "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-06-21T12:09:08.8523124+00:00" }, "modified_dateutc": "2025-06-21T12:09:08.8523124+00:00" }, "equipment_model_id": "bcd6f774-6ade-4b54-82df-b51075e6f9f6", "equipment_model_code": "sample string 8", "equipment_model": { "id": "5889aa9a-2038-4b03-b689-870377c3a763", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "edab20a2-024f-4f37-9f3c-fe24953b7dc9", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "9910d046-ff67-40f1-8ec8-6f5b38efde92", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "74234c44-b6e9-4161-a7dc-663e970ee316", "sales_organization_code": "sample string 5", "sales_organization": { "id": "d342caff-747c-4850-beec-b0639798c67c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8b492747-eead-4aaa-a7f7-da793aa70607", "db_currency_id": "3ab1d427-8bf4-423d-a949-ffaf2bfd8556", "db_language_id": "e0154637-8502-4a69-84bc-88228fae9616", "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-06-21T12:09:08.8523124+00:00" }, "modified_dateutc": "2025-06-21T12:09:08.8523124+00:00" }, "equipment_family_id": "b6f02529-b9e8-45a8-b232-471e10598c2c", "equipment_family_code": "sample string 8", "equipment_family": { "id": "3f817945-f93b-4c59-9b3e-d55ff2ed98eb", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "a7702aa4-e685-45a1-a4f7-e84986431d79", "_parent_code": "sample string 6", "sales_organization_id": "27fdf5da-9cf0-4214-aa41-3381d43c8986", "sales_organization_code": "sample string 8", "sales_organization": { "id": "d342caff-747c-4850-beec-b0639798c67c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8b492747-eead-4aaa-a7f7-da793aa70607", "db_currency_id": "3ab1d427-8bf4-423d-a949-ffaf2bfd8556", "db_language_id": "e0154637-8502-4a69-84bc-88228fae9616", "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-06-21T12:09:08.8523124+00:00" }, "modified_dateutc": "2025-06-21T12:09:08.8523124+00:00" }, "date_in_production_since": "2025-06-21T12:09:08.8523124+00:00", "date_out_of_production_since": "2025-06-21T12:09:08.8523124+00:00", "date_end_support": "2025-06-21T12:09:08.8523124+00:00", "sales_organization_id": "345990c1-749f-4901-9cc9-8337ae384427", "sales_organization_code": "sample string 13", "sales_organization": { "id": "d342caff-747c-4850-beec-b0639798c67c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8b492747-eead-4aaa-a7f7-da793aa70607", "db_currency_id": "3ab1d427-8bf4-423d-a949-ffaf2bfd8556", "db_language_id": "e0154637-8502-4a69-84bc-88228fae9616", "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-06-21T12:09:08.8523124+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-06-21T12:09:08.8523124+00:00" }, "project_status_id": "b6545351-7c01-4547-9382-1347b9e1aa46", "project_status_code": "sample string 10", "project_status": { "id": "283c704c-9e9c-435e-a4d7-16faff60754b", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "9dcb34dc-075b-4215-a0fc-5296e9cce407", "sales_organization_code": "sample string 6", "sales_organization": { "id": "d342caff-747c-4850-beec-b0639798c67c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8b492747-eead-4aaa-a7f7-da793aa70607", "db_currency_id": "3ab1d427-8bf4-423d-a949-ffaf2bfd8556", "db_language_id": "e0154637-8502-4a69-84bc-88228fae9616", "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-06-21T12:09:08.8523124+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-21T12:09:08.8523124+00:00" }, "company_id": "ec00ea2d-d4fd-4a0b-b3eb-1b33bd08da31", "company_code": "sample string 12", "db_address_id": "13ebd0d5-2231-4032-8713-742ba6ed0cee", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "7478eca2-5d33-4e53-be99-5b425c256f7b", "contact_reference_back_office": "sample string 17", "owner_user_id": "f39afe58-ba9b-4d00-9dad-748a9752f04d", "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-06-21T12:09:08.8523124+00:00", "date_create": "2025-06-21T12:09:08.8523124+00:00", "date_update": "2025-06-21T12:09:08.8523124+00:00", "updated_by_user_id": "764ac06e-bfb8-452f-a8d3-7016a9bdcf03", "customer_reference": "sample string 28", "warranty_date_until": "2025-06-21T12:09:08.8523124+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-06-21T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-06-21T12:09:08.8523124+00:00", "date_last_job": "2025-06-21T12:09:08.8523124+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-06-21T12:09:08.8523124+00:00", "modified_dateutc": "2025-06-21T12:09:08.8523124+00:00", "is_mobile_installation": true }, "job_type_id": "e78fbf3a-2659-4a0a-889b-aee840beb9af", "job_type_code": "sample string 7", "job_type": { "id": "ff8af836-2c1b-4754-9f05-3bf0399ab507", "name": "sample string 2", "sales_organization_id": "59fa8374-4a97-42a5-b9cf-3f4ca0982aa9", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-06-21T12:09:08.8523124+00:00", "code": "sample string 7" }, "job_priority_id": "940520b6-1645-45d4-9176-367ff9c36224", "job_priority_code": "sample string 9", "job_priority": { "id": "55aa3a80-4895-48ea-b207-6b98941ca1ad", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "0eae31c8-e376-4c53-a465-edd41ef0aeb0", "sales_organization_code": "sample string 6", "sales_organization": { "id": "d342caff-747c-4850-beec-b0639798c67c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8b492747-eead-4aaa-a7f7-da793aa70607", "db_currency_id": "3ab1d427-8bf4-423d-a949-ffaf2bfd8556", "db_language_id": "e0154637-8502-4a69-84bc-88228fae9616", "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-06-21T12:09:08.8523124+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-21T12:09:08.8523124+00:00" }, "job_status_id": "5737d573-d6f9-4436-a409-628ad22845d1", "job_status_code": "sample string 11", "db_address_id": "0e2f2aed-0781-4df5-8ae0-ff96315b4c5a", "contact_id": "c492d645-65f2-4780-9908-12c2c4947d08", "requested_by_company_id": "37889c8b-95be-4d4c-b71a-8e2a18b7db98", "requested_by_contact_id": "02aa22c1-a7df-4126-8da3-9fd59fe0ff64", "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-06-21T12:09:08.8523124+00:00", "due_date": "2025-06-21T12:09:08.8523124+00:00", "date_create": "2025-06-21T12:09:08.8523124+00:00", "date_update": "2025-06-21T12:09:08.8523124+00:00", "date_closed": "2025-06-21T12:09:08.8523124+00:00", "suggested_user_id": "088e5f69-6737-4b99-8a0b-1679e23d16f5", "suggested_user_code": "sample string 29", "suggested_user": { "id": "fa24f815-48ed-478a-bae7-99dcaf8a997f", "db_language_id": "dfdcbfaa-432e-4099-a84f-027e2a99c8a0", "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-06-21T12:09:08.8523124+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "e7555327-d078-48c9-949f-e4c1527c415b", "sales_organization": { "id": "d342caff-747c-4850-beec-b0639798c67c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8b492747-eead-4aaa-a7f7-da793aa70607", "db_currency_id": "3ab1d427-8bf4-423d-a949-ffaf2bfd8556", "db_language_id": "e0154637-8502-4a69-84bc-88228fae9616", "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-06-21T12:09:08.8523124+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "1ee40c0d-ed6e-47cd-9f12-6a0f72697e1d", "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": "1f02116b-f0b9-40da-963b-15748c166056", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-06-21T12:09:08.8523124+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "363fd877-a499-4dab-b25f-c788f1cdd350" }, "suggested_date_start": "2025-06-21T12:09:08.8523124+00:00", "skill_id": "bd2877e7-de94-4200-837d-e4e6cdbe3c0b", "skill_code": "sample string 32", "skill": { "id": "2f149ba2-e42a-4754-bf41-178058d01bbe", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "dd3848a8-bede-4820-85f7-ff85e944b292", "sales_organization_code": "sample string 6", "sales_organization": { "id": "d342caff-747c-4850-beec-b0639798c67c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8b492747-eead-4aaa-a7f7-da793aa70607", "db_currency_id": "3ab1d427-8bf4-423d-a949-ffaf2bfd8556", "db_language_id": "e0154637-8502-4a69-84bc-88228fae9616", "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-06-21T12:09:08.8523124+00:00" }, "modified_dateutc": "2025-06-21T12:09:08.8523124+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "5d1903f6-9f8b-450c-99d1-02ab96971305", "date_reported_by_company": "2025-06-21T12:09:08.8523124+00:00", "id2": 36, "company_id": "fc34d704-b219-41e2-8a32-832338ffd4b0", "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": "3da5e095-ddde-4018-974d-397edcfa3c76", "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-06-21T12:09:08.8523124+00:00" }