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": "c0e541ae-6bba-4d71-9ab6-a290017646fc", "_parent_id": "922c7181-ac66-48ee-a737-a6fe1e2e9791", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "f2df1764-bdfc-4c53-98ca-5b566e09cbbe", "project_reference_back_office": "sample string 5", "project": { "id": "5eae18eb-0051-4abf-bf29-fb03609e7328", "_parent_id": "a3510cd1-fc7a-46fd-8db0-b71023d80344", "root_parent_id": "f0062420-787e-4d03-9fac-f866382e0cd1", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "ad2111d7-8690-47ac-a26f-898b576705e3", "equipment_family_code": "sample string 6", "equipment_family": { "id": "456461d0-611e-4cca-9179-a0430623b277", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "50701a4a-e768-43d7-be5e-79a6b6d03017", "_parent_code": "sample string 6", "sales_organization_id": "7f75fee9-8e99-4b8a-981e-d456bad73465", "sales_organization_code": "sample string 8", "sales_organization": { "id": "1c479875-a79c-4984-b54d-c25425b99e65", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "0e6e193f-a7f8-4f5d-8c4e-f6439bd0d5ec", "db_currency_id": "3880dd4b-e5bc-457c-874c-04b2da6fea2b", "db_language_id": "7c3cbc27-50b1-4f23-8acb-1780695d5596", "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-18T23:51:02.7765823+00:00" }, "modified_dateutc": "2025-07-18T23:51:02.7765823+00:00" }, "equipment_model_id": "b5d290b9-71c5-4d3f-bd35-788b6129eae7", "equipment_model_code": "sample string 8", "equipment_model": { "id": "d168ed48-4aff-4188-836e-71672aa91f3a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "7d7a6318-2e50-4a46-acd7-e6cc69c9117d", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "d8027dba-126c-418b-b097-3e16088690db", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "d85536b7-ad4f-44c9-a1d3-25d5ff19a730", "sales_organization_code": "sample string 5", "sales_organization": { "id": "1c479875-a79c-4984-b54d-c25425b99e65", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "0e6e193f-a7f8-4f5d-8c4e-f6439bd0d5ec", "db_currency_id": "3880dd4b-e5bc-457c-874c-04b2da6fea2b", "db_language_id": "7c3cbc27-50b1-4f23-8acb-1780695d5596", "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-18T23:51:02.7765823+00:00" }, "modified_dateutc": "2025-07-18T23:51:02.7765823+00:00" }, "equipment_family_id": "7a63e011-0192-47a6-8019-624957ce496c", "equipment_family_code": "sample string 8", "equipment_family": { "id": "456461d0-611e-4cca-9179-a0430623b277", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "50701a4a-e768-43d7-be5e-79a6b6d03017", "_parent_code": "sample string 6", "sales_organization_id": "7f75fee9-8e99-4b8a-981e-d456bad73465", "sales_organization_code": "sample string 8", "sales_organization": { "id": "1c479875-a79c-4984-b54d-c25425b99e65", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "0e6e193f-a7f8-4f5d-8c4e-f6439bd0d5ec", "db_currency_id": "3880dd4b-e5bc-457c-874c-04b2da6fea2b", "db_language_id": "7c3cbc27-50b1-4f23-8acb-1780695d5596", "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-18T23:51:02.7765823+00:00" }, "modified_dateutc": "2025-07-18T23:51:02.7765823+00:00" }, "date_in_production_since": "2025-07-18T23:51:02.7765823+00:00", "date_out_of_production_since": "2025-07-18T23:51:02.7765823+00:00", "date_end_support": "2025-07-18T23:51:02.7765823+00:00", "sales_organization_id": "ef4f5544-bfd5-4341-88cc-99e91fb498c7", "sales_organization_code": "sample string 13", "sales_organization": { "id": "1c479875-a79c-4984-b54d-c25425b99e65", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "0e6e193f-a7f8-4f5d-8c4e-f6439bd0d5ec", "db_currency_id": "3880dd4b-e5bc-457c-874c-04b2da6fea2b", "db_language_id": "7c3cbc27-50b1-4f23-8acb-1780695d5596", "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-18T23:51:02.7765823+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-18T23:51:02.7765823+00:00" }, "project_status_id": "5010dc95-24ba-4d14-bb60-0a7107e4e624", "project_status_code": "sample string 10", "project_status": { "id": "c1f73c8b-7086-473d-aff3-dbfdb3b77fe1", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "42fbe2af-e51d-4575-b847-52ef0027d7a7", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1c479875-a79c-4984-b54d-c25425b99e65", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "0e6e193f-a7f8-4f5d-8c4e-f6439bd0d5ec", "db_currency_id": "3880dd4b-e5bc-457c-874c-04b2da6fea2b", "db_language_id": "7c3cbc27-50b1-4f23-8acb-1780695d5596", "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-18T23:51:02.7765823+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-18T23:51:02.7765823+00:00" }, "company_id": "01e2a9c1-7947-4d4e-bcd9-774c6a4f2fce", "company_code": "sample string 12", "db_address_id": "78de1e19-c18b-47e7-adc6-26263ae7d92e", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "104c87d7-cb43-4c8c-9d0c-12e7f9028973", "contact_reference_back_office": "sample string 17", "owner_user_id": "79c9de15-fb40-4577-9f3d-0e2b39ffaf53", "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-18T23:51:02.7765823+00:00", "date_create": "2025-07-18T23:51:02.7765823+00:00", "date_update": "2025-07-18T23:51:02.7765823+00:00", "updated_by_user_id": "c38bbd0e-a8a5-441a-b854-ec7ef0cc62cc", "customer_reference": "sample string 28", "warranty_date_until": "2025-07-18T23:51:02.7765823+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-18T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-07-18T23:51:02.7765823+00:00", "date_last_job": "2025-07-18T23:51:02.7765823+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-07-18T23:51:02.7765823+00:00", "modified_dateutc": "2025-07-18T23:51:02.7765823+00:00", "is_mobile_installation": true }, "job_type_id": "3f0b7171-d166-42c5-a247-67fcd9ff5811", "job_type_code": "sample string 7", "job_type": { "id": "37658f28-0719-457f-a1d2-8f397980914b", "name": "sample string 2", "sales_organization_id": "2c1f62bc-0f21-4964-a323-f1f37fd3449c", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-07-18T23:51:02.7765823+00:00", "code": "sample string 7" }, "job_priority_id": "2f569c85-ce65-49b6-bd66-5b866ebaaab0", "job_priority_code": "sample string 9", "job_priority": { "id": "175bcbd8-81d1-4f44-9333-dfb431066731", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "848f02db-f53f-4392-8133-ad1733927321", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1c479875-a79c-4984-b54d-c25425b99e65", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "0e6e193f-a7f8-4f5d-8c4e-f6439bd0d5ec", "db_currency_id": "3880dd4b-e5bc-457c-874c-04b2da6fea2b", "db_language_id": "7c3cbc27-50b1-4f23-8acb-1780695d5596", "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-18T23:51:02.7765823+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-18T23:51:02.7765823+00:00" }, "job_status_id": "a727e395-c874-4356-ad0a-aaff0e266a07", "job_status_code": "sample string 11", "db_address_id": "7ad1ec60-808c-47e4-9191-498da768b210", "contact_id": "0eb31d42-dfd6-41ce-b800-7240014d9012", "requested_by_company_id": "320a9085-456d-4366-ba20-4afdd6fa95d8", "requested_by_contact_id": "fa09576e-ca59-432e-a62a-0afb7c73ec2f", "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-18T23:51:02.7765823+00:00", "due_date": "2025-07-18T23:51:02.7765823+00:00", "date_create": "2025-07-18T23:51:02.7765823+00:00", "date_update": "2025-07-18T23:51:02.7765823+00:00", "date_closed": "2025-07-18T23:51:02.7765823+00:00", "suggested_user_id": "0c1df24b-55e2-41d2-885f-ff3ded529733", "suggested_user_code": "sample string 29", "suggested_user": { "id": "6e882a6c-5b99-46ca-8827-8f8b5ccce7d6", "db_language_id": "9ee47cfd-20a1-4fd7-988c-3234feca77a4", "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-18T23:51:02.7765823+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "72781130-02e8-4288-8c91-384bd469c572", "sales_organization": { "id": "1c479875-a79c-4984-b54d-c25425b99e65", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "0e6e193f-a7f8-4f5d-8c4e-f6439bd0d5ec", "db_currency_id": "3880dd4b-e5bc-457c-874c-04b2da6fea2b", "db_language_id": "7c3cbc27-50b1-4f23-8acb-1780695d5596", "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-18T23:51:02.7765823+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "f1e7e22b-a530-4bcb-b1e1-5a33521eb80b", "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": "33dc8c41-9597-40ce-aa5f-4bd9be4ce567", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-07-18T23:51:02.7922039+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "bbb62cf1-2a0a-4434-9ff8-9d97d6b50433" }, "suggested_date_start": "2025-07-18T23:51:02.7922039+00:00", "skill_id": "66b0698d-ebec-4ff5-bab9-ec03384cadf4", "skill_code": "sample string 32", "skill": { "id": "126ab978-94d3-42f3-9a08-70dc2bbfa693", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "b352c9ef-6a18-44a6-bdaf-b06f739a36f5", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1c479875-a79c-4984-b54d-c25425b99e65", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "0e6e193f-a7f8-4f5d-8c4e-f6439bd0d5ec", "db_currency_id": "3880dd4b-e5bc-457c-874c-04b2da6fea2b", "db_language_id": "7c3cbc27-50b1-4f23-8acb-1780695d5596", "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-18T23:51:02.7765823+00:00" }, "modified_dateutc": "2025-07-18T23:51:02.7922039+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "954d5368-7528-4c23-a600-65c55ff506e6", "date_reported_by_company": "2025-07-18T23:51:02.7922039+00:00", "id2": 36, "company_id": "58da7741-9f51-42ff-b8a2-c0ac58871c96", "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": "cbb08508-05e7-45ce-a69a-f1a5a63fcabe", "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-18T23:51:02.7922039+00:00" }