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": "bfc78963-a0c1-4c31-a0e0-24a29c384e7b",
"jobs_id": "2e76956e-f429-4330-97d9-2c018d54da7e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1e911014-3043-4e15-bc77-abd2dc9e3a48",
"_parent_id": "2f0ad8b7-0605-45a8-a617-06c895d4893b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "84fb4539-3f80-4b48-acda-04bd32ee6b83",
"project_reference_back_office": "sample string 5",
"project": {
"id": "aa4a1d45-277a-48dd-93ec-47653f957181",
"_parent_id": "9f8cf752-2007-4881-b1aa-b26e45bbbe41",
"root_parent_id": "0e629d35-062a-4623-b76a-08262ffb7df1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "68199379-1325-445e-835e-3083bddefe07",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2a1ec229-01d0-40a1-b292-98aeef208318",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "af961381-02a0-4d15-a745-e2b65ebae47c",
"_parent_code": "sample string 6",
"sales_organization_id": "be50ce6d-7f85-4e25-85cf-91c110c3a160",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2e2dded4-3f4e-477b-8a28-384cec243280",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5b8c1a0-57f0-400d-8dfe-85d7a09b07f9",
"db_currency_id": "7956ed14-24ef-4f3f-95a8-fe6735fb0244",
"db_language_id": "e06a95b9-0b37-44f5-aad2-0d26f7030d15",
"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-24T09:38:12.683297+00:00"
},
"modified_dateutc": "2026-04-24T09:38:12.683297+00:00"
},
"equipment_model_id": "e410081d-a4a3-4341-8b45-b603672f2034",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "13260d3e-108c-4e1d-af77-dd5138177a99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3a16476a-9327-46ea-a417-a26cfe7a89b4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "38e5bc26-6dff-4794-a14b-f6532623e84a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "87465892-51f9-43be-ab4a-2b04b7d61e0d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2e2dded4-3f4e-477b-8a28-384cec243280",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5b8c1a0-57f0-400d-8dfe-85d7a09b07f9",
"db_currency_id": "7956ed14-24ef-4f3f-95a8-fe6735fb0244",
"db_language_id": "e06a95b9-0b37-44f5-aad2-0d26f7030d15",
"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-24T09:38:12.683297+00:00"
},
"modified_dateutc": "2026-04-24T09:38:12.683297+00:00"
},
"equipment_family_id": "ad9215b0-da12-4690-bb25-4b8834c0d88d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2a1ec229-01d0-40a1-b292-98aeef208318",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "af961381-02a0-4d15-a745-e2b65ebae47c",
"_parent_code": "sample string 6",
"sales_organization_id": "be50ce6d-7f85-4e25-85cf-91c110c3a160",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2e2dded4-3f4e-477b-8a28-384cec243280",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5b8c1a0-57f0-400d-8dfe-85d7a09b07f9",
"db_currency_id": "7956ed14-24ef-4f3f-95a8-fe6735fb0244",
"db_language_id": "e06a95b9-0b37-44f5-aad2-0d26f7030d15",
"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-24T09:38:12.683297+00:00"
},
"modified_dateutc": "2026-04-24T09:38:12.683297+00:00"
},
"date_in_production_since": "2026-04-24T09:38:12.683297+00:00",
"date_out_of_production_since": "2026-04-24T09:38:12.683297+00:00",
"date_end_support": "2026-04-24T09:38:12.683297+00:00",
"sales_organization_id": "95bb631f-480d-43cc-b8ed-16b20ab22e81",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2e2dded4-3f4e-477b-8a28-384cec243280",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5b8c1a0-57f0-400d-8dfe-85d7a09b07f9",
"db_currency_id": "7956ed14-24ef-4f3f-95a8-fe6735fb0244",
"db_language_id": "e06a95b9-0b37-44f5-aad2-0d26f7030d15",
"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-24T09:38:12.683297+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-24T09:38:12.683297+00:00"
},
"project_status_id": "7b6f9937-e367-4a1f-bf37-93ab1771f02b",
"project_status_code": "sample string 10",
"project_status": {
"id": "6f496b6f-7c78-4b7b-bfdb-3b2af9c0e251",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7a3f270b-28d8-401a-ab46-6b81b016e6e7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2e2dded4-3f4e-477b-8a28-384cec243280",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5b8c1a0-57f0-400d-8dfe-85d7a09b07f9",
"db_currency_id": "7956ed14-24ef-4f3f-95a8-fe6735fb0244",
"db_language_id": "e06a95b9-0b37-44f5-aad2-0d26f7030d15",
"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-24T09:38:12.683297+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-24T09:38:12.683297+00:00"
},
"company_id": "3f5fc08e-8eb1-48f9-974a-e1541b107670",
"company_code": "sample string 12",
"db_address_id": "e3fcaa6a-8780-4f74-983a-491b11f1e833",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0a248fbf-866b-4e76-ad94-5fa6cad7f840",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c0d95b8c-dd98-42c3-b541-657cb9e58588",
"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-24T09:38:12.683297+00:00",
"date_create": "2026-04-24T09:38:12.683297+00:00",
"date_update": "2026-04-24T09:38:12.683297+00:00",
"updated_by_user_id": "d7351210-1551-45e5-a3aa-d5972ee1c811",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-24T09:38:12.683297+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-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-24T09:38:12.683297+00:00",
"date_last_job": "2026-04-24T09:38:12.683297+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-24T09:38:12.683297+00:00",
"modified_dateutc": "2026-04-24T09:38:12.683297+00:00",
"is_mobile_installation": true
},
"job_type_id": "8c2d6d40-5e40-44c4-b976-77c29e9d511d",
"job_type_code": "sample string 7",
"job_type": {
"id": "552dcc09-3cc2-4c04-82a4-a5d63672597b",
"name": "sample string 2",
"sales_organization_id": "848cd50e-535d-4448-8945-005679cbfad3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-24T09:38:12.683297+00:00",
"code": "sample string 7"
},
"job_priority_id": "c2c7aedf-9bd7-4d14-b6d8-b55d73ea8713",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fa656fa5-9be0-4f77-b747-17ca1a2ed2bd",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "dfef2a4c-bceb-440f-8768-914487d2ec56",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2e2dded4-3f4e-477b-8a28-384cec243280",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5b8c1a0-57f0-400d-8dfe-85d7a09b07f9",
"db_currency_id": "7956ed14-24ef-4f3f-95a8-fe6735fb0244",
"db_language_id": "e06a95b9-0b37-44f5-aad2-0d26f7030d15",
"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-24T09:38:12.683297+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-24T09:38:12.683297+00:00"
},
"job_status_id": "472807c8-b611-4eec-bacc-9cc2eee36b33",
"job_status_code": "sample string 11",
"db_address_id": "6b96ab40-8a82-4635-921b-2fa3a763c3a3",
"contact_id": "197ef7be-9fb2-4f93-ae77-a51f9baab1de",
"requested_by_company_id": "dd58890b-245c-4c43-8794-944fce527ee0",
"requested_by_contact_id": "1e966bfe-9efd-466b-9f11-fd9c5dccaeca",
"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-24T09:38:12.683297+00:00",
"due_date": "2026-04-24T09:38:12.683297+00:00",
"date_create": "2026-04-24T09:38:12.683297+00:00",
"date_update": "2026-04-24T09:38:12.683297+00:00",
"date_closed": "2026-04-24T09:38:12.683297+00:00",
"suggested_user_id": "561f6fa4-cb6a-40b4-82e9-6550cadbd51e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a3c680a2-b57c-45bd-803e-4cf2c9856671",
"db_language_id": "44ed2995-6f8a-46e9-94d4-d495fb53c8a5",
"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-24T09:38:12.683297+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7d7fd565-cc36-4e27-9c28-bc9737386ef8",
"sales_organization": {
"id": "2e2dded4-3f4e-477b-8a28-384cec243280",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5b8c1a0-57f0-400d-8dfe-85d7a09b07f9",
"db_currency_id": "7956ed14-24ef-4f3f-95a8-fe6735fb0244",
"db_language_id": "e06a95b9-0b37-44f5-aad2-0d26f7030d15",
"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-24T09:38:12.683297+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "56cc2b5c-df02-4678-833b-72158ad9587b",
"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": "477360d9-5961-4b36-88cc-fe0bc5129768",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-24T09:38:12.683297+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ea645f8c-47df-410a-8c8a-2339cc7a9345"
},
"suggested_date_start": "2026-04-24T09:38:12.683297+00:00",
"skill_id": "7e21fd6e-5542-4a58-a847-a28e3071f0b8",
"skill_code": "sample string 32",
"skill": {
"id": "0260aed7-0920-4d27-a8c4-721cbff0aec7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0759a230-4661-43b3-858c-d2b5a5a263b9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2e2dded4-3f4e-477b-8a28-384cec243280",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5b8c1a0-57f0-400d-8dfe-85d7a09b07f9",
"db_currency_id": "7956ed14-24ef-4f3f-95a8-fe6735fb0244",
"db_language_id": "e06a95b9-0b37-44f5-aad2-0d26f7030d15",
"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-24T09:38:12.683297+00:00"
},
"modified_dateutc": "2026-04-24T09:38:12.683297+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fd41715c-f318-4c93-9a7f-7da059f0bca8",
"date_reported_by_company": "2026-04-24T09:38:12.683297+00:00",
"id2": 36,
"company_id": "ada3420d-a6f5-466b-924c-45ddab01a863",
"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": "ed2b7494-4aed-4290-a6d7-ed6a53355e83",
"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-24T09:38:12.683297+00:00"
},
"work_instruction_details_id": "02bb53e4-b228-4c15-85eb-d9fac5eee78a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e7d29204-a017-4c01-9741-abdc05f43f1a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8cedeba4-fe4d-42d1-849b-ba8b7f05e351",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-24T09:38:12.7145432+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": "55c53efa-4558-4664-8097-f9e0ba39be6b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-24T09:38:12.7145432+00:00"
}