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": "bb59c368-0722-4b9a-8465-ee88b5663a2e", "_parent_id": "cb3b7a01-0f3a-4084-bc4b-ca9fc821cfa8", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "7ade9862-2ba5-4b28-822f-be2863f6ff21", "project_reference_back_office": "sample string 5", "project": { "id": "52df80c9-3f18-4262-92b2-f26c880b5655", "_parent_id": "a6fe1d83-2fd0-44db-9174-751b4c608678", "root_parent_id": "aaa6b96c-2a1d-4072-9eb3-4657af53c033", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "17e9dee4-ba90-417f-9d4d-52ebfc9d9ac0", "equipment_family_code": "sample string 6", "equipment_family": { "id": "c9b0a2c6-317f-4348-84aa-08aff81aa8a3", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "298afce4-fb11-4820-b269-203d5efbb49e", "_parent_code": "sample string 6", "sales_organization_id": "c033ed21-53f5-407e-a50c-bd2eaf83aeec", "sales_organization_code": "sample string 8", "sales_organization": { "id": "fd4bb74d-9468-4621-b9b5-5320419aec23", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "aeadf76d-57da-4382-b13e-508bab1b8831", "db_currency_id": "f39ce654-3de7-4c39-87a9-17211f134ddc", "db_language_id": "017abb53-ff3e-47d5-9d56-fb9212db8ccc", "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-10-18T00:21:30.6251315+00:00" }, "modified_dateutc": "2025-10-18T00:21:30.6251315+00:00" }, "equipment_model_id": "57a1669b-8679-425e-aec7-42a70fbaefa8", "equipment_model_code": "sample string 8", "equipment_model": { "id": "44602f52-4bba-485c-b8ff-c4fb139d5e95", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "ed8afcfc-fbef-4af1-967a-d8d559dd03c9", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "ed6db194-03f7-46f1-8ad3-e9a50189fa00", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "84cb606f-0d3a-4946-ab01-a21e2f9d6950", "sales_organization_code": "sample string 5", "sales_organization": { "id": "fd4bb74d-9468-4621-b9b5-5320419aec23", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "aeadf76d-57da-4382-b13e-508bab1b8831", "db_currency_id": "f39ce654-3de7-4c39-87a9-17211f134ddc", "db_language_id": "017abb53-ff3e-47d5-9d56-fb9212db8ccc", "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-10-18T00:21:30.6251315+00:00" }, "modified_dateutc": "2025-10-18T00:21:30.6251315+00:00" }, "equipment_family_id": "ffc13a97-ae08-47b4-855b-4a571811f451", "equipment_family_code": "sample string 8", "equipment_family": { "id": "c9b0a2c6-317f-4348-84aa-08aff81aa8a3", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "298afce4-fb11-4820-b269-203d5efbb49e", "_parent_code": "sample string 6", "sales_organization_id": "c033ed21-53f5-407e-a50c-bd2eaf83aeec", "sales_organization_code": "sample string 8", "sales_organization": { "id": "fd4bb74d-9468-4621-b9b5-5320419aec23", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "aeadf76d-57da-4382-b13e-508bab1b8831", "db_currency_id": "f39ce654-3de7-4c39-87a9-17211f134ddc", "db_language_id": "017abb53-ff3e-47d5-9d56-fb9212db8ccc", "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-10-18T00:21:30.6251315+00:00" }, "modified_dateutc": "2025-10-18T00:21:30.6251315+00:00" }, "date_in_production_since": "2025-10-18T00:21:30.6251315+00:00", "date_out_of_production_since": "2025-10-18T00:21:30.6251315+00:00", "date_end_support": "2025-10-18T00:21:30.6251315+00:00", "sales_organization_id": "3ce45584-2cee-4005-966d-81248a44a387", "sales_organization_code": "sample string 13", "sales_organization": { "id": "fd4bb74d-9468-4621-b9b5-5320419aec23", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "aeadf76d-57da-4382-b13e-508bab1b8831", "db_currency_id": "f39ce654-3de7-4c39-87a9-17211f134ddc", "db_language_id": "017abb53-ff3e-47d5-9d56-fb9212db8ccc", "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-10-18T00:21:30.6251315+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-10-18T00:21:30.6251315+00:00" }, "project_status_id": "446bce56-040b-44ac-ae97-b23a7b22e157", "project_status_code": "sample string 10", "project_status": { "id": "881ae29b-6653-460e-a202-40f98d6b6232", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "c040d0ab-4ce1-403a-9dda-91b2c5146309", "sales_organization_code": "sample string 6", "sales_organization": { "id": "fd4bb74d-9468-4621-b9b5-5320419aec23", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "aeadf76d-57da-4382-b13e-508bab1b8831", "db_currency_id": "f39ce654-3de7-4c39-87a9-17211f134ddc", "db_language_id": "017abb53-ff3e-47d5-9d56-fb9212db8ccc", "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-10-18T00:21:30.6251315+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-18T00:21:30.6251315+00:00" }, "company_id": "f8af7e54-bf9b-461c-84d8-860672bfa7e4", "company_code": "sample string 12", "db_address_id": "e4a83bb8-3968-4c26-aaa7-9c081a144e85", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "5b916a26-37de-4c1d-bb89-aae5dbdb0ba8", "contact_reference_back_office": "sample string 17", "owner_user_id": "062d5efc-78af-4c54-9eca-055f781e6f2b", "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-10-18T00:21:30.6251315+00:00", "date_create": "2025-10-18T00:21:30.6251315+00:00", "date_update": "2025-10-18T00:21:30.6251315+00:00", "updated_by_user_id": "3a8ba2a2-aa56-4fd6-9ac5-8828bc8e8543", "customer_reference": "sample string 28", "warranty_date_until": "2025-10-18T00:21:30.6251315+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-10-18T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-10-18T00:21:30.6251315+00:00", "date_last_job": "2025-10-18T00:21:30.6251315+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-10-18T00:21:30.6251315+00:00", "modified_dateutc": "2025-10-18T00:21:30.6251315+00:00", "is_mobile_installation": true }, "job_type_id": "ecfb4a3e-1627-4e40-874d-4ffad9e1f767", "job_type_code": "sample string 7", "job_type": { "id": "6ce5084c-e058-44f9-ab0f-975f4bb0d1c7", "name": "sample string 2", "sales_organization_id": "d0325c95-4a29-4af1-ab52-6101d6d28e36", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-10-18T00:21:30.6251315+00:00", "code": "sample string 7" }, "job_priority_id": "2f296681-1e34-4d95-bb4b-297a10b88f1f", "job_priority_code": "sample string 9", "job_priority": { "id": "6c6b7f42-3c62-4db0-adb2-bd8ddd5cb50f", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "9f6d70f5-40fb-4d7a-badc-a9465bbb39e5", "sales_organization_code": "sample string 6", "sales_organization": { "id": "fd4bb74d-9468-4621-b9b5-5320419aec23", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "aeadf76d-57da-4382-b13e-508bab1b8831", "db_currency_id": "f39ce654-3de7-4c39-87a9-17211f134ddc", "db_language_id": "017abb53-ff3e-47d5-9d56-fb9212db8ccc", "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-10-18T00:21:30.6251315+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-18T00:21:30.6251315+00:00" }, "job_status_id": "c7dd27e1-91d3-4fb4-b2c5-a0ca196bf04f", "job_status_code": "sample string 11", "db_address_id": "0e0cc993-d132-41e1-8049-2e76558e37e0", "contact_id": "a8ecc0ed-e47f-4976-b73d-90fa4fd95865", "requested_by_company_id": "4af92718-e294-46d6-acf8-bce3d09ed8fc", "requested_by_contact_id": "7c043a12-8c21-4848-bbf7-309a0d4c5f9a", "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-10-18T00:21:30.6251315+00:00", "due_date": "2025-10-18T00:21:30.6251315+00:00", "date_create": "2025-10-18T00:21:30.6251315+00:00", "date_update": "2025-10-18T00:21:30.6251315+00:00", "date_closed": "2025-10-18T00:21:30.6251315+00:00", "suggested_user_id": "4da27057-b790-43f9-8294-845b4ce4a914", "suggested_user_code": "sample string 29", "suggested_user": { "id": "7e74f748-0185-4a3b-93a4-7ba0e372cd83", "db_language_id": "1696907a-f794-4ff0-b22d-61412f4fb111", "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-10-18T00:21:30.6251315+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "ee4c83b9-59c7-4abe-ae1c-559369d72cf5", "sales_organization": { "id": "fd4bb74d-9468-4621-b9b5-5320419aec23", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "aeadf76d-57da-4382-b13e-508bab1b8831", "db_currency_id": "f39ce654-3de7-4c39-87a9-17211f134ddc", "db_language_id": "017abb53-ff3e-47d5-9d56-fb9212db8ccc", "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-10-18T00:21:30.6251315+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "eb8b633e-4dc8-4ad9-b061-cbd70819e1ad", "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": "c1283e10-d0fc-4f03-a143-9fc1cd10d106", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-10-18T00:21:30.6251315+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "404a25b1-b36d-4f96-9140-68f094faa373" }, "suggested_date_start": "2025-10-18T00:21:30.6251315+00:00", "skill_id": "ab5eed02-c5c0-4db0-b913-966bbbcd6be9", "skill_code": "sample string 32", "skill": { "id": "5bab21e4-a51a-4c99-815a-928b6bc22151", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "e20e9894-82b0-4293-9142-fdb86ff07ee4", "sales_organization_code": "sample string 6", "sales_organization": { "id": "fd4bb74d-9468-4621-b9b5-5320419aec23", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "aeadf76d-57da-4382-b13e-508bab1b8831", "db_currency_id": "f39ce654-3de7-4c39-87a9-17211f134ddc", "db_language_id": "017abb53-ff3e-47d5-9d56-fb9212db8ccc", "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-10-18T00:21:30.6251315+00:00" }, "modified_dateutc": "2025-10-18T00:21:30.6251315+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "af189a75-796d-4583-947e-135ac6103e54", "date_reported_by_company": "2025-10-18T00:21:30.6251315+00:00", "id2": 36, "company_id": "bcf7563b-d71a-45ea-9386-51548a1103be", "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": "3192cd5f-c9bf-48d7-8adf-ad61bcb55796", "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-10-18T00:21:30.6251315+00:00" }