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": "d1116181-50cf-4f9e-ad7a-657604108a43", "_parent_id": "81afbf47-9602-4abc-b884-925be37ed5a2", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "e053ede8-21bb-4409-acf2-b878de5bdde6", "project_reference_back_office": "sample string 5", "project": { "id": "e73626a8-eae3-4f36-851e-d9f7dba546e8", "_parent_id": "4c238202-0265-4686-8bab-e1a5584c7fa0", "root_parent_id": "66a70a96-4ea1-4d1d-97c0-e3e1de7add04", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "015f0258-6e56-404c-9a1b-32cab8b2dfad", "equipment_family_code": "sample string 6", "equipment_family": { "id": "4c28c7fc-6d28-45c7-b61f-63a03e99b2f1", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "67609bf7-8002-4063-8092-7e02d2253f43", "_parent_code": "sample string 6", "sales_organization_id": "462d6aeb-2191-4849-a6e5-a209345d8fa1", "sales_organization_code": "sample string 8", "sales_organization": { "id": "99601a15-94ec-4b0b-bb5b-a08ff69d244b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b50362c8-c6e8-4a6a-8c43-c5acf155f7a6", "db_currency_id": "20c21007-f14e-4234-ad65-6caa12413120", "db_language_id": "55d87fcc-b376-4ff5-9cd1-22ac5decea72", "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-05-18T02:12:57.6530973+00:00" }, "modified_dateutc": "2025-05-18T02:12:57.6530973+00:00" }, "equipment_model_id": "669cc621-1333-4c88-896b-74e4376106b1", "equipment_model_code": "sample string 8", "equipment_model": { "id": "518d129b-fdd0-451f-ae5d-abd1d7da8875", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "98b9c8f0-6d84-4488-a5e9-2e48c425bdae", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "fd970a7a-9c03-4872-b147-8ffde6438f87", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "1c40d004-2a19-44a6-a056-9249ee59d296", "sales_organization_code": "sample string 5", "sales_organization": { "id": "99601a15-94ec-4b0b-bb5b-a08ff69d244b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b50362c8-c6e8-4a6a-8c43-c5acf155f7a6", "db_currency_id": "20c21007-f14e-4234-ad65-6caa12413120", "db_language_id": "55d87fcc-b376-4ff5-9cd1-22ac5decea72", "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-05-18T02:12:57.6530973+00:00" }, "modified_dateutc": "2025-05-18T02:12:57.6530973+00:00" }, "equipment_family_id": "36b042f8-d6f1-49ae-a0cb-bc1132f8127f", "equipment_family_code": "sample string 8", "equipment_family": { "id": "4c28c7fc-6d28-45c7-b61f-63a03e99b2f1", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "67609bf7-8002-4063-8092-7e02d2253f43", "_parent_code": "sample string 6", "sales_organization_id": "462d6aeb-2191-4849-a6e5-a209345d8fa1", "sales_organization_code": "sample string 8", "sales_organization": { "id": "99601a15-94ec-4b0b-bb5b-a08ff69d244b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b50362c8-c6e8-4a6a-8c43-c5acf155f7a6", "db_currency_id": "20c21007-f14e-4234-ad65-6caa12413120", "db_language_id": "55d87fcc-b376-4ff5-9cd1-22ac5decea72", "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-05-18T02:12:57.6530973+00:00" }, "modified_dateutc": "2025-05-18T02:12:57.6530973+00:00" }, "date_in_production_since": "2025-05-18T02:12:57.6530973+00:00", "date_out_of_production_since": "2025-05-18T02:12:57.6530973+00:00", "date_end_support": "2025-05-18T02:12:57.6530973+00:00", "sales_organization_id": "906cc9aa-a8d9-4c9d-a7e2-0b8daf9f8621", "sales_organization_code": "sample string 13", "sales_organization": { "id": "99601a15-94ec-4b0b-bb5b-a08ff69d244b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b50362c8-c6e8-4a6a-8c43-c5acf155f7a6", "db_currency_id": "20c21007-f14e-4234-ad65-6caa12413120", "db_language_id": "55d87fcc-b376-4ff5-9cd1-22ac5decea72", "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-05-18T02:12:57.6530973+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-05-18T02:12:57.6530973+00:00" }, "project_status_id": "4c55f929-108e-4361-9fb4-486957657290", "project_status_code": "sample string 10", "project_status": { "id": "33f37028-255c-4769-9a42-d67ec7ce98c3", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "ccd4a02d-6f77-43a6-af8c-cb189394b98a", "sales_organization_code": "sample string 6", "sales_organization": { "id": "99601a15-94ec-4b0b-bb5b-a08ff69d244b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b50362c8-c6e8-4a6a-8c43-c5acf155f7a6", "db_currency_id": "20c21007-f14e-4234-ad65-6caa12413120", "db_language_id": "55d87fcc-b376-4ff5-9cd1-22ac5decea72", "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-05-18T02:12:57.6530973+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-05-18T02:12:57.6530973+00:00" }, "company_id": "4dce218b-6153-4c81-bf3f-fc8132d92c58", "company_code": "sample string 12", "db_address_id": "4245062f-7b7c-434c-944c-58562ae980a6", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "71ff37c0-1a6b-4974-9d49-178556b258d5", "contact_reference_back_office": "sample string 17", "owner_user_id": "09af3d42-4a35-4cf6-a011-43843e67c808", "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-05-18T02:12:57.6530973+00:00", "date_create": "2025-05-18T02:12:57.6530973+00:00", "date_update": "2025-05-18T02:12:57.6530973+00:00", "updated_by_user_id": "b68b3fa6-e2f0-479a-862f-6c09a2c2655f", "customer_reference": "sample string 28", "warranty_date_until": "2025-05-18T02:12:57.6530973+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-05-18T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-05-18T02:12:57.6530973+00:00", "date_last_job": "2025-05-18T02:12:57.6530973+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-05-18T02:12:57.6530973+00:00", "modified_dateutc": "2025-05-18T02:12:57.6530973+00:00", "is_mobile_installation": true }, "job_type_id": "d6537262-2e94-4296-8339-0f6ff5ed1ebe", "job_type_code": "sample string 7", "job_type": { "id": "0cacfa23-c4c3-4538-b9a6-5ae2fd125557", "name": "sample string 2", "sales_organization_id": "bc4de0cc-7a55-42d9-8121-11d14e6fb652", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-05-18T02:12:57.6530973+00:00", "code": "sample string 7" }, "job_priority_id": "5b328d03-1972-4639-9fd9-3e8187d6479a", "job_priority_code": "sample string 9", "job_priority": { "id": "b7bde59a-063b-4d5c-bd53-378a6a8d81da", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "9b1cc3d9-f275-4322-9d17-d7447256c05e", "sales_organization_code": "sample string 6", "sales_organization": { "id": "99601a15-94ec-4b0b-bb5b-a08ff69d244b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b50362c8-c6e8-4a6a-8c43-c5acf155f7a6", "db_currency_id": "20c21007-f14e-4234-ad65-6caa12413120", "db_language_id": "55d87fcc-b376-4ff5-9cd1-22ac5decea72", "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-05-18T02:12:57.6530973+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-05-18T02:12:57.6530973+00:00" }, "job_status_id": "41ca5dfa-aeef-4694-9fa0-186b373c1189", "job_status_code": "sample string 11", "db_address_id": "9426a337-b370-48c0-b998-89d6518f689c", "contact_id": "4260439c-c91b-4682-8794-3a0672d35ec3", "requested_by_company_id": "6a1f2a9a-2b6c-4b65-9143-dce30d064533", "requested_by_contact_id": "7321fc81-a63f-4216-a8fe-446947cca011", "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-05-18T02:12:57.6530973+00:00", "due_date": "2025-05-18T02:12:57.6530973+00:00", "date_create": "2025-05-18T02:12:57.6530973+00:00", "date_update": "2025-05-18T02:12:57.6530973+00:00", "date_closed": "2025-05-18T02:12:57.6530973+00:00", "suggested_user_id": "cbfacffa-49e7-46dc-a16e-8c4199a8f58a", "suggested_user_code": "sample string 29", "suggested_user": { "id": "bfed3561-3438-45b9-b898-0b31fe4284ae", "db_language_id": "ce746c15-532e-4cd1-8f54-885ea587a337", "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-05-18T02:12:57.6530973+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "e49ba149-b173-4fd3-8f87-6fc21422e402", "sales_organization": { "id": "99601a15-94ec-4b0b-bb5b-a08ff69d244b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b50362c8-c6e8-4a6a-8c43-c5acf155f7a6", "db_currency_id": "20c21007-f14e-4234-ad65-6caa12413120", "db_language_id": "55d87fcc-b376-4ff5-9cd1-22ac5decea72", "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-05-18T02:12:57.6530973+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "a6a32b79-5c9e-4196-88fb-a5ae1a6ccb9f", "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": "b19e7fc4-85ae-4d2a-abbe-afdf20b62e83", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-05-18T02:12:57.6530973+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "9b77a904-2d66-4ebf-a223-ebcd05ddcd47" }, "suggested_date_start": "2025-05-18T02:12:57.6530973+00:00", "skill_id": "880c532e-b3d6-4b14-a7ea-7335a8793885", "skill_code": "sample string 32", "skill": { "id": "e5770971-e410-4bcb-8301-34fd6686f32c", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "a7bdf881-da9a-4e35-8c56-e2848df7762d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "99601a15-94ec-4b0b-bb5b-a08ff69d244b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b50362c8-c6e8-4a6a-8c43-c5acf155f7a6", "db_currency_id": "20c21007-f14e-4234-ad65-6caa12413120", "db_language_id": "55d87fcc-b376-4ff5-9cd1-22ac5decea72", "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-05-18T02:12:57.6530973+00:00" }, "modified_dateutc": "2025-05-18T02:12:57.6530973+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "9a5325e5-2231-4af2-8be1-ba29d7f47a2f", "date_reported_by_company": "2025-05-18T02:12:57.6530973+00:00", "id2": 36, "company_id": "d7277ea4-e781-44a3-b4bf-0ad2e0943342", "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": "a89ec4c9-3093-406c-936d-8d5eaa6c719e", "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-05-18T02:12:57.6530973+00:00" }