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": "d0c61c6a-7dc1-43e4-8cb2-cd99943032f6", "_parent_id": "97ac7e12-2398-472d-b153-be23d53505f8", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "3608cb63-0aea-47cb-b57a-6f67177e2c10", "project_reference_back_office": "sample string 5", "project": { "id": "39eb1fbd-dc1e-4c4a-9822-b084cd728428", "_parent_id": "4d72b56f-0b58-4739-be7b-4b6413a664b0", "root_parent_id": "4643a755-78c9-438e-b4cd-da09f45d8c80", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "74d7ee1e-1483-42c7-b10b-360021c34717", "equipment_family_code": "sample string 6", "equipment_family": { "id": "f5cea5fb-c2ad-458f-89d1-de2d50698256", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "e13ecb98-d8c6-4377-ac39-d07cac20f081", "_parent_code": "sample string 6", "sales_organization_id": "13cfd4ce-42e4-4331-8376-04cb1213deb5", "sales_organization_code": "sample string 8", "sales_organization": { "id": "290952d6-584e-4fef-a73d-fc80403e9b69", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4886d85d-7624-4ed5-b94c-9c6af5b4304d", "db_currency_id": "1fc515ee-3df8-4a3e-a8ac-543cb154870d", "db_language_id": "81e1f133-abcc-41e6-8180-bd7c6d19b12b", "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-06-05T18:53:57.2296491+00:00" }, "modified_dateutc": "2025-06-05T18:53:57.2296491+00:00" }, "equipment_model_id": "f46b45cf-3624-4a90-a0a3-c1d347f764d6", "equipment_model_code": "sample string 8", "equipment_model": { "id": "f0fbf8fb-c8e6-4bc4-b2cd-fd8aeb21e3f8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "fbdebba4-e4cf-4eef-b802-26cee76bbf85", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "883407c1-d265-4265-aa65-d36e7ba8cff4", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "1b64b7bc-1c04-4058-afe7-38d4fff14907", "sales_organization_code": "sample string 5", "sales_organization": { "id": "290952d6-584e-4fef-a73d-fc80403e9b69", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4886d85d-7624-4ed5-b94c-9c6af5b4304d", "db_currency_id": "1fc515ee-3df8-4a3e-a8ac-543cb154870d", "db_language_id": "81e1f133-abcc-41e6-8180-bd7c6d19b12b", "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-06-05T18:53:57.2296491+00:00" }, "modified_dateutc": "2025-06-05T18:53:57.2296491+00:00" }, "equipment_family_id": "6deff86e-a810-4d9a-948d-60553cc19336", "equipment_family_code": "sample string 8", "equipment_family": { "id": "f5cea5fb-c2ad-458f-89d1-de2d50698256", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "e13ecb98-d8c6-4377-ac39-d07cac20f081", "_parent_code": "sample string 6", "sales_organization_id": "13cfd4ce-42e4-4331-8376-04cb1213deb5", "sales_organization_code": "sample string 8", "sales_organization": { "id": "290952d6-584e-4fef-a73d-fc80403e9b69", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4886d85d-7624-4ed5-b94c-9c6af5b4304d", "db_currency_id": "1fc515ee-3df8-4a3e-a8ac-543cb154870d", "db_language_id": "81e1f133-abcc-41e6-8180-bd7c6d19b12b", "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-06-05T18:53:57.2296491+00:00" }, "modified_dateutc": "2025-06-05T18:53:57.2296491+00:00" }, "date_in_production_since": "2025-06-05T18:53:57.2296491+00:00", "date_out_of_production_since": "2025-06-05T18:53:57.2296491+00:00", "date_end_support": "2025-06-05T18:53:57.2296491+00:00", "sales_organization_id": "f5c9c0e5-5b95-4860-bae5-da9a36fb3e84", "sales_organization_code": "sample string 13", "sales_organization": { "id": "290952d6-584e-4fef-a73d-fc80403e9b69", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4886d85d-7624-4ed5-b94c-9c6af5b4304d", "db_currency_id": "1fc515ee-3df8-4a3e-a8ac-543cb154870d", "db_language_id": "81e1f133-abcc-41e6-8180-bd7c6d19b12b", "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-06-05T18:53:57.2296491+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-06-05T18:53:57.2296491+00:00" }, "project_status_id": "43dcfc95-cbb4-4e6c-bd72-e82575b08422", "project_status_code": "sample string 10", "project_status": { "id": "3199aa40-9de3-4f84-85cf-d0ed30e4ac9f", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "b706f567-1f7e-4e3d-9476-cc4b2bba83b7", "sales_organization_code": "sample string 6", "sales_organization": { "id": "290952d6-584e-4fef-a73d-fc80403e9b69", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4886d85d-7624-4ed5-b94c-9c6af5b4304d", "db_currency_id": "1fc515ee-3df8-4a3e-a8ac-543cb154870d", "db_language_id": "81e1f133-abcc-41e6-8180-bd7c6d19b12b", "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-06-05T18:53:57.2296491+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-05T18:53:57.2296491+00:00" }, "company_id": "e2bfd1b2-c19e-46b9-b2a0-023641c773bd", "company_code": "sample string 12", "db_address_id": "c7b06fa3-81e9-4ab9-8bf0-070868f6fedd", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "ba3b8197-dd34-4098-afda-c2ed600f7168", "contact_reference_back_office": "sample string 17", "owner_user_id": "ca949134-e10d-448d-9e7b-b5d9184edce9", "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-06-05T18:53:57.2296491+00:00", "date_create": "2025-06-05T18:53:57.2296491+00:00", "date_update": "2025-06-05T18:53:57.2296491+00:00", "updated_by_user_id": "7f981196-a35c-46b3-82ce-323ec92b8e0b", "customer_reference": "sample string 28", "warranty_date_until": "2025-06-05T18:53:57.2296491+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-06-05T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-06-05T18:53:57.2296491+00:00", "date_last_job": "2025-06-05T18:53:57.2296491+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-06-05T18:53:57.2296491+00:00", "modified_dateutc": "2025-06-05T18:53:57.2296491+00:00", "is_mobile_installation": true }, "job_type_id": "f1f20e75-54c5-47c3-b910-98aa4f58f112", "job_type_code": "sample string 7", "job_type": { "id": "58df6172-2867-420c-b754-dcb2134236b7", "name": "sample string 2", "sales_organization_id": "2c6d722a-ec45-4d75-be61-4081931a5507", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-06-05T18:53:57.2296491+00:00", "code": "sample string 7" }, "job_priority_id": "e226534a-6092-47ae-a9a7-9fc8fafce0e8", "job_priority_code": "sample string 9", "job_priority": { "id": "904de086-b138-4f2c-94f6-f86937cc2011", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "dfd35573-a6c5-4089-9806-fdfe3f825958", "sales_organization_code": "sample string 6", "sales_organization": { "id": "290952d6-584e-4fef-a73d-fc80403e9b69", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4886d85d-7624-4ed5-b94c-9c6af5b4304d", "db_currency_id": "1fc515ee-3df8-4a3e-a8ac-543cb154870d", "db_language_id": "81e1f133-abcc-41e6-8180-bd7c6d19b12b", "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-06-05T18:53:57.2296491+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-05T18:53:57.2296491+00:00" }, "job_status_id": "43e910d0-00e3-4845-a2eb-37d51b4d08be", "job_status_code": "sample string 11", "db_address_id": "fec4b382-995c-4b6a-835e-3482e26898d8", "contact_id": "dc92b950-08b2-4e60-8a8d-da56b20c8cb4", "requested_by_company_id": "b31ff2ad-de84-4d93-a858-90b4ef2c84df", "requested_by_contact_id": "3657c3c6-262c-4b18-9a97-a9699f5ff1df", "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-06-05T18:53:57.2296491+00:00", "due_date": "2025-06-05T18:53:57.2296491+00:00", "date_create": "2025-06-05T18:53:57.2296491+00:00", "date_update": "2025-06-05T18:53:57.2296491+00:00", "date_closed": "2025-06-05T18:53:57.2296491+00:00", "suggested_user_id": "32d8c8f4-e31a-466b-8132-e39ac13a9e94", "suggested_user_code": "sample string 29", "suggested_user": { "id": "fabd9306-5c72-4e0c-a382-7d7d3f74ffe7", "db_language_id": "1f518e5e-935e-4228-ac68-5086844237bb", "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-06-05T18:53:57.2296491+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "baf336de-f3f6-40cf-954d-d314d62596dd", "sales_organization": { "id": "290952d6-584e-4fef-a73d-fc80403e9b69", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4886d85d-7624-4ed5-b94c-9c6af5b4304d", "db_currency_id": "1fc515ee-3df8-4a3e-a8ac-543cb154870d", "db_language_id": "81e1f133-abcc-41e6-8180-bd7c6d19b12b", "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-06-05T18:53:57.2296491+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "232df1ce-2391-4a4c-ac0f-0edd46ea8657", "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": "0bb70617-5157-41c3-83d7-b8cd3de2c82b", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-06-05T18:53:57.2296491+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "8baae934-5521-47c5-ac91-43e79f1ecabc" }, "suggested_date_start": "2025-06-05T18:53:57.2296491+00:00", "skill_id": "7ee95078-3f66-4811-9264-17b3f4530917", "skill_code": "sample string 32", "skill": { "id": "3efe7730-3060-43ca-8658-163c26243f5f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "9181e0da-66ae-409d-90c8-ae74e7c9a1a9", "sales_organization_code": "sample string 6", "sales_organization": { "id": "290952d6-584e-4fef-a73d-fc80403e9b69", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4886d85d-7624-4ed5-b94c-9c6af5b4304d", "db_currency_id": "1fc515ee-3df8-4a3e-a8ac-543cb154870d", "db_language_id": "81e1f133-abcc-41e6-8180-bd7c6d19b12b", "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-06-05T18:53:57.2296491+00:00" }, "modified_dateutc": "2025-06-05T18:53:57.2296491+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "55fb2f64-9b5a-4b72-a7cd-df15fdc36f0c", "date_reported_by_company": "2025-06-05T18:53:57.2296491+00:00", "id2": 36, "company_id": "315bb40a-b90d-418f-a82e-5055b1149eeb", "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": "dacc0c9f-5549-4d16-9e4a-360617e60b78", "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-06-05T18:53:57.2296491+00:00" }