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
jobs| Name | 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": "d1a620fb-efca-4aec-b2fb-04d37a6deaf8",
"_parent_id": "fe8d8064-6a26-4204-8718-a624886c6932",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ff48add4-5fe9-4615-b95d-caf66a0cab12",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d910e461-acd7-42e0-8ec6-146fab4fb28d",
"_parent_id": "fd87e9a3-d763-45d2-bbcc-dd91f6f67b86",
"root_parent_id": "3cb2564b-61db-4dbc-8447-785f55e0ba6e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c9d33b1e-ad7d-4d8f-83f7-47ef2005852f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ac968438-29cf-4074-b68a-58a235fe94ef",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "09746890-1819-4efa-b713-66a4f5717e02",
"_parent_code": "sample string 6",
"sales_organization_id": "f3095013-087d-4a25-b670-66872b9dc284",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "343213b6-c321-4af0-85cb-acb327eb87db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "26461a82-3de4-42d1-be4f-fba694aa2add",
"db_currency_id": "c9d74021-b52c-4daf-aea3-109e15b68c07",
"db_language_id": "79377091-0ddb-47c5-a913-d3751a67330d",
"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": "2026-01-30T22:36:47.4742204+00:00"
},
"modified_dateutc": "2026-01-30T22:36:47.489839+00:00"
},
"equipment_model_id": "ef6ccdd0-b745-497b-8fd1-4ff08d005f19",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3ffdcd3e-5c5d-4ab1-bc8d-3aa70b0f56dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f243fc81-9437-469b-afee-92300aecfbb8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5d53c63b-0016-476f-839b-fa486d1793bc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b750d720-9384-4ab5-9433-b628bdedd2d0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "343213b6-c321-4af0-85cb-acb327eb87db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "26461a82-3de4-42d1-be4f-fba694aa2add",
"db_currency_id": "c9d74021-b52c-4daf-aea3-109e15b68c07",
"db_language_id": "79377091-0ddb-47c5-a913-d3751a67330d",
"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": "2026-01-30T22:36:47.4742204+00:00"
},
"modified_dateutc": "2026-01-30T22:36:47.489839+00:00"
},
"equipment_family_id": "7d453962-22e9-45c1-a175-224a8d7f45be",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ac968438-29cf-4074-b68a-58a235fe94ef",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "09746890-1819-4efa-b713-66a4f5717e02",
"_parent_code": "sample string 6",
"sales_organization_id": "f3095013-087d-4a25-b670-66872b9dc284",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "343213b6-c321-4af0-85cb-acb327eb87db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "26461a82-3de4-42d1-be4f-fba694aa2add",
"db_currency_id": "c9d74021-b52c-4daf-aea3-109e15b68c07",
"db_language_id": "79377091-0ddb-47c5-a913-d3751a67330d",
"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": "2026-01-30T22:36:47.4742204+00:00"
},
"modified_dateutc": "2026-01-30T22:36:47.489839+00:00"
},
"date_in_production_since": "2026-01-30T22:36:47.489839+00:00",
"date_out_of_production_since": "2026-01-30T22:36:47.489839+00:00",
"date_end_support": "2026-01-30T22:36:47.489839+00:00",
"sales_organization_id": "c57895ab-af26-48b3-9b74-e158238f1769",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "343213b6-c321-4af0-85cb-acb327eb87db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "26461a82-3de4-42d1-be4f-fba694aa2add",
"db_currency_id": "c9d74021-b52c-4daf-aea3-109e15b68c07",
"db_language_id": "79377091-0ddb-47c5-a913-d3751a67330d",
"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": "2026-01-30T22:36:47.4742204+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": "2026-01-30T22:36:47.489839+00:00"
},
"project_status_id": "9f05b20b-e7e4-415c-9ec8-3ddfb6096832",
"project_status_code": "sample string 10",
"project_status": {
"id": "e83d4ba2-57fa-4ca0-ac13-cb45d7862518",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "afe726e1-6e39-40f3-aa78-93b7226904bf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "343213b6-c321-4af0-85cb-acb327eb87db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "26461a82-3de4-42d1-be4f-fba694aa2add",
"db_currency_id": "c9d74021-b52c-4daf-aea3-109e15b68c07",
"db_language_id": "79377091-0ddb-47c5-a913-d3751a67330d",
"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": "2026-01-30T22:36:47.4742204+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-30T22:36:47.489839+00:00"
},
"company_id": "dc95ceb4-036f-4255-a41b-d07c56d468f5",
"company_code": "sample string 12",
"db_address_id": "54a38994-eb6c-48c2-b69b-41ad9f2365c9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2a922631-3303-4fc9-81ac-9a3ba9090464",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b777f247-a918-4b59-b920-313a8d9c34e4",
"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": "2026-01-30T22:36:47.489839+00:00",
"date_create": "2026-01-30T22:36:47.489839+00:00",
"date_update": "2026-01-30T22:36:47.489839+00:00",
"updated_by_user_id": "089dff28-2cad-4eff-97e7-d99864a9d7e3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-30T22:36:47.489839+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": "2026-01-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-30T22:36:47.489839+00:00",
"date_last_job": "2026-01-30T22:36:47.489839+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-30T22:36:47.489839+00:00",
"modified_dateutc": "2026-01-30T22:36:47.489839+00:00",
"is_mobile_installation": true
},
"job_type_id": "27dd7ca8-e70f-4bf6-95a6-9a45da9de565",
"job_type_code": "sample string 7",
"job_type": {
"id": "e613f854-aa15-4259-991f-14cabdd6fd87",
"name": "sample string 2",
"sales_organization_id": "ef0623bc-a018-4fb2-8bb0-0ee710f4461a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-30T22:36:47.489839+00:00",
"code": "sample string 7"
},
"job_priority_id": "c220655a-1e98-40d7-800c-89a32b890b5b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "26c82597-0811-4425-b1ac-61523ce00dad",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "954072a8-7e51-4180-85df-aff2bb43b06a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "343213b6-c321-4af0-85cb-acb327eb87db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "26461a82-3de4-42d1-be4f-fba694aa2add",
"db_currency_id": "c9d74021-b52c-4daf-aea3-109e15b68c07",
"db_language_id": "79377091-0ddb-47c5-a913-d3751a67330d",
"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": "2026-01-30T22:36:47.4742204+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-30T22:36:47.489839+00:00"
},
"job_status_id": "5f9869c7-4929-461b-b092-de06ad7057f7",
"job_status_code": "sample string 11",
"db_address_id": "acd45961-8538-4d42-8f25-8c4edddc9e47",
"contact_id": "8ec2d0c2-894a-4747-a682-9d3c33b76264",
"requested_by_company_id": "2d120632-543b-4b70-b510-de934c094570",
"requested_by_contact_id": "787852fb-1516-49c5-ae5a-f27cd0686863",
"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": "2026-01-30T22:36:47.489839+00:00",
"due_date": "2026-01-30T22:36:47.489839+00:00",
"date_create": "2026-01-30T22:36:47.489839+00:00",
"date_update": "2026-01-30T22:36:47.489839+00:00",
"date_closed": "2026-01-30T22:36:47.489839+00:00",
"suggested_user_id": "5aac5204-6ebc-4a78-aeed-f5100abcdcb7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "45a9aec8-1a0e-4ebf-a212-5e6d24effd2d",
"db_language_id": "cacae162-026a-458d-8087-f4cef5f12d34",
"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": "2026-01-30T22:36:47.489839+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f4353b4c-9049-4edc-ba30-bc4e2db4a77f",
"sales_organization": {
"id": "343213b6-c321-4af0-85cb-acb327eb87db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "26461a82-3de4-42d1-be4f-fba694aa2add",
"db_currency_id": "c9d74021-b52c-4daf-aea3-109e15b68c07",
"db_language_id": "79377091-0ddb-47c5-a913-d3751a67330d",
"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": "2026-01-30T22:36:47.4742204+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "daf8d667-a5b6-446b-9016-cd1c2c081343",
"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": "987b14d2-8eff-4742-a9bd-70175c54ada6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-30T22:36:47.489839+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6a47344a-dcb0-4d83-8483-03508bb730fc"
},
"suggested_date_start": "2026-01-30T22:36:47.489839+00:00",
"skill_id": "af6fdd74-d10e-45b9-9e81-e085b649e42c",
"skill_code": "sample string 32",
"skill": {
"id": "4de1e331-a5fe-4288-a201-e15c3e9ec2c2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "aeb3b276-141d-4f3f-ad3a-bcacfee44883",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "343213b6-c321-4af0-85cb-acb327eb87db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "26461a82-3de4-42d1-be4f-fba694aa2add",
"db_currency_id": "c9d74021-b52c-4daf-aea3-109e15b68c07",
"db_language_id": "79377091-0ddb-47c5-a913-d3751a67330d",
"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": "2026-01-30T22:36:47.4742204+00:00"
},
"modified_dateutc": "2026-01-30T22:36:47.489839+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3f7251e4-7c8a-40e4-95e6-37250d2895f6",
"date_reported_by_company": "2026-01-30T22:36:47.489839+00:00",
"id2": 36,
"company_id": "a3321e0e-558f-496f-bd96-dbe955426e1e",
"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": "1b281629-a5d6-472f-9c8e-48c867556be0",
"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": "2026-01-30T22:36:47.489839+00:00"
}