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": "f128f9e4-2c95-4e91-8c73-ca16bbff177d",
"_parent_id": "93c373ea-a1e2-4648-bea1-7c60e927be58",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5699cf42-2e29-4880-a328-68513bf7482d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4c0ec5e8-d81d-4da6-aff9-cb78499abcad",
"_parent_id": "c4ad35c4-0c6f-413d-b6cc-c231e66c6f43",
"root_parent_id": "e5dfb47f-ae66-4a7f-b629-a9574f81812b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c269b062-03a3-4018-a4cd-bcd0fff44443",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6b238fd9-b9a7-4cdf-9527-334da18ebbf1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "edfe70ba-91db-455a-a2f8-8f8aa8579426",
"_parent_code": "sample string 6",
"sales_organization_id": "9884bd48-637b-4a9a-a7c2-07f377959ec0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "acc42385-0267-452a-9ca7-13223b075ce1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "726a9541-5fca-4433-be9a-a3634d651d61",
"db_currency_id": "4df7665c-2bf1-472f-a350-d3b425714a90",
"db_language_id": "3471546b-e465-43c6-8351-5b3853692792",
"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-05-29T02:43:57.7337105+00:00"
},
"modified_dateutc": "2025-05-29T02:43:57.749339+00:00"
},
"equipment_model_id": "df0c60f7-6824-4ba9-a4fa-b0763681d6d1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1058204c-08db-4490-a6bf-b8d678cee60f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f303e172-a22c-4887-9498-6c3d68b16968",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e669df4a-abca-492c-8544-3251759805e5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0c27fe60-e8cc-4668-892a-ca1cbf3c318f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "acc42385-0267-452a-9ca7-13223b075ce1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "726a9541-5fca-4433-be9a-a3634d651d61",
"db_currency_id": "4df7665c-2bf1-472f-a350-d3b425714a90",
"db_language_id": "3471546b-e465-43c6-8351-5b3853692792",
"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-05-29T02:43:57.7337105+00:00"
},
"modified_dateutc": "2025-05-29T02:43:57.749339+00:00"
},
"equipment_family_id": "06ad4200-a132-4271-a616-7b06fa7b806e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6b238fd9-b9a7-4cdf-9527-334da18ebbf1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "edfe70ba-91db-455a-a2f8-8f8aa8579426",
"_parent_code": "sample string 6",
"sales_organization_id": "9884bd48-637b-4a9a-a7c2-07f377959ec0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "acc42385-0267-452a-9ca7-13223b075ce1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "726a9541-5fca-4433-be9a-a3634d651d61",
"db_currency_id": "4df7665c-2bf1-472f-a350-d3b425714a90",
"db_language_id": "3471546b-e465-43c6-8351-5b3853692792",
"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-05-29T02:43:57.7337105+00:00"
},
"modified_dateutc": "2025-05-29T02:43:57.749339+00:00"
},
"date_in_production_since": "2025-05-29T02:43:57.749339+00:00",
"date_out_of_production_since": "2025-05-29T02:43:57.749339+00:00",
"date_end_support": "2025-05-29T02:43:57.749339+00:00",
"sales_organization_id": "1690a4c9-5f49-4de9-adcf-a76848e20934",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "acc42385-0267-452a-9ca7-13223b075ce1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "726a9541-5fca-4433-be9a-a3634d651d61",
"db_currency_id": "4df7665c-2bf1-472f-a350-d3b425714a90",
"db_language_id": "3471546b-e465-43c6-8351-5b3853692792",
"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-05-29T02:43:57.7337105+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-05-29T02:43:57.749339+00:00"
},
"project_status_id": "4fa6fca2-ffd2-463a-a5c4-050614d12fc7",
"project_status_code": "sample string 10",
"project_status": {
"id": "0719c346-421d-4bc0-995c-63ef44130eff",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "652d5cfb-2908-4b93-a472-c78120ac68a1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "acc42385-0267-452a-9ca7-13223b075ce1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "726a9541-5fca-4433-be9a-a3634d651d61",
"db_currency_id": "4df7665c-2bf1-472f-a350-d3b425714a90",
"db_language_id": "3471546b-e465-43c6-8351-5b3853692792",
"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-05-29T02:43:57.7337105+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-29T02:43:57.749339+00:00"
},
"company_id": "950a2090-07dd-46cc-b02c-fe833b0e39de",
"company_code": "sample string 12",
"db_address_id": "553df744-e774-4964-9797-9ce791360f5f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4d111514-bb08-4282-86e3-3cebb5fbfd5a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "dcc829ca-fda7-442f-972f-be4919af2db1",
"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-05-29T02:43:57.749339+00:00",
"date_create": "2025-05-29T02:43:57.749339+00:00",
"date_update": "2025-05-29T02:43:57.749339+00:00",
"updated_by_user_id": "15069c3b-33a4-4bbf-a8d2-6243c4a6437f",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-05-29T02:43:57.749339+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-05-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-05-29T02:43:57.749339+00:00",
"date_last_job": "2025-05-29T02:43:57.749339+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-05-29T02:43:57.749339+00:00",
"modified_dateutc": "2025-05-29T02:43:57.749339+00:00",
"is_mobile_installation": true
},
"job_type_id": "aad60934-f2c9-4282-9025-409d664bc053",
"job_type_code": "sample string 7",
"job_type": {
"id": "d8b72e03-ac27-49d0-b919-1a655a97098e",
"name": "sample string 2",
"sales_organization_id": "b340f540-ef7a-4af4-8dc3-9b59b9219983",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-05-29T02:43:57.749339+00:00",
"code": "sample string 7"
},
"job_priority_id": "9972da80-15a7-4ecd-8241-11468eacfd57",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "06bf5ad2-429f-46cd-b186-120ab1ecc79d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2abe4843-b07f-4e61-ae4a-03baf748d424",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "acc42385-0267-452a-9ca7-13223b075ce1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "726a9541-5fca-4433-be9a-a3634d651d61",
"db_currency_id": "4df7665c-2bf1-472f-a350-d3b425714a90",
"db_language_id": "3471546b-e465-43c6-8351-5b3853692792",
"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-05-29T02:43:57.7337105+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-29T02:43:57.749339+00:00"
},
"job_status_id": "cede0051-b9fd-4ea1-a734-b4e66f7785b8",
"job_status_code": "sample string 11",
"db_address_id": "1aead21c-0fca-4df2-9b22-384b31b99a05",
"contact_id": "27312cd6-3d8c-49c6-9f9a-53748cdae894",
"requested_by_company_id": "9844fce6-8195-4e79-b7c7-944904e1a0f1",
"requested_by_contact_id": "fd322bbd-1e10-44b0-acd6-4bb87e7a0103",
"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-05-29T02:43:57.749339+00:00",
"due_date": "2025-05-29T02:43:57.749339+00:00",
"date_create": "2025-05-29T02:43:57.749339+00:00",
"date_update": "2025-05-29T02:43:57.749339+00:00",
"date_closed": "2025-05-29T02:43:57.749339+00:00",
"suggested_user_id": "2f8843e9-2436-4339-aa48-42a4ba7b855f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8ddeff79-01e3-46df-808c-184a38ec74a1",
"db_language_id": "61205395-8ad2-43cb-939a-0a949b9116fd",
"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-05-29T02:43:57.749339+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "22131b94-5c03-44c3-9a1e-8c50ac9ed32f",
"sales_organization": {
"id": "acc42385-0267-452a-9ca7-13223b075ce1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "726a9541-5fca-4433-be9a-a3634d651d61",
"db_currency_id": "4df7665c-2bf1-472f-a350-d3b425714a90",
"db_language_id": "3471546b-e465-43c6-8351-5b3853692792",
"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-05-29T02:43:57.7337105+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1d3d18ba-404e-4215-8c67-5dafa332f5fa",
"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": "5a8cc39d-6d28-40fe-87db-ef1bee0a2fdb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-05-29T02:43:57.749339+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d084f967-bdb0-416e-8b87-fe3cec7533b2"
},
"suggested_date_start": "2025-05-29T02:43:57.749339+00:00",
"skill_id": "94bda669-e0b3-4929-91c6-0991daa9817f",
"skill_code": "sample string 32",
"skill": {
"id": "8184fc1f-1d0f-41cc-94dd-394ba301aba8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f28747a5-704e-4a27-9db3-a2154c3225ee",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "acc42385-0267-452a-9ca7-13223b075ce1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "726a9541-5fca-4433-be9a-a3634d651d61",
"db_currency_id": "4df7665c-2bf1-472f-a350-d3b425714a90",
"db_language_id": "3471546b-e465-43c6-8351-5b3853692792",
"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-05-29T02:43:57.7337105+00:00"
},
"modified_dateutc": "2025-05-29T02:43:57.749339+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "390676ef-1149-4d79-8a51-2d74db766222",
"date_reported_by_company": "2025-05-29T02:43:57.749339+00:00",
"id2": 36,
"company_id": "1b0ca8f2-c1c0-4078-835d-2cd7837b83cb",
"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": "6d09c440-dc1a-47b1-817f-e2922373ffe8",
"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-05-29T02:43:57.749339+00:00"
}