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": "738be208-5191-45d3-b03c-dcfe621ee0a1",
"jobs_id": "4b4aad5b-15a9-4635-9212-2fbb9423f104",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "60821e40-1d3e-4bf1-ab6e-1f94f21b02ce",
"_parent_id": "aecf0fdf-fda5-47e1-93de-875948d68c6e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "46d7013a-4ff2-4543-a9f3-cd399d32e4ea",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c53b09aa-5fda-4f8a-87e3-f6a11440b27d",
"_parent_id": "7852012b-ac48-4848-a0b6-e2f0947e1420",
"root_parent_id": "eae5ef33-b565-40c2-9300-dadd78f61f76",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "64157761-40fc-492a-87ea-c72c10b434e2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "953b0951-572d-4c9e-800d-fc762f4c9caf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2350de53-f4a6-450a-a7e4-010da03c189b",
"_parent_code": "sample string 6",
"sales_organization_id": "7ac39245-9ef4-49f9-a802-2948cdba2dde",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "773b8ae8-f007-4692-b7ca-6069ef43e6eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9ede3d0c-cc32-44fc-9dc7-8ce594e81484",
"db_currency_id": "837c70fa-b3d6-497f-855a-12b42f243432",
"db_language_id": "9bec545c-ed8f-4bb7-a6c8-9c82b7a1dc9c",
"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-11-13T15:20:42.8930623+00:00"
},
"modified_dateutc": "2026-11-13T15:20:42.8930623+00:00"
},
"equipment_model_id": "5547cb33-f0b7-4325-b94c-26d6a2043390",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "354493e3-0732-47fb-bb92-3dd98836f384",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f71f83a8-e96d-44cb-9aef-bb2bce9322a6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fefe8430-55bf-4b69-8f87-19bda39a073a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f3825f4a-4d7c-4c6f-8645-8229b426985e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "773b8ae8-f007-4692-b7ca-6069ef43e6eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9ede3d0c-cc32-44fc-9dc7-8ce594e81484",
"db_currency_id": "837c70fa-b3d6-497f-855a-12b42f243432",
"db_language_id": "9bec545c-ed8f-4bb7-a6c8-9c82b7a1dc9c",
"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-11-13T15:20:42.8930623+00:00"
},
"modified_dateutc": "2026-11-13T15:20:42.8930623+00:00"
},
"equipment_family_id": "3386b51c-65ea-4f46-813c-d7d1b2317e9c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "953b0951-572d-4c9e-800d-fc762f4c9caf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2350de53-f4a6-450a-a7e4-010da03c189b",
"_parent_code": "sample string 6",
"sales_organization_id": "7ac39245-9ef4-49f9-a802-2948cdba2dde",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "773b8ae8-f007-4692-b7ca-6069ef43e6eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9ede3d0c-cc32-44fc-9dc7-8ce594e81484",
"db_currency_id": "837c70fa-b3d6-497f-855a-12b42f243432",
"db_language_id": "9bec545c-ed8f-4bb7-a6c8-9c82b7a1dc9c",
"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-11-13T15:20:42.8930623+00:00"
},
"modified_dateutc": "2026-11-13T15:20:42.8930623+00:00"
},
"date_in_production_since": "2026-11-13T15:20:42.8930623+00:00",
"date_out_of_production_since": "2026-11-13T15:20:42.8930623+00:00",
"date_end_support": "2026-11-13T15:20:42.8930623+00:00",
"sales_organization_id": "60663453-40aa-466f-adb8-7ee0bf62d61c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "773b8ae8-f007-4692-b7ca-6069ef43e6eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9ede3d0c-cc32-44fc-9dc7-8ce594e81484",
"db_currency_id": "837c70fa-b3d6-497f-855a-12b42f243432",
"db_language_id": "9bec545c-ed8f-4bb7-a6c8-9c82b7a1dc9c",
"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-11-13T15:20:42.8930623+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-11-13T15:20:42.8930623+00:00"
},
"project_status_id": "a159ff87-99f2-4af8-8dd2-d925e1a80e47",
"project_status_code": "sample string 10",
"project_status": {
"id": "7c6b15de-053d-4dfd-9cbe-0668604b608a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c51c3bf5-6246-443c-87de-99e14459f068",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "773b8ae8-f007-4692-b7ca-6069ef43e6eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9ede3d0c-cc32-44fc-9dc7-8ce594e81484",
"db_currency_id": "837c70fa-b3d6-497f-855a-12b42f243432",
"db_language_id": "9bec545c-ed8f-4bb7-a6c8-9c82b7a1dc9c",
"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-11-13T15:20:42.8930623+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-13T15:20:42.8930623+00:00"
},
"company_id": "8dbadd06-be18-4f92-8e7b-a8f4a0e81e17",
"company_code": "sample string 12",
"db_address_id": "8aeebd0e-65ce-4ed5-b212-bd0af1c928d7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "afc8a476-3009-432c-ad5e-18f765f93203",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d77d65b5-8894-4b1d-83fe-f9272245eafe",
"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-11-13T15:20:42.8930623+00:00",
"date_create": "2026-11-13T15:20:42.8930623+00:00",
"date_update": "2026-11-13T15:20:42.8930623+00:00",
"updated_by_user_id": "c4663952-3f9e-4b40-9452-3f4dafb0f0c3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-13T15:20:42.8930623+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-11-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-13T15:20:42.8930623+00:00",
"date_last_job": "2026-11-13T15:20:42.8930623+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-13T15:20:42.8930623+00:00",
"modified_dateutc": "2026-11-13T15:20:42.8930623+00:00",
"is_mobile_installation": true
},
"job_type_id": "f99653e1-05fb-4835-bb22-7c5f2c8c88d2",
"job_type_code": "sample string 7",
"job_type": {
"id": "68e9a164-91a0-4686-8686-781452b4905a",
"name": "sample string 2",
"sales_organization_id": "d7f0d07d-46ad-4a7c-8815-7bdd45fbb326",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-13T15:20:42.8930623+00:00",
"code": "sample string 7"
},
"job_priority_id": "3574dbb4-91e3-4b59-ae7e-dfc7cd461a4a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "dd12a3ef-2d32-47a8-ab14-703333864bc7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1d2a1bd3-32d0-412c-925f-001d048765bb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "773b8ae8-f007-4692-b7ca-6069ef43e6eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9ede3d0c-cc32-44fc-9dc7-8ce594e81484",
"db_currency_id": "837c70fa-b3d6-497f-855a-12b42f243432",
"db_language_id": "9bec545c-ed8f-4bb7-a6c8-9c82b7a1dc9c",
"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-11-13T15:20:42.8930623+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-13T15:20:42.8930623+00:00"
},
"job_status_id": "5b79547a-4475-42a2-9742-6b639e66909e",
"job_status_code": "sample string 11",
"db_address_id": "fbb9e02e-13c7-4ca2-bfae-dcc92c3625a0",
"contact_id": "357b11b8-1d06-416a-baf2-0770217850a8",
"requested_by_company_id": "e9d57925-6be1-41e4-bcde-6935fdcc7a1a",
"requested_by_contact_id": "6415d461-63ca-4a8b-a441-144501c4c07b",
"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-11-13T15:20:42.8930623+00:00",
"due_date": "2026-11-13T15:20:42.8930623+00:00",
"date_create": "2026-11-13T15:20:42.9119056+00:00",
"date_update": "2026-11-13T15:20:42.9119056+00:00",
"date_closed": "2026-11-13T15:20:42.9119056+00:00",
"suggested_user_id": "d101a6b2-3efc-496b-9066-0da73b091b0c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a44f9efc-570d-4ebc-9953-665d288aff17",
"db_language_id": "35cf5421-cdf0-4d0c-907f-a6b774537028",
"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-11-13T15:20:42.9119056+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8346678f-3a50-4650-a6b0-eb8177c11fa7",
"sales_organization": {
"id": "773b8ae8-f007-4692-b7ca-6069ef43e6eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9ede3d0c-cc32-44fc-9dc7-8ce594e81484",
"db_currency_id": "837c70fa-b3d6-497f-855a-12b42f243432",
"db_language_id": "9bec545c-ed8f-4bb7-a6c8-9c82b7a1dc9c",
"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-11-13T15:20:42.8930623+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2dacc225-f64c-4d60-b137-a45ee907fdf2",
"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": "f99423b1-3c84-41f0-831b-33f9db9aea2e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-13T15:20:42.9119056+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8f4bf6da-9ae4-4ef5-87ba-3c2fbc32e41d"
},
"suggested_date_start": "2026-11-13T15:20:42.9119056+00:00",
"skill_id": "8ac37528-4e1f-4226-82e5-3d356e2b4645",
"skill_code": "sample string 32",
"skill": {
"id": "c87cab50-21c7-4597-95b9-fea0802b617e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a80b560d-3b62-4cc7-a785-02a2e4def4a2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "773b8ae8-f007-4692-b7ca-6069ef43e6eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9ede3d0c-cc32-44fc-9dc7-8ce594e81484",
"db_currency_id": "837c70fa-b3d6-497f-855a-12b42f243432",
"db_language_id": "9bec545c-ed8f-4bb7-a6c8-9c82b7a1dc9c",
"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-11-13T15:20:42.8930623+00:00"
},
"modified_dateutc": "2026-11-13T15:20:42.9119056+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0c6631fe-8b70-4ca2-8530-53fef0a0f7ce",
"date_reported_by_company": "2026-11-13T15:20:42.9119056+00:00",
"id2": 36,
"company_id": "842d9e6d-9921-4159-89ae-9261df5c7d5b",
"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": "4246b944-00d9-4af0-b480-93ef8228a797",
"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-11-13T15:20:42.9119056+00:00"
},
"work_instruction_details_id": "cd7f13bf-791d-4723-a8e8-352414f4bd0f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0e9c7b06-069d-4837-9fd3-4abe3ea5030b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "08eaa0a8-e73a-4bb1-a7f5-f24eda82f880",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-13T15:20:42.9119056+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": "92e32c32-a491-4196-ad5a-5602caf39fdf",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-13T15:20:42.9119056+00:00"
}