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": "0e30915b-13df-48bb-8b8d-0f959226b11b",
"jobs_id": "51601445-5592-4d3c-9222-bc92588a785a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "531c0498-4d0a-48f3-9594-74d38a7b2360",
"_parent_id": "99807a74-7b77-421d-ad30-04f711486ce7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6353fd33-4845-4d9a-ab9f-1313e72c92a1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c6cde06b-c85f-4d87-b1a3-b2ccf060c246",
"_parent_id": "6c7be435-7072-483e-ae72-19b274741797",
"root_parent_id": "b9d6c461-50bd-4979-a228-88154e33e4f0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f5016f68-b109-4875-ace7-cead37751384",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "eeeb0735-8b9f-4c7a-a40d-ff1248511783",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7a2f6f28-9820-4f7a-b48e-8592e67b2ddf",
"_parent_code": "sample string 6",
"sales_organization_id": "9e60bf59-930f-43c8-8e43-beec5ad7e6c8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ccf166d8-4c24-4460-9efa-3abce1878bed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ab26b3e7-b249-4092-80a6-7cf2af798320",
"db_currency_id": "bee169cc-682e-4ae4-97f0-590b06604eb2",
"db_language_id": "1923eb10-0218-4a86-a7d9-fecd329f354c",
"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-10-16T06:22:24.1085727+00:00"
},
"modified_dateutc": "2026-10-16T06:22:24.1085727+00:00"
},
"equipment_model_id": "9bf9d833-3152-420c-9dab-7a5d242f228c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "be508e18-46b0-4301-abe7-cc9b14bf486e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "21ae18f1-e3af-42c0-94f5-68f8f9193eae",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d39b8745-bca6-4abf-b02a-c0ee6ad895b7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "05c22640-5fcd-4836-967d-bc5012bd8256",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ccf166d8-4c24-4460-9efa-3abce1878bed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ab26b3e7-b249-4092-80a6-7cf2af798320",
"db_currency_id": "bee169cc-682e-4ae4-97f0-590b06604eb2",
"db_language_id": "1923eb10-0218-4a86-a7d9-fecd329f354c",
"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-10-16T06:22:24.1085727+00:00"
},
"modified_dateutc": "2026-10-16T06:22:24.1085727+00:00"
},
"equipment_family_id": "a4aad146-c2a0-4880-8876-a28723887079",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "eeeb0735-8b9f-4c7a-a40d-ff1248511783",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7a2f6f28-9820-4f7a-b48e-8592e67b2ddf",
"_parent_code": "sample string 6",
"sales_organization_id": "9e60bf59-930f-43c8-8e43-beec5ad7e6c8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ccf166d8-4c24-4460-9efa-3abce1878bed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ab26b3e7-b249-4092-80a6-7cf2af798320",
"db_currency_id": "bee169cc-682e-4ae4-97f0-590b06604eb2",
"db_language_id": "1923eb10-0218-4a86-a7d9-fecd329f354c",
"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-10-16T06:22:24.1085727+00:00"
},
"modified_dateutc": "2026-10-16T06:22:24.1085727+00:00"
},
"date_in_production_since": "2026-10-16T06:22:24.1085727+00:00",
"date_out_of_production_since": "2026-10-16T06:22:24.1085727+00:00",
"date_end_support": "2026-10-16T06:22:24.1085727+00:00",
"sales_organization_id": "d3653f3f-5276-4007-b410-3dfcb7b17ea7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ccf166d8-4c24-4460-9efa-3abce1878bed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ab26b3e7-b249-4092-80a6-7cf2af798320",
"db_currency_id": "bee169cc-682e-4ae4-97f0-590b06604eb2",
"db_language_id": "1923eb10-0218-4a86-a7d9-fecd329f354c",
"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-10-16T06:22:24.1085727+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-10-16T06:22:24.1385462+00:00"
},
"project_status_id": "04ac7eb1-3b71-4efa-80be-a4d3487d4af1",
"project_status_code": "sample string 10",
"project_status": {
"id": "64b3ea54-9633-4106-8a28-a01716d6c3dc",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "91fafdde-cedd-4d29-8614-dece0ae38af0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ccf166d8-4c24-4460-9efa-3abce1878bed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ab26b3e7-b249-4092-80a6-7cf2af798320",
"db_currency_id": "bee169cc-682e-4ae4-97f0-590b06604eb2",
"db_language_id": "1923eb10-0218-4a86-a7d9-fecd329f354c",
"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-10-16T06:22:24.1085727+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-16T06:22:24.1385462+00:00"
},
"company_id": "16a980ab-f545-4cc8-87ec-2e3451925511",
"company_code": "sample string 12",
"db_address_id": "5db4c843-240b-419f-84ef-b2490042f0ce",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3da6a47c-096a-41e6-87f7-0a73e6b612d8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "626ef5a1-ddff-4441-899c-6d6051d3b40f",
"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-10-16T06:22:24.1385462+00:00",
"date_create": "2026-10-16T06:22:24.1385462+00:00",
"date_update": "2026-10-16T06:22:24.1385462+00:00",
"updated_by_user_id": "9350c7a0-184e-4643-90c3-1d2795b63b10",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-16T06:22:24.1385462+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-10-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-16T06:22:24.1385462+00:00",
"date_last_job": "2026-10-16T06:22:24.1385462+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-16T06:22:24.1385462+00:00",
"modified_dateutc": "2026-10-16T06:22:24.1385462+00:00",
"is_mobile_installation": true
},
"job_type_id": "284d7ca9-81a7-4541-997a-fdee9ee0d0d8",
"job_type_code": "sample string 7",
"job_type": {
"id": "9aeed55a-0bda-44d9-a525-1e4af4f29ab0",
"name": "sample string 2",
"sales_organization_id": "d08682ee-cfa2-4c37-8b43-55c63a58f65b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-16T06:22:24.1385462+00:00",
"code": "sample string 7"
},
"job_priority_id": "4c5bac8f-1431-48b7-a5fc-8769b2564ba0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e44152d5-2359-42ea-8804-ab41ddf297af",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a43787bf-7679-4f73-a5a1-2c23a9874455",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ccf166d8-4c24-4460-9efa-3abce1878bed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ab26b3e7-b249-4092-80a6-7cf2af798320",
"db_currency_id": "bee169cc-682e-4ae4-97f0-590b06604eb2",
"db_language_id": "1923eb10-0218-4a86-a7d9-fecd329f354c",
"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-10-16T06:22:24.1085727+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-16T06:22:24.1385462+00:00"
},
"job_status_id": "118eb388-2a95-4315-aa54-a1fb0a405df1",
"job_status_code": "sample string 11",
"db_address_id": "ef35a946-f926-4d94-be63-72912a279580",
"contact_id": "f5a7eb1c-310a-478e-ba14-c8108d655ab7",
"requested_by_company_id": "9f4b8c4b-dba0-451b-b94a-56d2511a5168",
"requested_by_contact_id": "f3740171-5164-40c2-9dbc-fa453358054d",
"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-10-16T06:22:24.1585236+00:00",
"due_date": "2026-10-16T06:22:24.1585236+00:00",
"date_create": "2026-10-16T06:22:24.1585236+00:00",
"date_update": "2026-10-16T06:22:24.1585236+00:00",
"date_closed": "2026-10-16T06:22:24.1585236+00:00",
"suggested_user_id": "731821f6-d6a9-4a13-a1d8-1215438c57bb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "531276c6-67ac-407a-8905-c5aac1a34b7c",
"db_language_id": "cf499e03-6d59-4c31-b4ba-559eefc9987d",
"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-10-16T06:22:24.1585236+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4f03559b-6eba-4571-b3cf-1cbb7db5b9e2",
"sales_organization": {
"id": "ccf166d8-4c24-4460-9efa-3abce1878bed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ab26b3e7-b249-4092-80a6-7cf2af798320",
"db_currency_id": "bee169cc-682e-4ae4-97f0-590b06604eb2",
"db_language_id": "1923eb10-0218-4a86-a7d9-fecd329f354c",
"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-10-16T06:22:24.1085727+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c34fb990-35c0-416e-b1cf-9d12870e975f",
"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": "c27ccd55-f8ea-4860-a3bc-54f63a06e403",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-16T06:22:24.1585236+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3f9353af-2fa0-41b1-9d1a-6767d6f6abec"
},
"suggested_date_start": "2026-10-16T06:22:24.1585236+00:00",
"skill_id": "3557db70-7026-422f-9fbc-7411aed9ce60",
"skill_code": "sample string 32",
"skill": {
"id": "ab556906-a254-422e-a292-5507877f4131",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7dbd429a-64fe-4927-9492-171f96de9a3b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ccf166d8-4c24-4460-9efa-3abce1878bed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ab26b3e7-b249-4092-80a6-7cf2af798320",
"db_currency_id": "bee169cc-682e-4ae4-97f0-590b06604eb2",
"db_language_id": "1923eb10-0218-4a86-a7d9-fecd329f354c",
"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-10-16T06:22:24.1085727+00:00"
},
"modified_dateutc": "2026-10-16T06:22:24.1585236+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "eea465d4-b705-42f5-a5db-726e0e6cb6a3",
"date_reported_by_company": "2026-10-16T06:22:24.1585236+00:00",
"id2": 36,
"company_id": "765c8482-88c1-4a01-8c21-dfe0ed833008",
"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": "b8885e80-8371-4f96-8f97-a2335eb6132e",
"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-10-16T06:22:24.1585236+00:00"
},
"work_instruction_details_id": "a98ae9c5-b8a0-4cc2-84ee-2f26a08980f3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8f952ff4-22ea-4ad6-a7e3-9f0687689e06",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e35b0368-4787-4e71-a393-3fb3250c3891",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-16T06:22:24.1585236+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": "79126df2-9742-43d4-964f-8631924fc704",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-16T06:22:24.1585236+00:00"
}