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": "2fd8a7c9-f592-445d-89bd-6c3d0a8bc940", "_parent_id": "b9392870-b050-4a04-aa7f-30419ee62e2b", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "3a8b95d1-1c0e-48d3-b075-60945c312848", "project_reference_back_office": "sample string 5", "project": { "id": "14270df5-fc82-4556-ae64-8a5df7a6506e", "_parent_id": "9e8095bf-f548-482a-a63a-f14ed8797d0f", "root_parent_id": "65794409-6ff7-4d10-ae13-492d0d4341af", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "bc2072e4-4854-45e5-9fd9-cd3efdbd4956", "equipment_family_code": "sample string 6", "equipment_family": { "id": "ae232c04-3a7a-45b2-a18f-2f07c6f04c20", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "415f071c-eb37-42af-afc4-41be9accc7a3", "_parent_code": "sample string 6", "sales_organization_id": "4a12a08f-8cd1-4205-b93f-b4c1d301518b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "e46ad57b-e266-4279-a4aa-37ef8dd05394", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "57406b09-c87a-415d-912c-698b13ee4eac", "db_currency_id": "4a5e48a0-f69c-41c8-9613-293305a96398", "db_language_id": "1f48cc80-3101-4d19-b633-4938ce3e8621", "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-09-13T11:24:21.0054404+00:00" }, "modified_dateutc": "2025-09-13T11:24:21.0054404+00:00" }, "equipment_model_id": "36532bdf-3c98-4e3b-8f08-f57f4b3c7969", "equipment_model_code": "sample string 8", "equipment_model": { "id": "8bae5b38-289a-4b7c-af25-0b9a58f3f80f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "9b63a430-5117-4802-91df-71c9e7eb0095", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "23704237-857e-4b4c-b520-624d903526c5", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "a8acfc5d-5441-4f95-bdf8-78bcc20e266c", "sales_organization_code": "sample string 5", "sales_organization": { "id": "e46ad57b-e266-4279-a4aa-37ef8dd05394", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "57406b09-c87a-415d-912c-698b13ee4eac", "db_currency_id": "4a5e48a0-f69c-41c8-9613-293305a96398", "db_language_id": "1f48cc80-3101-4d19-b633-4938ce3e8621", "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-09-13T11:24:21.0054404+00:00" }, "modified_dateutc": "2025-09-13T11:24:21.0054404+00:00" }, "equipment_family_id": "227c8067-5476-4d45-b943-191cae7298c6", "equipment_family_code": "sample string 8", "equipment_family": { "id": "ae232c04-3a7a-45b2-a18f-2f07c6f04c20", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "415f071c-eb37-42af-afc4-41be9accc7a3", "_parent_code": "sample string 6", "sales_organization_id": "4a12a08f-8cd1-4205-b93f-b4c1d301518b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "e46ad57b-e266-4279-a4aa-37ef8dd05394", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "57406b09-c87a-415d-912c-698b13ee4eac", "db_currency_id": "4a5e48a0-f69c-41c8-9613-293305a96398", "db_language_id": "1f48cc80-3101-4d19-b633-4938ce3e8621", "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-09-13T11:24:21.0054404+00:00" }, "modified_dateutc": "2025-09-13T11:24:21.0054404+00:00" }, "date_in_production_since": "2025-09-13T11:24:21.0054404+00:00", "date_out_of_production_since": "2025-09-13T11:24:21.0054404+00:00", "date_end_support": "2025-09-13T11:24:21.0054404+00:00", "sales_organization_id": "5e8356f8-82e2-4960-aaf0-38363af31a50", "sales_organization_code": "sample string 13", "sales_organization": { "id": "e46ad57b-e266-4279-a4aa-37ef8dd05394", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "57406b09-c87a-415d-912c-698b13ee4eac", "db_currency_id": "4a5e48a0-f69c-41c8-9613-293305a96398", "db_language_id": "1f48cc80-3101-4d19-b633-4938ce3e8621", "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-09-13T11:24:21.0054404+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-09-13T11:24:21.0054404+00:00" }, "project_status_id": "30ee52fc-63a8-4466-8ba1-400935a12ead", "project_status_code": "sample string 10", "project_status": { "id": "7d47c9d4-4abd-4a8b-aba4-f6ddcf4a78a9", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "a51fd93e-9b11-47d4-bc2d-0dcf47083a89", "sales_organization_code": "sample string 6", "sales_organization": { "id": "e46ad57b-e266-4279-a4aa-37ef8dd05394", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "57406b09-c87a-415d-912c-698b13ee4eac", "db_currency_id": "4a5e48a0-f69c-41c8-9613-293305a96398", "db_language_id": "1f48cc80-3101-4d19-b633-4938ce3e8621", "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-09-13T11:24:21.0054404+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-09-13T11:24:21.0054404+00:00" }, "company_id": "2de9f211-a1c4-4ba6-8b19-3f8b9ba42b4d", "company_code": "sample string 12", "db_address_id": "f97dc86f-dd9c-473c-b874-e0d45ca6913e", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "699dbf1b-6f31-4b28-9e1a-5849e0c16eb9", "contact_reference_back_office": "sample string 17", "owner_user_id": "b9f070c1-2cdd-453f-b4ba-8da917a19d05", "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-09-13T11:24:21.0054404+00:00", "date_create": "2025-09-13T11:24:21.0054404+00:00", "date_update": "2025-09-13T11:24:21.0054404+00:00", "updated_by_user_id": "d272e120-9841-4d5c-8398-5e93b0d20d00", "customer_reference": "sample string 28", "warranty_date_until": "2025-09-13T11:24:21.0054404+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-09-13T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-09-13T11:24:21.0054404+00:00", "date_last_job": "2025-09-13T11:24:21.0054404+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-09-13T11:24:21.0054404+00:00", "modified_dateutc": "2025-09-13T11:24:21.0054404+00:00", "is_mobile_installation": true }, "job_type_id": "c322afe1-eb07-4a20-b379-9917fe63aac2", "job_type_code": "sample string 7", "job_type": { "id": "aa9aeb3b-0ed9-43cd-954a-985f2b2718a3", "name": "sample string 2", "sales_organization_id": "e8a6d3ff-3fd7-4479-926f-b01fca9ad7d5", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-09-13T11:24:21.0054404+00:00", "code": "sample string 7" }, "job_priority_id": "a58d853b-38f7-438e-b8b8-621c6dd06684", "job_priority_code": "sample string 9", "job_priority": { "id": "3c99c388-cd81-4189-979f-4b6bc7e0dece", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "41ea16ee-4fbc-4bae-8874-a345b30ea4f1", "sales_organization_code": "sample string 6", "sales_organization": { "id": "e46ad57b-e266-4279-a4aa-37ef8dd05394", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "57406b09-c87a-415d-912c-698b13ee4eac", "db_currency_id": "4a5e48a0-f69c-41c8-9613-293305a96398", "db_language_id": "1f48cc80-3101-4d19-b633-4938ce3e8621", "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-09-13T11:24:21.0054404+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-09-13T11:24:21.0054404+00:00" }, "job_status_id": "f3a7c2f4-978d-41ef-a964-179e433b64bc", "job_status_code": "sample string 11", "db_address_id": "66c87323-8c58-4e06-a3fc-66c29ccb1508", "contact_id": "3ff67207-2eb7-46d0-967d-f5ada0e9b84a", "requested_by_company_id": "cbcd29c9-0061-43f5-a294-ce3668ec13ac", "requested_by_contact_id": "929fdbfd-6058-43af-911f-90927618e86c", "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-09-13T11:24:21.0054404+00:00", "due_date": "2025-09-13T11:24:21.0054404+00:00", "date_create": "2025-09-13T11:24:21.0054404+00:00", "date_update": "2025-09-13T11:24:21.0054404+00:00", "date_closed": "2025-09-13T11:24:21.0054404+00:00", "suggested_user_id": "492fcc9b-494f-4e85-a9b9-de253e42132c", "suggested_user_code": "sample string 29", "suggested_user": { "id": "812c518f-bd1e-452b-9442-d9b3ac021d62", "db_language_id": "54ba7eba-7cab-4435-9c44-5257e131a7e0", "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-09-13T11:24:21.0054404+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "604c456d-0988-4c1d-a3a5-52b3a8209fad", "sales_organization": { "id": "e46ad57b-e266-4279-a4aa-37ef8dd05394", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "57406b09-c87a-415d-912c-698b13ee4eac", "db_currency_id": "4a5e48a0-f69c-41c8-9613-293305a96398", "db_language_id": "1f48cc80-3101-4d19-b633-4938ce3e8621", "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-09-13T11:24:21.0054404+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "4a4ae5d5-a2f9-42f6-835f-c17f7afe33b8", "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": "ccf5978f-3c71-4e2c-bb7b-bdfb0ae5fc0c", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-09-13T11:24:21.0054404+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "56c87436-cbe6-430b-879f-09957acb18cd" }, "suggested_date_start": "2025-09-13T11:24:21.0054404+00:00", "skill_id": "b4dd7294-d91e-44e1-8712-4fe8971c2ed8", "skill_code": "sample string 32", "skill": { "id": "5a54fb8f-6e0c-4355-9d4b-215a6b356a27", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "6f29cacc-6e92-4187-9571-d734627f461e", "sales_organization_code": "sample string 6", "sales_organization": { "id": "e46ad57b-e266-4279-a4aa-37ef8dd05394", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "57406b09-c87a-415d-912c-698b13ee4eac", "db_currency_id": "4a5e48a0-f69c-41c8-9613-293305a96398", "db_language_id": "1f48cc80-3101-4d19-b633-4938ce3e8621", "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-09-13T11:24:21.0054404+00:00" }, "modified_dateutc": "2025-09-13T11:24:21.0054404+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "19c2bd72-db46-454e-92d2-3e92cdd0b04b", "date_reported_by_company": "2025-09-13T11:24:21.0054404+00:00", "id2": 36, "company_id": "1e82da1c-ad53-4d93-859a-6fb6805486e7", "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": "d26cb333-e568-4cc4-bade-eeab6e58b3df", "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-09-13T11:24:21.0054404+00:00" }