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": "6bf9c567-9a07-45be-aba8-4b33553f9893", "_parent_id": "4557fca5-a922-4fcf-a6a4-87ef0025812d", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "68fb5543-72f9-4c14-bbb3-6161ed1b3f77", "project_reference_back_office": "sample string 5", "project": { "id": "6ea9f897-79b6-4a73-8f92-8facd5450604", "_parent_id": "14d2d040-bfc6-44ff-9205-0b96c814131c", "root_parent_id": "be76de96-c266-49d8-badb-f0985bb5f213", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "85cc29c2-75ea-4ef1-9545-c781540c56f8", "equipment_family_code": "sample string 6", "equipment_family": { "id": "01cb4cf6-82f1-4ea7-bd9a-6d54f2278c2a", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "eac065bf-5c33-4e1f-9ff2-6ab30139c1fc", "_parent_code": "sample string 6", "sales_organization_id": "e2191d6c-e4ce-491e-9c38-7ef228b96453", "sales_organization_code": "sample string 8", "sales_organization": { "id": "8dd39fc1-5e78-44ae-bc47-a3daa1badf0e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "de2bada7-1700-4149-9d75-c0c584c7cdf7", "db_currency_id": "08e961f2-319e-460c-b323-952cb18ff0d1", "db_language_id": "2f628cae-58a3-46eb-952f-170fdfd36662", "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-14T07:35:00.3032773+00:00" }, "modified_dateutc": "2025-10-14T07:35:00.3032773+00:00" }, "equipment_model_id": "aec2da68-3b99-4d86-8104-7eb42dd4d43c", "equipment_model_code": "sample string 8", "equipment_model": { "id": "6eef1eb2-7493-4e2e-b672-b1d2ce7a5399", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "14ea0384-8960-432d-b7c0-3a34680ab689", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "b55fc77e-cdbc-4994-90bb-7afa0da81865", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "c4210efb-7e9d-447a-a5b1-9115be9d639b", "sales_organization_code": "sample string 5", "sales_organization": { "id": "8dd39fc1-5e78-44ae-bc47-a3daa1badf0e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "de2bada7-1700-4149-9d75-c0c584c7cdf7", "db_currency_id": "08e961f2-319e-460c-b323-952cb18ff0d1", "db_language_id": "2f628cae-58a3-46eb-952f-170fdfd36662", "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-14T07:35:00.3032773+00:00" }, "modified_dateutc": "2025-10-14T07:35:00.3032773+00:00" }, "equipment_family_id": "7fb12530-dac7-48fa-a214-36b5e87686ca", "equipment_family_code": "sample string 8", "equipment_family": { "id": "01cb4cf6-82f1-4ea7-bd9a-6d54f2278c2a", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "eac065bf-5c33-4e1f-9ff2-6ab30139c1fc", "_parent_code": "sample string 6", "sales_organization_id": "e2191d6c-e4ce-491e-9c38-7ef228b96453", "sales_organization_code": "sample string 8", "sales_organization": { "id": "8dd39fc1-5e78-44ae-bc47-a3daa1badf0e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "de2bada7-1700-4149-9d75-c0c584c7cdf7", "db_currency_id": "08e961f2-319e-460c-b323-952cb18ff0d1", "db_language_id": "2f628cae-58a3-46eb-952f-170fdfd36662", "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-14T07:35:00.3032773+00:00" }, "modified_dateutc": "2025-10-14T07:35:00.3032773+00:00" }, "date_in_production_since": "2025-10-14T07:35:00.3032773+00:00", "date_out_of_production_since": "2025-10-14T07:35:00.3032773+00:00", "date_end_support": "2025-10-14T07:35:00.3032773+00:00", "sales_organization_id": "155a08d4-2cd2-4f72-8737-5584d5f29682", "sales_organization_code": "sample string 13", "sales_organization": { "id": "8dd39fc1-5e78-44ae-bc47-a3daa1badf0e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "de2bada7-1700-4149-9d75-c0c584c7cdf7", "db_currency_id": "08e961f2-319e-460c-b323-952cb18ff0d1", "db_language_id": "2f628cae-58a3-46eb-952f-170fdfd36662", "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-14T07:35:00.3032773+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-14T07:35:00.3032773+00:00" }, "project_status_id": "501a4bc1-3352-41bc-a77b-db6f7f644fc1", "project_status_code": "sample string 10", "project_status": { "id": "51d0e209-a0fc-49d7-962e-86820668e487", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "695f9b28-1383-455a-ba36-bd6e07b31a93", "sales_organization_code": "sample string 6", "sales_organization": { "id": "8dd39fc1-5e78-44ae-bc47-a3daa1badf0e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "de2bada7-1700-4149-9d75-c0c584c7cdf7", "db_currency_id": "08e961f2-319e-460c-b323-952cb18ff0d1", "db_language_id": "2f628cae-58a3-46eb-952f-170fdfd36662", "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-14T07:35:00.3032773+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-14T07:35:00.3032773+00:00" }, "company_id": "671383b3-4176-459e-8c6c-2016e4c75ba0", "company_code": "sample string 12", "db_address_id": "e5a22c9b-5a88-4de5-9a32-b1b8f9254f95", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "aef4704f-d249-49b5-be99-e9c796e95eb2", "contact_reference_back_office": "sample string 17", "owner_user_id": "72681445-daa5-4f4a-9fea-32fec8e73c44", "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-14T07:35:00.3032773+00:00", "date_create": "2025-10-14T07:35:00.3032773+00:00", "date_update": "2025-10-14T07:35:00.3032773+00:00", "updated_by_user_id": "e8e721f0-9eb0-4609-8fe6-9e9f606e6a5b", "customer_reference": "sample string 28", "warranty_date_until": "2025-10-14T07:35:00.3032773+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-14T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-10-14T07:35:00.3032773+00:00", "date_last_job": "2025-10-14T07:35:00.3032773+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-10-14T07:35:00.3032773+00:00", "modified_dateutc": "2025-10-14T07:35:00.3032773+00:00", "is_mobile_installation": true }, "job_type_id": "f8656c40-1264-4389-9fa4-6cbd241b49b5", "job_type_code": "sample string 7", "job_type": { "id": "c696e868-d520-4e5d-84dc-b3bba99675b2", "name": "sample string 2", "sales_organization_id": "99211844-ca89-49f7-9f55-ec1dc18e0810", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-10-14T07:35:00.3032773+00:00", "code": "sample string 7" }, "job_priority_id": "585ab731-2255-47d7-a563-000d7932398d", "job_priority_code": "sample string 9", "job_priority": { "id": "80ad334d-a3f4-40f4-8c93-f70a9bf98f53", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "60f0b804-0781-4c20-9cff-4b75ec9e19ad", "sales_organization_code": "sample string 6", "sales_organization": { "id": "8dd39fc1-5e78-44ae-bc47-a3daa1badf0e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "de2bada7-1700-4149-9d75-c0c584c7cdf7", "db_currency_id": "08e961f2-319e-460c-b323-952cb18ff0d1", "db_language_id": "2f628cae-58a3-46eb-952f-170fdfd36662", "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-14T07:35:00.3032773+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-14T07:35:00.3032773+00:00" }, "job_status_id": "459ef658-8d17-4b3e-a60c-b3c2abb60198", "job_status_code": "sample string 11", "db_address_id": "91e9ec4f-300b-4f9c-adca-451ab301de97", "contact_id": "4b04dae0-5615-4119-bba3-9d2887ecae79", "requested_by_company_id": "dfaba148-62be-48bf-8e1b-09a0178728d3", "requested_by_contact_id": "74d2e67b-2de1-4c07-8f35-2b3bc2f365f4", "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-14T07:35:00.3032773+00:00", "due_date": "2025-10-14T07:35:00.3032773+00:00", "date_create": "2025-10-14T07:35:00.3032773+00:00", "date_update": "2025-10-14T07:35:00.3032773+00:00", "date_closed": "2025-10-14T07:35:00.3032773+00:00", "suggested_user_id": "000ded06-bf7a-4767-a1d7-ad07205dc0db", "suggested_user_code": "sample string 29", "suggested_user": { "id": "6c2c9e5e-636a-44b1-9beb-7be251c553e8", "db_language_id": "5b8c4136-88dc-4bba-9a6e-51e6191a4ad6", "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-14T07:35:00.3032773+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "6b99038b-f008-482d-8b25-a1cb384c70d6", "sales_organization": { "id": "8dd39fc1-5e78-44ae-bc47-a3daa1badf0e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "de2bada7-1700-4149-9d75-c0c584c7cdf7", "db_currency_id": "08e961f2-319e-460c-b323-952cb18ff0d1", "db_language_id": "2f628cae-58a3-46eb-952f-170fdfd36662", "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-14T07:35:00.3032773+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "47add743-0076-4988-aa6d-68d19831cce4", "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": "e9cef169-55b5-4124-9881-451ae705299f", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-10-14T07:35:00.3032773+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "9cc68083-6215-474a-9578-b28d215ecdcd" }, "suggested_date_start": "2025-10-14T07:35:00.3032773+00:00", "skill_id": "be214f08-1068-45f4-a4dc-198db9a1d88c", "skill_code": "sample string 32", "skill": { "id": "9799dbff-23d6-4076-9adb-3163982f82e1", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "3d962ba7-ce45-4622-bfaa-f8783b4f7a4c", "sales_organization_code": "sample string 6", "sales_organization": { "id": "8dd39fc1-5e78-44ae-bc47-a3daa1badf0e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "de2bada7-1700-4149-9d75-c0c584c7cdf7", "db_currency_id": "08e961f2-319e-460c-b323-952cb18ff0d1", "db_language_id": "2f628cae-58a3-46eb-952f-170fdfd36662", "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-14T07:35:00.3032773+00:00" }, "modified_dateutc": "2025-10-14T07:35:00.3032773+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "955a71f4-0b61-4597-a11f-d0cead6514fb", "date_reported_by_company": "2025-10-14T07:35:00.3032773+00:00", "id2": 36, "company_id": "472bc9dc-9269-474f-a1ee-53be8af0a6df", "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": "6930c0cf-28b6-4fd4-8ad6-72c6a74457c2", "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-14T07:35:00.3032773+00:00" }