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": "ae17dae4-1776-4c75-9e46-05ebc442f1a9", "_parent_id": "5133ee54-2cc0-4ca2-be98-32def9f6f904", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "eedea2a2-514f-4cc6-90c5-954fb8da7687", "project_reference_back_office": "sample string 5", "project": { "id": "492c1b58-adb6-44a7-bb8e-b0e47ee74369", "_parent_id": "595ef671-5f82-4876-9007-f7ee881ab541", "root_parent_id": "9da61c21-5fee-4444-a88b-fc5e8e4f094f", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "612023ee-96dc-4b95-a0c9-a41573252931", "equipment_family_code": "sample string 6", "equipment_family": { "id": "d65d553d-731d-4716-8b8e-f8631ffba2fa", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "cb878214-396f-435a-bfcf-b4449ab32508", "_parent_code": "sample string 6", "sales_organization_id": "85f5b4ea-3b57-4d3a-8b05-0f70f8ddb008", "sales_organization_code": "sample string 8", "sales_organization": { "id": "49f40087-ac03-43dd-8b03-42d3cc098443", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "744b0721-0d91-4c01-a930-f04deb7a0405", "db_currency_id": "9b874c3b-8f52-40ff-b56a-f7d11651ab3a", "db_language_id": "34f1fcca-648a-4d8e-88b5-72df70ad8bc9", "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-04T14:39:12.2563747+00:00" }, "modified_dateutc": "2025-09-04T14:39:12.2563747+00:00" }, "equipment_model_id": "0a07fc62-fdf5-470e-8d91-393e0a85ff9b", "equipment_model_code": "sample string 8", "equipment_model": { "id": "03163f4a-8d88-430f-8854-870646bbd22e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "a23b0111-4c2a-4639-9b58-7c55ab867f3c", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "4f6a1059-19d4-4771-bb39-8edaa087df08", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "4862eb13-43e5-4af0-8f45-090a781085c0", "sales_organization_code": "sample string 5", "sales_organization": { "id": "49f40087-ac03-43dd-8b03-42d3cc098443", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "744b0721-0d91-4c01-a930-f04deb7a0405", "db_currency_id": "9b874c3b-8f52-40ff-b56a-f7d11651ab3a", "db_language_id": "34f1fcca-648a-4d8e-88b5-72df70ad8bc9", "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-04T14:39:12.2563747+00:00" }, "modified_dateutc": "2025-09-04T14:39:12.2563747+00:00" }, "equipment_family_id": "cc2dc338-d630-4c5f-b5ca-d5f8684f338e", "equipment_family_code": "sample string 8", "equipment_family": { "id": "d65d553d-731d-4716-8b8e-f8631ffba2fa", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "cb878214-396f-435a-bfcf-b4449ab32508", "_parent_code": "sample string 6", "sales_organization_id": "85f5b4ea-3b57-4d3a-8b05-0f70f8ddb008", "sales_organization_code": "sample string 8", "sales_organization": { "id": "49f40087-ac03-43dd-8b03-42d3cc098443", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "744b0721-0d91-4c01-a930-f04deb7a0405", "db_currency_id": "9b874c3b-8f52-40ff-b56a-f7d11651ab3a", "db_language_id": "34f1fcca-648a-4d8e-88b5-72df70ad8bc9", "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-04T14:39:12.2563747+00:00" }, "modified_dateutc": "2025-09-04T14:39:12.2563747+00:00" }, "date_in_production_since": "2025-09-04T14:39:12.2563747+00:00", "date_out_of_production_since": "2025-09-04T14:39:12.2563747+00:00", "date_end_support": "2025-09-04T14:39:12.2563747+00:00", "sales_organization_id": "ca741084-a0c8-43fe-880d-9128d417a611", "sales_organization_code": "sample string 13", "sales_organization": { "id": "49f40087-ac03-43dd-8b03-42d3cc098443", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "744b0721-0d91-4c01-a930-f04deb7a0405", "db_currency_id": "9b874c3b-8f52-40ff-b56a-f7d11651ab3a", "db_language_id": "34f1fcca-648a-4d8e-88b5-72df70ad8bc9", "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-04T14:39:12.2563747+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-04T14:39:12.2563747+00:00" }, "project_status_id": "44c6af23-db0b-4476-987e-3c7723803ec2", "project_status_code": "sample string 10", "project_status": { "id": "0be2c038-4a24-4b25-a85c-bed551662c90", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "1e93e301-5373-4590-a08c-7f2a2402280b", "sales_organization_code": "sample string 6", "sales_organization": { "id": "49f40087-ac03-43dd-8b03-42d3cc098443", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "744b0721-0d91-4c01-a930-f04deb7a0405", "db_currency_id": "9b874c3b-8f52-40ff-b56a-f7d11651ab3a", "db_language_id": "34f1fcca-648a-4d8e-88b5-72df70ad8bc9", "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-04T14:39:12.2563747+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-09-04T14:39:12.2563747+00:00" }, "company_id": "d03af357-d0c1-461a-bc6f-eb3f0da01b99", "company_code": "sample string 12", "db_address_id": "0fc00094-4cb4-458c-b470-105da5268259", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "1d613b28-1642-489d-85b2-cefea152fea9", "contact_reference_back_office": "sample string 17", "owner_user_id": "ed84f4a8-e0e0-49b3-bebd-1ac60269de80", "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-04T14:39:12.2719993+00:00", "date_create": "2025-09-04T14:39:12.2719993+00:00", "date_update": "2025-09-04T14:39:12.2719993+00:00", "updated_by_user_id": "3205aded-9b09-436e-bfcc-9e500c557a7a", "customer_reference": "sample string 28", "warranty_date_until": "2025-09-04T14:39:12.2719993+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-04T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-09-04T14:39:12.2719993+00:00", "date_last_job": "2025-09-04T14:39:12.2719993+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-09-04T14:39:12.2719993+00:00", "modified_dateutc": "2025-09-04T14:39:12.2719993+00:00", "is_mobile_installation": true }, "job_type_id": "07e334d3-28b8-42ac-8bdc-1a08ab573cca", "job_type_code": "sample string 7", "job_type": { "id": "ae09175b-575d-45d3-96cb-8f68451aac6f", "name": "sample string 2", "sales_organization_id": "7f4a0fc3-7809-4547-b0b0-d9a3fa492faa", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-09-04T14:39:12.2719993+00:00", "code": "sample string 7" }, "job_priority_id": "41f2f158-3860-496b-81bf-11ab111b56b7", "job_priority_code": "sample string 9", "job_priority": { "id": "966f2b41-beda-456c-8f6b-d6f4932cfa32", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "d6d3983d-7a6c-4f92-bdba-5095ce3cf75f", "sales_organization_code": "sample string 6", "sales_organization": { "id": "49f40087-ac03-43dd-8b03-42d3cc098443", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "744b0721-0d91-4c01-a930-f04deb7a0405", "db_currency_id": "9b874c3b-8f52-40ff-b56a-f7d11651ab3a", "db_language_id": "34f1fcca-648a-4d8e-88b5-72df70ad8bc9", "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-04T14:39:12.2563747+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-09-04T14:39:12.2719993+00:00" }, "job_status_id": "5d66310b-1533-4dc7-b56a-1b487ba5644d", "job_status_code": "sample string 11", "db_address_id": "b1131239-d855-4bd4-b0b3-4658d67c8820", "contact_id": "bb70b1c0-a85e-459b-a34b-799ada81fabd", "requested_by_company_id": "f3ee82ec-b630-4039-9f2b-7b81199fa820", "requested_by_contact_id": "e4118280-8078-4ce3-b8b9-0dc823e3993b", "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-04T14:39:12.2719993+00:00", "due_date": "2025-09-04T14:39:12.2719993+00:00", "date_create": "2025-09-04T14:39:12.2719993+00:00", "date_update": "2025-09-04T14:39:12.2719993+00:00", "date_closed": "2025-09-04T14:39:12.2719993+00:00", "suggested_user_id": "bbd8af77-ce5a-4b82-91f7-9be8f2bcf21a", "suggested_user_code": "sample string 29", "suggested_user": { "id": "ec5cca07-b12e-4e61-8239-6fcc577cd36f", "db_language_id": "2af6464e-4b44-4d33-af27-11aa9a86af7a", "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-04T14:39:12.2719993+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "abd6fcd7-d4d5-421c-8a1f-84b32714f94c", "sales_organization": { "id": "49f40087-ac03-43dd-8b03-42d3cc098443", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "744b0721-0d91-4c01-a930-f04deb7a0405", "db_currency_id": "9b874c3b-8f52-40ff-b56a-f7d11651ab3a", "db_language_id": "34f1fcca-648a-4d8e-88b5-72df70ad8bc9", "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-04T14:39:12.2563747+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "34295fa6-2cf1-44a8-b35a-d36b23afcb31", "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": "5969a26d-9c76-419b-bdc8-5f32fdd001b4", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-09-04T14:39:12.2719993+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "c3e65cdd-ad9d-4f25-a1c0-5ab4a0171995" }, "suggested_date_start": "2025-09-04T14:39:12.2719993+00:00", "skill_id": "27052925-45a3-4365-a48d-973a2ad6dcc3", "skill_code": "sample string 32", "skill": { "id": "339848cd-69d8-474e-8988-6ca4d79f7ff2", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "fd3aedbd-23eb-4bd2-9168-7e9137ba61bf", "sales_organization_code": "sample string 6", "sales_organization": { "id": "49f40087-ac03-43dd-8b03-42d3cc098443", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "744b0721-0d91-4c01-a930-f04deb7a0405", "db_currency_id": "9b874c3b-8f52-40ff-b56a-f7d11651ab3a", "db_language_id": "34f1fcca-648a-4d8e-88b5-72df70ad8bc9", "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-04T14:39:12.2563747+00:00" }, "modified_dateutc": "2025-09-04T14:39:12.2719993+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "a790bf8f-fb06-4aa5-a437-5e192c1c5351", "date_reported_by_company": "2025-09-04T14:39:12.2719993+00:00", "id2": 36, "company_id": "91d31ba9-fe31-4633-8bb1-187ade9a2ad6", "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": "0745bbfc-b3dc-4a8f-95b7-10b308535c37", "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-04T14:39:12.2719993+00:00" }