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": "a6f81566-2457-4f24-9b42-7e09065115a7", "_parent_id": "27569550-50a8-4ebd-9f9a-39b323f7cc30", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "8d39914b-4eff-44aa-ad79-4d561f19faab", "project_reference_back_office": "sample string 5", "project": { "id": "1ef7c244-c91e-484d-a115-612bdf558c16", "_parent_id": "950b3388-df07-4059-ae0b-b9aaada164f6", "root_parent_id": "53ce384e-5148-49d4-9cc5-0ac4fa3fb1e2", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "eb59ebed-d035-4c2c-8e04-695aa4cf559e", "equipment_family_code": "sample string 6", "equipment_family": { "id": "c9ed3583-dbb1-49fc-8432-10f2c0d6a6e0", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "43a91d7d-38e3-45e1-9455-f93343227bb5", "_parent_code": "sample string 6", "sales_organization_id": "4f69a137-cebc-42bf-b343-9734384707f1", "sales_organization_code": "sample string 8", "sales_organization": { "id": "bcaa639f-6d91-40eb-861b-16e269fa2354", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ef390283-7682-4279-b547-4773a70bdd21", "db_currency_id": "12cc1b83-93e0-4b82-90b8-f1a00c199ad3", "db_language_id": "a00e8cb7-70c3-4e2d-852b-2e6c9832545c", "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-04-02T00:54:54.8844319+00:00" }, "modified_dateutc": "2025-04-02T00:54:54.8844319+00:00" }, "equipment_model_id": "41bec15c-31de-4a8f-a5a9-06825bf5e926", "equipment_model_code": "sample string 8", "equipment_model": { "id": "24bc29cf-bc37-4562-bea2-c2f8e387c999", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "458bef8f-a418-47f5-a2ea-3595da97536d", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "58b85123-4f8f-4e2e-9d1c-c8a6795fa3c4", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "ff9f9d63-3988-41a1-980d-0e56a68fd6f3", "sales_organization_code": "sample string 5", "sales_organization": { "id": "bcaa639f-6d91-40eb-861b-16e269fa2354", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ef390283-7682-4279-b547-4773a70bdd21", "db_currency_id": "12cc1b83-93e0-4b82-90b8-f1a00c199ad3", "db_language_id": "a00e8cb7-70c3-4e2d-852b-2e6c9832545c", "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-04-02T00:54:54.8844319+00:00" }, "modified_dateutc": "2025-04-02T00:54:54.8844319+00:00" }, "equipment_family_id": "3bd1e542-50d2-4f94-8ff6-1a57552700be", "equipment_family_code": "sample string 8", "equipment_family": { "id": "c9ed3583-dbb1-49fc-8432-10f2c0d6a6e0", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "43a91d7d-38e3-45e1-9455-f93343227bb5", "_parent_code": "sample string 6", "sales_organization_id": "4f69a137-cebc-42bf-b343-9734384707f1", "sales_organization_code": "sample string 8", "sales_organization": { "id": "bcaa639f-6d91-40eb-861b-16e269fa2354", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ef390283-7682-4279-b547-4773a70bdd21", "db_currency_id": "12cc1b83-93e0-4b82-90b8-f1a00c199ad3", "db_language_id": "a00e8cb7-70c3-4e2d-852b-2e6c9832545c", "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-04-02T00:54:54.8844319+00:00" }, "modified_dateutc": "2025-04-02T00:54:54.8844319+00:00" }, "date_in_production_since": "2025-04-02T00:54:54.8844319+00:00", "date_out_of_production_since": "2025-04-02T00:54:54.8844319+00:00", "date_end_support": "2025-04-02T00:54:54.8844319+00:00", "sales_organization_id": "7737c307-c5af-445b-b770-dc3ada1dead2", "sales_organization_code": "sample string 13", "sales_organization": { "id": "bcaa639f-6d91-40eb-861b-16e269fa2354", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ef390283-7682-4279-b547-4773a70bdd21", "db_currency_id": "12cc1b83-93e0-4b82-90b8-f1a00c199ad3", "db_language_id": "a00e8cb7-70c3-4e2d-852b-2e6c9832545c", "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-04-02T00:54:54.8844319+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-04-02T00:54:54.8844319+00:00" }, "project_status_id": "e5e4a57a-ad4a-439b-bcb7-56dd1e46472a", "project_status_code": "sample string 10", "project_status": { "id": "b0b2f435-810b-47f8-a103-8d52b22d7c50", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "4badda46-8365-4f9c-b648-b15520645346", "sales_organization_code": "sample string 6", "sales_organization": { "id": "bcaa639f-6d91-40eb-861b-16e269fa2354", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ef390283-7682-4279-b547-4773a70bdd21", "db_currency_id": "12cc1b83-93e0-4b82-90b8-f1a00c199ad3", "db_language_id": "a00e8cb7-70c3-4e2d-852b-2e6c9832545c", "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-04-02T00:54:54.8844319+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-04-02T00:54:54.8844319+00:00" }, "company_id": "e46ed5dc-9b85-4645-9b13-be65e6bb37a9", "company_code": "sample string 12", "db_address_id": "e2ee063b-7489-4fb3-bfdb-f2518f91a895", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "ee0a54b6-cf63-43b6-adf2-7ee270c2454f", "contact_reference_back_office": "sample string 17", "owner_user_id": "414cfa85-17f8-4737-a35a-8eaf3f1d862c", "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-04-02T00:54:54.8844319+00:00", "date_create": "2025-04-02T00:54:54.8844319+00:00", "date_update": "2025-04-02T00:54:54.8844319+00:00", "updated_by_user_id": "40676948-70da-425d-a7b3-a796fce48299", "customer_reference": "sample string 28", "warranty_date_until": "2025-04-02T00:54:54.8844319+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-04-02T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-04-02T00:54:54.8844319+00:00", "date_last_job": "2025-04-02T00:54:54.8844319+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-04-02T00:54:54.8844319+00:00", "modified_dateutc": "2025-04-02T00:54:54.8844319+00:00", "is_mobile_installation": true }, "job_type_id": "47853d94-195d-4542-b92e-642b1413f421", "job_type_code": "sample string 7", "job_type": { "id": "789f9eb0-2434-4898-aa5b-76749e5608e8", "name": "sample string 2", "sales_organization_id": "10cc272e-ee0b-4a4c-b9ad-dadf1dd3a919", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-04-02T00:54:54.8844319+00:00", "code": "sample string 7" }, "job_priority_id": "594bae87-4610-4e09-8da3-42fde912749a", "job_priority_code": "sample string 9", "job_priority": { "id": "38fcc4ac-286c-4d07-93bb-268a72ba4dca", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "a073143c-1d05-4d79-b288-e488cb642965", "sales_organization_code": "sample string 6", "sales_organization": { "id": "bcaa639f-6d91-40eb-861b-16e269fa2354", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ef390283-7682-4279-b547-4773a70bdd21", "db_currency_id": "12cc1b83-93e0-4b82-90b8-f1a00c199ad3", "db_language_id": "a00e8cb7-70c3-4e2d-852b-2e6c9832545c", "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-04-02T00:54:54.8844319+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-04-02T00:54:54.8844319+00:00" }, "job_status_id": "9ad37025-0ddf-4b48-91f9-f9fb247308bb", "job_status_code": "sample string 11", "db_address_id": "f42dae34-94d1-494d-bd78-56edbce1bd88", "contact_id": "48c93d60-a39e-4a9f-b134-766a1fd3c074", "requested_by_company_id": "851ee8ac-c1d6-4c2a-9e1d-a981c50bc374", "requested_by_contact_id": "f36a6abd-1870-48f3-a634-bf4bdd9020fc", "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-04-02T00:54:54.8844319+00:00", "due_date": "2025-04-02T00:54:54.8844319+00:00", "date_create": "2025-04-02T00:54:54.8844319+00:00", "date_update": "2025-04-02T00:54:54.8844319+00:00", "date_closed": "2025-04-02T00:54:54.8844319+00:00", "suggested_user_id": "fefe4726-d169-4773-a8eb-6fc4f3ff1498", "suggested_user_code": "sample string 29", "suggested_user": { "id": "13e11494-ecf1-4327-9b48-e7a3e9a07bda", "db_language_id": "c79935d6-81c1-48ad-959b-0f42c872cfe5", "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-04-02T00:54:54.8844319+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "0ff7a1ca-d3af-43b6-b40b-6a90ed71f221", "sales_organization": { "id": "bcaa639f-6d91-40eb-861b-16e269fa2354", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ef390283-7682-4279-b547-4773a70bdd21", "db_currency_id": "12cc1b83-93e0-4b82-90b8-f1a00c199ad3", "db_language_id": "a00e8cb7-70c3-4e2d-852b-2e6c9832545c", "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-04-02T00:54:54.8844319+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "df16c395-fb22-43af-9ace-f0a5b098f5ba", "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": "f115b713-ce35-474b-82af-fd8917f4a90d", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-04-02T00:54:54.8844319+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "04ba976e-b4f2-4265-bb6f-8f6a104d57bf" }, "suggested_date_start": "2025-04-02T00:54:54.8844319+00:00", "skill_id": "f1699c94-c452-41d3-9d6b-88dab1b48688", "skill_code": "sample string 32", "skill": { "id": "ff373ce6-7ba3-42d4-ad62-25b82ce0e48f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "b634a8ba-b457-4486-a2e8-3f1aad722746", "sales_organization_code": "sample string 6", "sales_organization": { "id": "bcaa639f-6d91-40eb-861b-16e269fa2354", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ef390283-7682-4279-b547-4773a70bdd21", "db_currency_id": "12cc1b83-93e0-4b82-90b8-f1a00c199ad3", "db_language_id": "a00e8cb7-70c3-4e2d-852b-2e6c9832545c", "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-04-02T00:54:54.8844319+00:00" }, "modified_dateutc": "2025-04-02T00:54:54.9000551+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "1248c1ed-f9a6-4f9b-adaa-c426b184be8c", "date_reported_by_company": "2025-04-02T00:54:54.9000551+00:00", "id2": 36, "company_id": "48f31746-b0cc-4c43-9cb2-76d17ab704bb", "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": "9a9dbd84-f113-4b8a-ad2d-b0a621362d02", "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-04-02T00:54:54.9000551+00:00" }