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": "bd9b7566-07d6-4c6b-8e0b-2975a24940d9", "_parent_id": "269168b3-37d7-421b-a543-afc6b38ed162", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "f93fe979-b4bc-4fd3-854b-cb6493a0c75a", "project_reference_back_office": "sample string 5", "project": { "id": "a79388f9-79fa-4cca-8e6e-c739b87e07af", "_parent_id": "617a1ebb-2cb3-4a7d-aae0-6565e80169f7", "root_parent_id": "e6a25d45-2195-40e6-ab25-629a79238338", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "661d707b-0e80-4af3-bf86-cec7330d1061", "equipment_family_code": "sample string 6", "equipment_family": { "id": "e55a3c54-af9d-458f-9712-2c932fd6539a", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "0c1ed4e1-ade8-431f-a32a-3cbfc9b74526", "_parent_code": "sample string 6", "sales_organization_id": "8c2aa353-b504-4066-9fe5-383dd3234a59", "sales_organization_code": "sample string 8", "sales_organization": { "id": "025b4e01-3ad0-4c08-8848-05c16ba69cfd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "511cdad9-60d5-406e-b2e0-e0de9d7e8fcf", "db_currency_id": "10ecb25a-ab25-4b29-8b29-478b8eab3cb2", "db_language_id": "2e4b9875-b389-46dd-9c77-1b80fd4697ee", "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-12T13:58:53.6895332+00:00" }, "modified_dateutc": "2025-07-12T13:58:53.6895332+00:00" }, "equipment_model_id": "98836c73-6dcb-4c1a-97b5-9618d03750fa", "equipment_model_code": "sample string 8", "equipment_model": { "id": "f1991492-ca8b-4e5e-92ba-e821d356a8f4", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "26e603cc-0b80-4817-b411-3be2681f49f7", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "aa7c9ab8-0d97-4ae8-a9bc-33c61383cba1", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "d63361aa-5175-4407-8a14-7ebf5f3586aa", "sales_organization_code": "sample string 5", "sales_organization": { "id": "025b4e01-3ad0-4c08-8848-05c16ba69cfd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "511cdad9-60d5-406e-b2e0-e0de9d7e8fcf", "db_currency_id": "10ecb25a-ab25-4b29-8b29-478b8eab3cb2", "db_language_id": "2e4b9875-b389-46dd-9c77-1b80fd4697ee", "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-12T13:58:53.6895332+00:00" }, "modified_dateutc": "2025-07-12T13:58:53.6895332+00:00" }, "equipment_family_id": "e963f8ac-0210-4bfc-8986-00231fed2888", "equipment_family_code": "sample string 8", "equipment_family": { "id": "e55a3c54-af9d-458f-9712-2c932fd6539a", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "0c1ed4e1-ade8-431f-a32a-3cbfc9b74526", "_parent_code": "sample string 6", "sales_organization_id": "8c2aa353-b504-4066-9fe5-383dd3234a59", "sales_organization_code": "sample string 8", "sales_organization": { "id": "025b4e01-3ad0-4c08-8848-05c16ba69cfd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "511cdad9-60d5-406e-b2e0-e0de9d7e8fcf", "db_currency_id": "10ecb25a-ab25-4b29-8b29-478b8eab3cb2", "db_language_id": "2e4b9875-b389-46dd-9c77-1b80fd4697ee", "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-12T13:58:53.6895332+00:00" }, "modified_dateutc": "2025-07-12T13:58:53.6895332+00:00" }, "date_in_production_since": "2025-07-12T13:58:53.6895332+00:00", "date_out_of_production_since": "2025-07-12T13:58:53.6895332+00:00", "date_end_support": "2025-07-12T13:58:53.6895332+00:00", "sales_organization_id": "35d23650-3ba2-4667-844e-231c23382ef4", "sales_organization_code": "sample string 13", "sales_organization": { "id": "025b4e01-3ad0-4c08-8848-05c16ba69cfd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "511cdad9-60d5-406e-b2e0-e0de9d7e8fcf", "db_currency_id": "10ecb25a-ab25-4b29-8b29-478b8eab3cb2", "db_language_id": "2e4b9875-b389-46dd-9c77-1b80fd4697ee", "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-12T13:58:53.6895332+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-12T13:58:53.6895332+00:00" }, "project_status_id": "79c3b01f-a430-46b1-b84a-451875416797", "project_status_code": "sample string 10", "project_status": { "id": "3506540a-4478-462a-a2b8-f03d418bd2d9", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "ce89c036-e587-4f05-b037-d93e08a8928a", "sales_organization_code": "sample string 6", "sales_organization": { "id": "025b4e01-3ad0-4c08-8848-05c16ba69cfd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "511cdad9-60d5-406e-b2e0-e0de9d7e8fcf", "db_currency_id": "10ecb25a-ab25-4b29-8b29-478b8eab3cb2", "db_language_id": "2e4b9875-b389-46dd-9c77-1b80fd4697ee", "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-12T13:58:53.6895332+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-12T13:58:53.6895332+00:00" }, "company_id": "7044ac54-e934-422e-9a07-b81e09d6a3a4", "company_code": "sample string 12", "db_address_id": "383a7b9a-04e7-48ed-adce-2e09abef4694", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "eb806ca2-2f2d-48f7-998a-202e835978f5", "contact_reference_back_office": "sample string 17", "owner_user_id": "4474f197-2316-440e-8ff6-09208ccd3825", "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-12T13:58:53.6895332+00:00", "date_create": "2025-07-12T13:58:53.6895332+00:00", "date_update": "2025-07-12T13:58:53.6895332+00:00", "updated_by_user_id": "360d4a3f-b644-4e22-8727-72b022cc348d", "customer_reference": "sample string 28", "warranty_date_until": "2025-07-12T13:58:53.6895332+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-12T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-07-12T13:58:53.6895332+00:00", "date_last_job": "2025-07-12T13:58:53.6895332+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-07-12T13:58:53.6895332+00:00", "modified_dateutc": "2025-07-12T13:58:53.6895332+00:00", "is_mobile_installation": true }, "job_type_id": "95c616f1-64d0-43c2-a3f9-de9f1f1f8926", "job_type_code": "sample string 7", "job_type": { "id": "35246d3b-c9e4-46e5-8d81-ba312c0ddc2e", "name": "sample string 2", "sales_organization_id": "eefa5af0-6f73-4549-a99f-f5975e8f6af8", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-07-12T13:58:53.6895332+00:00", "code": "sample string 7" }, "job_priority_id": "5a064450-1771-4641-9ac2-8e54095ba9ed", "job_priority_code": "sample string 9", "job_priority": { "id": "9c9b7e9c-304d-4fe3-ace1-c54ace190761", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "8d60d374-8356-4494-af0e-13505649d57f", "sales_organization_code": "sample string 6", "sales_organization": { "id": "025b4e01-3ad0-4c08-8848-05c16ba69cfd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "511cdad9-60d5-406e-b2e0-e0de9d7e8fcf", "db_currency_id": "10ecb25a-ab25-4b29-8b29-478b8eab3cb2", "db_language_id": "2e4b9875-b389-46dd-9c77-1b80fd4697ee", "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-12T13:58:53.6895332+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-12T13:58:53.6895332+00:00" }, "job_status_id": "20e5959a-6ed7-4f1f-a7ed-afc1df0ec105", "job_status_code": "sample string 11", "db_address_id": "6e9d9576-7b76-4e93-a377-509fa08b6e0b", "contact_id": "7dcb1806-3e4d-49cc-960e-cced77e002b3", "requested_by_company_id": "52bebfc0-8d13-4322-9d02-8c32287f6e09", "requested_by_contact_id": "c1281de3-d617-491f-87c0-4e0aeaa19075", "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-12T13:58:53.6895332+00:00", "due_date": "2025-07-12T13:58:53.6895332+00:00", "date_create": "2025-07-12T13:58:53.6895332+00:00", "date_update": "2025-07-12T13:58:53.6895332+00:00", "date_closed": "2025-07-12T13:58:53.6895332+00:00", "suggested_user_id": "cb3656e0-7867-4c7e-b823-ec02554ba339", "suggested_user_code": "sample string 29", "suggested_user": { "id": "8509c4b3-4b46-4ca2-b0f4-7cf0ab937a4b", "db_language_id": "27e0b1d4-96b5-4489-afc9-2ce2eaa9d099", "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-12T13:58:53.6895332+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "578b19d1-c195-424d-8a45-85ccb2962024", "sales_organization": { "id": "025b4e01-3ad0-4c08-8848-05c16ba69cfd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "511cdad9-60d5-406e-b2e0-e0de9d7e8fcf", "db_currency_id": "10ecb25a-ab25-4b29-8b29-478b8eab3cb2", "db_language_id": "2e4b9875-b389-46dd-9c77-1b80fd4697ee", "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-12T13:58:53.6895332+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "dae65d48-42f3-4693-b056-f61183195a0a", "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": "9b7a17f1-12e0-4766-8ded-9a1d9ec8b55a", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-07-12T13:58:53.6895332+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "18bb4873-a33c-4892-8658-cd1f1e838575" }, "suggested_date_start": "2025-07-12T13:58:53.6895332+00:00", "skill_id": "e8264726-c628-4712-a2e5-60ffdd3d69ff", "skill_code": "sample string 32", "skill": { "id": "0450513b-adc6-4388-9b85-e8ca584de9d6", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "4e90ca0c-4e3a-4c3b-b1a0-195e3068929d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "025b4e01-3ad0-4c08-8848-05c16ba69cfd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "511cdad9-60d5-406e-b2e0-e0de9d7e8fcf", "db_currency_id": "10ecb25a-ab25-4b29-8b29-478b8eab3cb2", "db_language_id": "2e4b9875-b389-46dd-9c77-1b80fd4697ee", "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-12T13:58:53.6895332+00:00" }, "modified_dateutc": "2025-07-12T13:58:53.7051594+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "fcbd1c14-e251-4842-9453-ceacb05b28d9", "date_reported_by_company": "2025-07-12T13:58:53.7051594+00:00", "id2": 36, "company_id": "981f5761-63a0-4e15-a1ff-1bb8911e9cc8", "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": "bc61c520-0e73-4701-b5c5-1aab09e58d43", "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-12T13:58:53.7051594+00:00" }