Retrieves the job work instruction list 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 :
job_work_instruction_list| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of the jobs |
globally unique identifier |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs_reference_back_office |
Embedded entity "jobs" using ERP PK when adding/updating |
string |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs |
Embedded entity "jobs" when adding/updating |
jobs |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| work_instruction_details_id |
work instruction details id |
globally unique identifier | |
| work_instruction_details_reference_back_office |
Embedded code "work instruction details" when adding/updating |
string | |
| work_instruction_details |
Embedded entity "work instruction details" when adding/updating |
work_instruction_details | |
| user_id |
Filled by the person that completed that item on the checklist |
globally unique identifier | |
| work_instruction_action_type |
Value from work_instruction_action_type.name |
string | |
| work_instruction_id |
work instruction id |
globally unique identifier |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction_reference_back_office |
Embedded code "work instruction" when adding/updating |
string |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction |
Embedded entity "work instruction" when adding/updating |
work_instruction |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| name |
The "on what" |
string |
Required Max length: 4000 |
| status |
Status can be Ok,NotOk,Replaced,NotApplicable |
string |
Max length: 50 |
| date_done |
Datetime filled when status goes to one valable status. |
date | |
| remark |
Additional remark from the technician. |
string |
Max length: 255 |
| advise |
Additional advice from the technician. |
string |
Max length: 255 |
| sequence |
To order it. |
integer | |
| reference_back_office |
The Id/Ref of the back office for this job work instruction. Used by Embedded entity |
string |
Max length: 255 |
| group_name |
Name of the group |
string |
Max length: 4000 |
| group_sequence |
Order of the group |
integer | |
| type |
One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default |
string | |
| instruction_document_count |
Specify how many documents/photos must be added if type is Picture |
integer | |
| db_report_type_id |
When type is Form, you must specify which db_report_type must be filled |
globally unique identifier | |
| db_report_type_name |
When type is Form, you must specify which db_report_type must be filled |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
Sample:
{
"id": "9ff05b09-0cb4-4d56-b45f-d9267678d192",
"jobs_id": "1cf330ba-9941-420d-99aa-5640a237fe7c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2ec00b84-f3a9-486a-83c5-731904e11f8e",
"_parent_id": "be5d14e3-5e69-47f7-82b1-2b26cb87919d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6489390a-977f-4371-93bf-5239ea0279b8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "431b0dd1-15d9-4da0-9b08-d68fa8a439ea",
"_parent_id": "eb53fd69-5156-43da-838e-ef44c077465d",
"root_parent_id": "5dcc11ee-bd25-453e-bffd-ad8ac24d423e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "60a3d75f-4d4f-4e5a-8c8a-38b75f2c6cf3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c9aba6f9-a7a3-4f0f-b0a2-e9ef3d0aae7b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4160f39d-839c-46d1-9da4-dc0feb00ee7e",
"_parent_code": "sample string 6",
"sales_organization_id": "74bf04ef-0965-4870-aca0-901232274a5d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74a2fe07-9f07-413b-8a5e-c0549b26296b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "326171ef-44d6-4081-a5c3-41e41a833e1f",
"db_currency_id": "10789bea-6524-43b9-9a7e-89c7fb625ba2",
"db_language_id": "4427998b-3403-4ca1-bf25-19f836df30e9",
"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-04-12T15:50:01.6693575+00:00"
},
"modified_dateutc": "2026-04-12T15:50:01.6693575+00:00"
},
"equipment_model_id": "749560f7-1d21-486f-b9de-10cc68c22a63",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "eac9f307-6037-4b4f-919d-8eb5e22741ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "26f7a017-1212-4469-8dd9-3e6cc31e77bc",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2f808d41-ad91-4adc-a134-c82ad15e57e2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ee824822-23cd-429d-a9dc-a9bd22faf4fe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "74a2fe07-9f07-413b-8a5e-c0549b26296b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "326171ef-44d6-4081-a5c3-41e41a833e1f",
"db_currency_id": "10789bea-6524-43b9-9a7e-89c7fb625ba2",
"db_language_id": "4427998b-3403-4ca1-bf25-19f836df30e9",
"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-04-12T15:50:01.6693575+00:00"
},
"modified_dateutc": "2026-04-12T15:50:01.6693575+00:00"
},
"equipment_family_id": "be69364a-e55d-44ff-b1c4-73bab9afbc96",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c9aba6f9-a7a3-4f0f-b0a2-e9ef3d0aae7b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4160f39d-839c-46d1-9da4-dc0feb00ee7e",
"_parent_code": "sample string 6",
"sales_organization_id": "74bf04ef-0965-4870-aca0-901232274a5d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74a2fe07-9f07-413b-8a5e-c0549b26296b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "326171ef-44d6-4081-a5c3-41e41a833e1f",
"db_currency_id": "10789bea-6524-43b9-9a7e-89c7fb625ba2",
"db_language_id": "4427998b-3403-4ca1-bf25-19f836df30e9",
"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-04-12T15:50:01.6693575+00:00"
},
"modified_dateutc": "2026-04-12T15:50:01.6693575+00:00"
},
"date_in_production_since": "2026-04-12T15:50:01.6693575+00:00",
"date_out_of_production_since": "2026-04-12T15:50:01.6693575+00:00",
"date_end_support": "2026-04-12T15:50:01.6693575+00:00",
"sales_organization_id": "a7256574-bbff-4470-b3ac-cba340dc12aa",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "74a2fe07-9f07-413b-8a5e-c0549b26296b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "326171ef-44d6-4081-a5c3-41e41a833e1f",
"db_currency_id": "10789bea-6524-43b9-9a7e-89c7fb625ba2",
"db_language_id": "4427998b-3403-4ca1-bf25-19f836df30e9",
"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-04-12T15:50:01.6693575+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-04-12T15:50:01.6693575+00:00"
},
"project_status_id": "c02612e0-8148-4067-95e0-5db2617a15b4",
"project_status_code": "sample string 10",
"project_status": {
"id": "d2fd73c4-a3f2-4083-9da5-3b80478d668c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "713baefd-efec-482b-af24-bcf44906511b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74a2fe07-9f07-413b-8a5e-c0549b26296b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "326171ef-44d6-4081-a5c3-41e41a833e1f",
"db_currency_id": "10789bea-6524-43b9-9a7e-89c7fb625ba2",
"db_language_id": "4427998b-3403-4ca1-bf25-19f836df30e9",
"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-04-12T15:50:01.6693575+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-12T15:50:01.6693575+00:00"
},
"company_id": "f0f070bc-67d1-4e76-84d6-3339c284ad13",
"company_code": "sample string 12",
"db_address_id": "493d826e-a548-42a7-b9ad-0206659aaf2b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "40e10f02-de4b-47ca-bb78-6d3f985d83c5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d56574e5-d266-4624-8a47-ff1736726df8",
"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-04-12T15:50:01.6693575+00:00",
"date_create": "2026-04-12T15:50:01.6693575+00:00",
"date_update": "2026-04-12T15:50:01.6693575+00:00",
"updated_by_user_id": "38d7b7fc-000a-42ef-96ab-155fbb37dbcc",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-12T15:50:01.6693575+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-04-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-12T15:50:01.6693575+00:00",
"date_last_job": "2026-04-12T15:50:01.6693575+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-12T15:50:01.6693575+00:00",
"modified_dateutc": "2026-04-12T15:50:01.6693575+00:00",
"is_mobile_installation": true
},
"job_type_id": "4ae7bd25-0b95-4ae7-9d38-3cab5140e360",
"job_type_code": "sample string 7",
"job_type": {
"id": "864f83fc-35ed-4f35-9c88-95616ee7e15f",
"name": "sample string 2",
"sales_organization_id": "4ec1116b-3f41-4f76-bb2f-23f07cdc89bc",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-12T15:50:01.6693575+00:00",
"code": "sample string 7"
},
"job_priority_id": "de214acd-3f68-4a99-a590-36fe4e549c55",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6d0556bb-cb6d-422c-8f63-158d02b82c0b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b5dab025-77e0-4d8f-b4d3-0004e8072f16",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74a2fe07-9f07-413b-8a5e-c0549b26296b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "326171ef-44d6-4081-a5c3-41e41a833e1f",
"db_currency_id": "10789bea-6524-43b9-9a7e-89c7fb625ba2",
"db_language_id": "4427998b-3403-4ca1-bf25-19f836df30e9",
"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-04-12T15:50:01.6693575+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-12T15:50:01.6693575+00:00"
},
"job_status_id": "443b8406-88e4-49f2-a28f-b9bdf36578d8",
"job_status_code": "sample string 11",
"db_address_id": "7c77b282-13b3-4fe5-a1e9-2b0c9696f59f",
"contact_id": "81db1a0a-16a6-4cc2-8798-5785d031461e",
"requested_by_company_id": "0c0127f0-5f1c-4ff5-ab70-9cb5e466abba",
"requested_by_contact_id": "103143f9-b44e-41fd-a02a-fdb5da4f31fb",
"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-04-12T15:50:01.6693575+00:00",
"due_date": "2026-04-12T15:50:01.6693575+00:00",
"date_create": "2026-04-12T15:50:01.6693575+00:00",
"date_update": "2026-04-12T15:50:01.6693575+00:00",
"date_closed": "2026-04-12T15:50:01.6693575+00:00",
"suggested_user_id": "7735dd61-ff4b-413b-ada3-98c3bf1d484d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d95aa8bc-f322-443d-8b59-56c58bc56940",
"db_language_id": "695b836c-9263-4277-85aa-7942bd0cdf99",
"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-04-12T15:50:01.6693575+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2f44febb-fd87-432f-9c8f-7988ba57fe4d",
"sales_organization": {
"id": "74a2fe07-9f07-413b-8a5e-c0549b26296b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "326171ef-44d6-4081-a5c3-41e41a833e1f",
"db_currency_id": "10789bea-6524-43b9-9a7e-89c7fb625ba2",
"db_language_id": "4427998b-3403-4ca1-bf25-19f836df30e9",
"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-04-12T15:50:01.6693575+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4c1a81a5-1949-4683-a468-480b7ddca439",
"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": "9ff875e0-c990-4fd8-b9a9-f7ee1a5f8610",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-12T15:50:01.6693575+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7a2f4e2a-0e79-4de2-8f48-ae3d812c01dd"
},
"suggested_date_start": "2026-04-12T15:50:01.6693575+00:00",
"skill_id": "71e1da5d-2690-47ba-bc43-c61b3b282001",
"skill_code": "sample string 32",
"skill": {
"id": "58a30d7d-f24d-439f-a558-fe9eebd61119",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "00311424-3d3d-4633-b87a-5f290d87b947",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74a2fe07-9f07-413b-8a5e-c0549b26296b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "326171ef-44d6-4081-a5c3-41e41a833e1f",
"db_currency_id": "10789bea-6524-43b9-9a7e-89c7fb625ba2",
"db_language_id": "4427998b-3403-4ca1-bf25-19f836df30e9",
"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-04-12T15:50:01.6693575+00:00"
},
"modified_dateutc": "2026-04-12T15:50:01.6693575+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "89876b39-0431-4e3b-bd5a-a64d6e02122e",
"date_reported_by_company": "2026-04-12T15:50:01.6693575+00:00",
"id2": 36,
"company_id": "d8cfaae6-204f-40df-80da-18514e302e34",
"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": "54bc2c72-60cf-4e32-9279-58ffeb7cbf4a",
"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-04-12T15:50:01.6693575+00:00"
},
"work_instruction_details_id": "916653bb-f2c7-4265-9dfd-951454dc8bc3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "67827c7d-8f77-4827-b642-1e14e3e38a8c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c4e80c88-6a2b-46af-9af4-8aef070f6618",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-12T15:50:01.6693575+00:00",
"remark": "sample string 13",
"advise": "sample string 14",
"sequence": 1,
"reference_back_office": "sample string 15",
"group_name": "sample string 16",
"group_sequence": 1,
"type": "sample string 17",
"instruction_document_count": 1,
"db_report_type_id": "97121a7a-1cdd-4e47-8361-b325271f75d5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-12T15:50:01.6693575+00:00"
}