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": "a646c16a-b69e-4eed-89d4-49d7224418ad", "_parent_id": "606b5989-1cc6-48ba-bf8d-da06fbe94630", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "c39d7968-2a86-465f-a331-be80edbfa9b2", "project_reference_back_office": "sample string 5", "project": { "id": "dae3919a-9119-42b5-aea9-0d2050adaf18", "_parent_id": "b5a744cf-0725-4cc9-b7e0-cfa275162822", "root_parent_id": "02917db8-1e03-4d76-9a56-63e170b39fb6", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "f027572a-bb2d-41a9-9679-f7b881b3752b", "equipment_family_code": "sample string 6", "equipment_family": { "id": "acb26b8f-bb62-46a9-b0ed-386881dd5128", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "64c22389-11e2-47ca-b6cb-4da7eaffb4fa", "_parent_code": "sample string 6", "sales_organization_id": "d11ea245-bdb5-4824-8a80-35c2272cc217", "sales_organization_code": "sample string 8", "sales_organization": { "id": "79003382-b9f4-46a1-87b7-5af2c56b308b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c1065d7d-3830-4cff-8711-a79259d1c410", "db_currency_id": "b1543e0b-29a3-411a-9adf-619616f65221", "db_language_id": "59164aa3-48a5-4059-bed1-a839de6ba7d1", "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-06T22:36:42.3065794+00:00" }, "modified_dateutc": "2025-07-06T22:36:42.3065794+00:00" }, "equipment_model_id": "cf7f32f8-ea8c-4178-bc6b-a4182e2076da", "equipment_model_code": "sample string 8", "equipment_model": { "id": "b019f8b5-23ce-46a7-b629-3b583b5ee46f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "5191fcbb-fd80-4614-98e3-64dd716600f4", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "d5f4a8e3-f5c7-428b-8e47-e684820606c2", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "fbb051f6-34ec-4c13-8c2a-ab19c71b9f61", "sales_organization_code": "sample string 5", "sales_organization": { "id": "79003382-b9f4-46a1-87b7-5af2c56b308b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c1065d7d-3830-4cff-8711-a79259d1c410", "db_currency_id": "b1543e0b-29a3-411a-9adf-619616f65221", "db_language_id": "59164aa3-48a5-4059-bed1-a839de6ba7d1", "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-06T22:36:42.3065794+00:00" }, "modified_dateutc": "2025-07-06T22:36:42.3065794+00:00" }, "equipment_family_id": "3e8bbf81-c1df-474b-8a16-489f2bb59f11", "equipment_family_code": "sample string 8", "equipment_family": { "id": "acb26b8f-bb62-46a9-b0ed-386881dd5128", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "64c22389-11e2-47ca-b6cb-4da7eaffb4fa", "_parent_code": "sample string 6", "sales_organization_id": "d11ea245-bdb5-4824-8a80-35c2272cc217", "sales_organization_code": "sample string 8", "sales_organization": { "id": "79003382-b9f4-46a1-87b7-5af2c56b308b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c1065d7d-3830-4cff-8711-a79259d1c410", "db_currency_id": "b1543e0b-29a3-411a-9adf-619616f65221", "db_language_id": "59164aa3-48a5-4059-bed1-a839de6ba7d1", "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-06T22:36:42.3065794+00:00" }, "modified_dateutc": "2025-07-06T22:36:42.3065794+00:00" }, "date_in_production_since": "2025-07-06T22:36:42.3065794+00:00", "date_out_of_production_since": "2025-07-06T22:36:42.3065794+00:00", "date_end_support": "2025-07-06T22:36:42.3065794+00:00", "sales_organization_id": "e5b0349c-d1e6-4050-92d2-486e355c9743", "sales_organization_code": "sample string 13", "sales_organization": { "id": "79003382-b9f4-46a1-87b7-5af2c56b308b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c1065d7d-3830-4cff-8711-a79259d1c410", "db_currency_id": "b1543e0b-29a3-411a-9adf-619616f65221", "db_language_id": "59164aa3-48a5-4059-bed1-a839de6ba7d1", "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-06T22:36:42.3065794+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-06T22:36:42.3065794+00:00" }, "project_status_id": "8b3cf527-15e7-4e71-9bb7-ba853739bf5c", "project_status_code": "sample string 10", "project_status": { "id": "7721a4c5-f693-4a97-9010-cbc7acbef69b", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "0dfbbc80-d2b3-4ce7-8e7d-592d5b667563", "sales_organization_code": "sample string 6", "sales_organization": { "id": "79003382-b9f4-46a1-87b7-5af2c56b308b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c1065d7d-3830-4cff-8711-a79259d1c410", "db_currency_id": "b1543e0b-29a3-411a-9adf-619616f65221", "db_language_id": "59164aa3-48a5-4059-bed1-a839de6ba7d1", "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-06T22:36:42.3065794+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-06T22:36:42.3065794+00:00" }, "company_id": "e76474b9-d57f-4e95-8273-d535c4f36c69", "company_code": "sample string 12", "db_address_id": "4105bef6-891d-41bc-9ccd-2cdbf7f8748a", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "80290ced-26c5-4b49-91db-2e323e4cc470", "contact_reference_back_office": "sample string 17", "owner_user_id": "5c0a3347-e9a6-4842-ad53-9ae6d4f8aaaf", "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-06T22:36:42.3065794+00:00", "date_create": "2025-07-06T22:36:42.3065794+00:00", "date_update": "2025-07-06T22:36:42.3065794+00:00", "updated_by_user_id": "bf5fb213-85cd-4e1d-9b12-00dedd1a7bb0", "customer_reference": "sample string 28", "warranty_date_until": "2025-07-06T22:36:42.3065794+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-06T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-07-06T22:36:42.3065794+00:00", "date_last_job": "2025-07-06T22:36:42.3065794+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-07-06T22:36:42.3065794+00:00", "modified_dateutc": "2025-07-06T22:36:42.3065794+00:00", "is_mobile_installation": true }, "job_type_id": "6b5c8f7d-3380-46e2-8c39-8fd39eed0964", "job_type_code": "sample string 7", "job_type": { "id": "12afa9b5-dcae-482d-84bb-5549d097aad9", "name": "sample string 2", "sales_organization_id": "f73baad0-dd95-4e66-b357-737bddd32910", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-07-06T22:36:42.3065794+00:00", "code": "sample string 7" }, "job_priority_id": "110615bd-275a-462e-ae07-4f81b6d7cebb", "job_priority_code": "sample string 9", "job_priority": { "id": "1afab191-8acc-41d7-a9ae-0fe8f1ecd4b9", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "85ebde3a-e209-45f9-a9ab-8a681636b48a", "sales_organization_code": "sample string 6", "sales_organization": { "id": "79003382-b9f4-46a1-87b7-5af2c56b308b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c1065d7d-3830-4cff-8711-a79259d1c410", "db_currency_id": "b1543e0b-29a3-411a-9adf-619616f65221", "db_language_id": "59164aa3-48a5-4059-bed1-a839de6ba7d1", "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-06T22:36:42.3065794+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-06T22:36:42.3065794+00:00" }, "job_status_id": "aa0ffa2d-6921-4645-bd83-8a6351593f57", "job_status_code": "sample string 11", "db_address_id": "e3b088b8-fbbd-4112-94ed-83e18c38a064", "contact_id": "f4329ea4-fd80-4b10-a5b4-f3542e53df5f", "requested_by_company_id": "90e894a5-f67f-45fc-ae29-77b4f7066ee0", "requested_by_contact_id": "7ffb805b-2b13-4b1b-8fda-11ac051d8321", "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-06T22:36:42.3065794+00:00", "due_date": "2025-07-06T22:36:42.3065794+00:00", "date_create": "2025-07-06T22:36:42.3065794+00:00", "date_update": "2025-07-06T22:36:42.3065794+00:00", "date_closed": "2025-07-06T22:36:42.3065794+00:00", "suggested_user_id": "127f2643-1b1c-4b4f-ab63-ff8f0e271ad9", "suggested_user_code": "sample string 29", "suggested_user": { "id": "1ef613f8-ce86-42ca-a6f7-143ba04230c2", "db_language_id": "94487bc4-aaae-47ad-8e52-7fe35bd74ee2", "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-06T22:36:42.3222015+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "ddc4bb79-1c42-4ff3-9014-cb26c04b567c", "sales_organization": { "id": "79003382-b9f4-46a1-87b7-5af2c56b308b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c1065d7d-3830-4cff-8711-a79259d1c410", "db_currency_id": "b1543e0b-29a3-411a-9adf-619616f65221", "db_language_id": "59164aa3-48a5-4059-bed1-a839de6ba7d1", "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-06T22:36:42.3065794+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "9637e20f-a6e5-4329-82dc-7c5be55f2dff", "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": "1ccb6ddf-28a4-42ce-b3b9-e7a7658c6c7b", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-07-06T22:36:42.3222015+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "e4571818-7e7e-4f4e-85dc-729e94233552" }, "suggested_date_start": "2025-07-06T22:36:42.3222015+00:00", "skill_id": "a86f1495-a324-42d0-aa3b-cb57020dbb86", "skill_code": "sample string 32", "skill": { "id": "4b605444-e866-41d8-848a-810248ea318f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "9744129a-3356-43dc-8fc8-fa446de48223", "sales_organization_code": "sample string 6", "sales_organization": { "id": "79003382-b9f4-46a1-87b7-5af2c56b308b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c1065d7d-3830-4cff-8711-a79259d1c410", "db_currency_id": "b1543e0b-29a3-411a-9adf-619616f65221", "db_language_id": "59164aa3-48a5-4059-bed1-a839de6ba7d1", "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-06T22:36:42.3065794+00:00" }, "modified_dateutc": "2025-07-06T22:36:42.3222015+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "a42f49ef-7f03-49a6-aa97-6320411c4f67", "date_reported_by_company": "2025-07-06T22:36:42.3222015+00:00", "id2": 36, "company_id": "7f08ba3c-d3b0-4aaa-8a43-13f76ffaa0e6", "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": "1bc18878-0925-447a-bb92-371b320c65e0", "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-06T22:36:42.3222015+00:00" }