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": "ca42abb2-1a54-44b1-9312-5284ebf482e7",
"jobs_id": "c065fda3-525f-4ae8-8d61-03246defc2da",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9e4cc4e3-e265-4880-a41b-42305c1b2c61",
"_parent_id": "2c96114e-b577-4291-b87e-b6139d78296e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6be5bc69-a727-4cd6-978a-076b8e1bf8a8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9d3f6701-5263-4a12-a50f-33d085aa8492",
"_parent_id": "ddf6ae21-c127-4145-be20-70a551297dbb",
"root_parent_id": "a26ccb14-309c-40ae-ad4e-d9371125b1ac",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f8a165dd-c375-47be-b182-8cdd99bf63c8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3787b276-9cdd-4774-8f44-630b77f1cdd0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0b1c9cf1-04b3-47af-a614-d1ae82570919",
"_parent_code": "sample string 6",
"sales_organization_id": "e15a4649-4b73-460c-9408-187e0fdf27f1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b310024c-ba66-431b-a0a9-17149cc35b28",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6022475-1fff-40f2-b0a7-c13cda01d140",
"db_currency_id": "b869c073-bec5-41f9-af9f-5b917377a188",
"db_language_id": "c9630b57-98f3-4312-b75a-80f178a70995",
"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-07-08T08:05:33.2327161+00:00"
},
"modified_dateutc": "2026-07-08T08:05:33.2327161+00:00"
},
"equipment_model_id": "8d636ac5-febc-464f-a30b-b87166f85d63",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ea171245-8345-4062-bff4-feb73c2b8e9c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ac32ca3f-4cd8-4319-bf89-d7cad8527886",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "46e5c60a-3ad9-487c-b1c8-e4357897bbbe",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "021ebc6d-a639-4f59-baf2-27d63fc430bc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b310024c-ba66-431b-a0a9-17149cc35b28",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6022475-1fff-40f2-b0a7-c13cda01d140",
"db_currency_id": "b869c073-bec5-41f9-af9f-5b917377a188",
"db_language_id": "c9630b57-98f3-4312-b75a-80f178a70995",
"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-07-08T08:05:33.2327161+00:00"
},
"modified_dateutc": "2026-07-08T08:05:33.2327161+00:00"
},
"equipment_family_id": "a76f762e-2e22-44ee-b392-2eee50bfb28f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3787b276-9cdd-4774-8f44-630b77f1cdd0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0b1c9cf1-04b3-47af-a614-d1ae82570919",
"_parent_code": "sample string 6",
"sales_organization_id": "e15a4649-4b73-460c-9408-187e0fdf27f1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b310024c-ba66-431b-a0a9-17149cc35b28",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6022475-1fff-40f2-b0a7-c13cda01d140",
"db_currency_id": "b869c073-bec5-41f9-af9f-5b917377a188",
"db_language_id": "c9630b57-98f3-4312-b75a-80f178a70995",
"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-07-08T08:05:33.2327161+00:00"
},
"modified_dateutc": "2026-07-08T08:05:33.2327161+00:00"
},
"date_in_production_since": "2026-07-08T08:05:33.2327161+00:00",
"date_out_of_production_since": "2026-07-08T08:05:33.2327161+00:00",
"date_end_support": "2026-07-08T08:05:33.2327161+00:00",
"sales_organization_id": "e733a480-5139-4727-8010-d9fd09a06bb1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b310024c-ba66-431b-a0a9-17149cc35b28",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6022475-1fff-40f2-b0a7-c13cda01d140",
"db_currency_id": "b869c073-bec5-41f9-af9f-5b917377a188",
"db_language_id": "c9630b57-98f3-4312-b75a-80f178a70995",
"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-07-08T08:05:33.2327161+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-07-08T08:05:33.2327161+00:00"
},
"project_status_id": "dce4c240-19a7-4b31-a4ff-2ac8df440b12",
"project_status_code": "sample string 10",
"project_status": {
"id": "96590878-9765-4d97-a8ea-e067585d6513",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fc16fcc3-6509-4954-b300-5ac0734afb6a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b310024c-ba66-431b-a0a9-17149cc35b28",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6022475-1fff-40f2-b0a7-c13cda01d140",
"db_currency_id": "b869c073-bec5-41f9-af9f-5b917377a188",
"db_language_id": "c9630b57-98f3-4312-b75a-80f178a70995",
"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-07-08T08:05:33.2327161+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-08T08:05:33.2327161+00:00"
},
"company_id": "e50d9439-bd6d-4add-965b-97f234551dd4",
"company_code": "sample string 12",
"db_address_id": "943b46b2-a9fc-4980-be0d-2a94c86c87b6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b8249785-f9c0-49e2-ac5c-cfae939e058c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "715568c6-2160-4dde-8a9e-3e33b3fd3316",
"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-07-08T08:05:33.2327161+00:00",
"date_create": "2026-07-08T08:05:33.2327161+00:00",
"date_update": "2026-07-08T08:05:33.2327161+00:00",
"updated_by_user_id": "b4435a06-eefe-4179-8f21-9d5893c60e7c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-08T08:05:33.2327161+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-07-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-08T08:05:33.2327161+00:00",
"date_last_job": "2026-07-08T08:05:33.2327161+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-08T08:05:33.2327161+00:00",
"modified_dateutc": "2026-07-08T08:05:33.2327161+00:00",
"is_mobile_installation": true
},
"job_type_id": "181ddc14-9c28-4c2a-816f-2247d312c35a",
"job_type_code": "sample string 7",
"job_type": {
"id": "1ace78cc-4589-4b93-8b99-679ddb23cfb8",
"name": "sample string 2",
"sales_organization_id": "60548797-b3a5-4b37-9a1c-3276a1787eb1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-08T08:05:33.2327161+00:00",
"code": "sample string 7"
},
"job_priority_id": "56533ee3-ba0a-438f-8580-bf33ccc1f9d7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d9c4b7ea-cb26-4077-b316-ded025ecbc75",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8911dbdc-9b04-444c-9b87-e1b3e59ab2d1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b310024c-ba66-431b-a0a9-17149cc35b28",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6022475-1fff-40f2-b0a7-c13cda01d140",
"db_currency_id": "b869c073-bec5-41f9-af9f-5b917377a188",
"db_language_id": "c9630b57-98f3-4312-b75a-80f178a70995",
"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-07-08T08:05:33.2327161+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-08T08:05:33.2327161+00:00"
},
"job_status_id": "61c46607-23ae-4183-9987-495c72b69c42",
"job_status_code": "sample string 11",
"db_address_id": "4d7a63ab-ad86-4d8a-91fc-85a22fa64a5f",
"contact_id": "f628a0ab-499d-43ab-ae43-5ab5cd529ff9",
"requested_by_company_id": "76653545-3499-4245-b8ae-634b5bdf5208",
"requested_by_contact_id": "c9444620-81fa-46fd-99e0-d8c546b0d410",
"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-07-08T08:05:33.2327161+00:00",
"due_date": "2026-07-08T08:05:33.2327161+00:00",
"date_create": "2026-07-08T08:05:33.2327161+00:00",
"date_update": "2026-07-08T08:05:33.2327161+00:00",
"date_closed": "2026-07-08T08:05:33.2327161+00:00",
"suggested_user_id": "d8b1979e-5169-44dd-8482-c52c9ca745e9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0d8c60c5-8405-429c-b47d-968bcc74c213",
"db_language_id": "bb5fd9bf-7837-4a58-aa3f-d8d862b743fb",
"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-07-08T08:05:33.2327161+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "45419dcd-55da-4a61-bc23-9d0121727e33",
"sales_organization": {
"id": "b310024c-ba66-431b-a0a9-17149cc35b28",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6022475-1fff-40f2-b0a7-c13cda01d140",
"db_currency_id": "b869c073-bec5-41f9-af9f-5b917377a188",
"db_language_id": "c9630b57-98f3-4312-b75a-80f178a70995",
"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-07-08T08:05:33.2327161+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "370921dd-0189-4c2e-9cc3-29275a019bbb",
"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": "0c2c5d97-d088-476b-be2f-bbd9240f5115",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-08T08:05:33.2327161+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9217b747-24dd-4d89-97c1-c98b2b48eae7"
},
"suggested_date_start": "2026-07-08T08:05:33.2327161+00:00",
"skill_id": "4104e545-676d-41e0-bdb3-d0f88e7161b3",
"skill_code": "sample string 32",
"skill": {
"id": "b025632a-9ae5-4427-a5ae-bfb651f72dc8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7c8a97d1-10d0-42e9-9e79-92e7ab3248a5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b310024c-ba66-431b-a0a9-17149cc35b28",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6022475-1fff-40f2-b0a7-c13cda01d140",
"db_currency_id": "b869c073-bec5-41f9-af9f-5b917377a188",
"db_language_id": "c9630b57-98f3-4312-b75a-80f178a70995",
"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-07-08T08:05:33.2327161+00:00"
},
"modified_dateutc": "2026-07-08T08:05:33.2327161+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a067a705-2e52-4b77-aa7c-1449299959c9",
"date_reported_by_company": "2026-07-08T08:05:33.2327161+00:00",
"id2": 36,
"company_id": "96fc281a-b255-4439-8e5d-b62068c9c6d4",
"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": "956fd2a7-35b4-457f-bd02-856d2cb03b7a",
"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-07-08T08:05:33.2327161+00:00"
},
"work_instruction_details_id": "32171ff0-8a8f-4a13-b09e-6481567976f1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3ec7cac9-49c1-4764-b623-4c97c9381cfd",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1edb4c9c-ee1c-4dce-afe1-8d10b93ebe82",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-08T08:05:33.2327161+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": "d64d8222-24c0-4e10-8eca-e1652d780d7c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-08T08:05:33.2327161+00:00"
}