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": "b79e1171-1fa2-4b53-ba56-e97bacb19948",
"jobs_id": "b835f15b-a327-46d4-a430-86b3a1f4934a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "58376603-2e4d-4cf1-80da-adc931c783b0",
"_parent_id": "6fab53d9-9081-4e3b-81a7-9363e4d11919",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "27beec06-7430-4fe3-8c7b-0fc912cd121b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ef36b4d0-067c-4bf2-9189-69d35b1cdb74",
"_parent_id": "8912d7d8-5a8f-4001-b449-b28055514b0b",
"root_parent_id": "f7ee584b-e851-4dc8-9cb2-0fadfd57c060",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "984a3bbb-f043-4546-919d-d3e1b80399bf",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "904780df-7342-4fb8-8eb2-2ef58c2badf5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a26e53e2-5a13-4faa-9b1b-823c3d9f3b3e",
"_parent_code": "sample string 6",
"sales_organization_id": "0cf50453-a902-44dc-a909-84769b08280f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "72197f80-c724-4153-9621-15dbf884d2ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a26def5f-cccc-469b-bc33-3fa7ff01396b",
"db_currency_id": "dafa6be9-379c-4724-9c85-9cc9f9c56b60",
"db_language_id": "6536c13b-c1ab-4e7b-930d-b9752172759b",
"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-05-17T00:31:34.9266989+00:00"
},
"modified_dateutc": "2026-05-17T00:31:34.9266989+00:00"
},
"equipment_model_id": "96748a18-6912-4359-bd2e-87b289fbd8e4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d10ab472-4cd6-478a-b2a8-b33bc6f8a7d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a24bc728-97e3-4213-87e1-04231c26b652",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e941ecf1-bf30-4eb8-98a0-92ef9832d02a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3742bb05-1e9c-4e19-83cd-110690c63f3d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "72197f80-c724-4153-9621-15dbf884d2ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a26def5f-cccc-469b-bc33-3fa7ff01396b",
"db_currency_id": "dafa6be9-379c-4724-9c85-9cc9f9c56b60",
"db_language_id": "6536c13b-c1ab-4e7b-930d-b9752172759b",
"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-05-17T00:31:34.9266989+00:00"
},
"modified_dateutc": "2026-05-17T00:31:34.9266989+00:00"
},
"equipment_family_id": "97973a7e-346a-4c91-8e12-5768ff70c672",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "904780df-7342-4fb8-8eb2-2ef58c2badf5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a26e53e2-5a13-4faa-9b1b-823c3d9f3b3e",
"_parent_code": "sample string 6",
"sales_organization_id": "0cf50453-a902-44dc-a909-84769b08280f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "72197f80-c724-4153-9621-15dbf884d2ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a26def5f-cccc-469b-bc33-3fa7ff01396b",
"db_currency_id": "dafa6be9-379c-4724-9c85-9cc9f9c56b60",
"db_language_id": "6536c13b-c1ab-4e7b-930d-b9752172759b",
"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-05-17T00:31:34.9266989+00:00"
},
"modified_dateutc": "2026-05-17T00:31:34.9266989+00:00"
},
"date_in_production_since": "2026-05-17T00:31:34.9266989+00:00",
"date_out_of_production_since": "2026-05-17T00:31:34.9266989+00:00",
"date_end_support": "2026-05-17T00:31:34.9266989+00:00",
"sales_organization_id": "a12d59d6-f48f-48dd-8c5f-c0effdc0a725",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "72197f80-c724-4153-9621-15dbf884d2ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a26def5f-cccc-469b-bc33-3fa7ff01396b",
"db_currency_id": "dafa6be9-379c-4724-9c85-9cc9f9c56b60",
"db_language_id": "6536c13b-c1ab-4e7b-930d-b9752172759b",
"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-05-17T00:31:34.9266989+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-05-17T00:31:34.9266989+00:00"
},
"project_status_id": "88e09d7e-c659-472c-b299-fdf7e794ead0",
"project_status_code": "sample string 10",
"project_status": {
"id": "81f0a867-287e-4318-b891-77a7611ba94b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cfe14398-fa42-4014-b9a6-b8ad4daa4c3c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "72197f80-c724-4153-9621-15dbf884d2ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a26def5f-cccc-469b-bc33-3fa7ff01396b",
"db_currency_id": "dafa6be9-379c-4724-9c85-9cc9f9c56b60",
"db_language_id": "6536c13b-c1ab-4e7b-930d-b9752172759b",
"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-05-17T00:31:34.9266989+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-17T00:31:34.9266989+00:00"
},
"company_id": "691c653d-2ce2-4955-b167-fbb54c4a2354",
"company_code": "sample string 12",
"db_address_id": "d45b5947-d5a8-4c32-ae74-1dcc461fb5b4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4b080105-66c8-4b8b-b2af-728dba0273e1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "02aa115d-3279-4287-b2c7-2e7039f4a690",
"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-05-17T00:31:34.9266989+00:00",
"date_create": "2026-05-17T00:31:34.9266989+00:00",
"date_update": "2026-05-17T00:31:34.9266989+00:00",
"updated_by_user_id": "3cb3c9b5-c1fc-43a9-beeb-702b0d877d74",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-17T00:31:34.9266989+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-05-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-17T00:31:34.9266989+00:00",
"date_last_job": "2026-05-17T00:31:34.9266989+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-17T00:31:34.9266989+00:00",
"modified_dateutc": "2026-05-17T00:31:34.9266989+00:00",
"is_mobile_installation": true
},
"job_type_id": "db133f75-800a-48f5-92db-597c1105b86f",
"job_type_code": "sample string 7",
"job_type": {
"id": "312e608c-031f-42ce-8e89-bafed4da6e2f",
"name": "sample string 2",
"sales_organization_id": "ccb0c992-ae8b-42ac-bfa4-b8cb15148e7d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-17T00:31:34.9266989+00:00",
"code": "sample string 7"
},
"job_priority_id": "d0957c82-01a0-4422-b665-c3cefcc63f61",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cb8c0bc4-550c-43a5-812f-22e2fd0daa09",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "41740678-82dd-4b1d-945b-5de0a0f4e04b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "72197f80-c724-4153-9621-15dbf884d2ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a26def5f-cccc-469b-bc33-3fa7ff01396b",
"db_currency_id": "dafa6be9-379c-4724-9c85-9cc9f9c56b60",
"db_language_id": "6536c13b-c1ab-4e7b-930d-b9752172759b",
"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-05-17T00:31:34.9266989+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-17T00:31:34.9266989+00:00"
},
"job_status_id": "bbae962a-3d90-48d1-aaeb-d286260a9777",
"job_status_code": "sample string 11",
"db_address_id": "cbdb1561-0a0a-4c54-9d15-6c90b7767b37",
"contact_id": "b316bf97-2e27-473b-8c62-f5e5d9a94cee",
"requested_by_company_id": "e6139d1a-bf1b-4fac-bc41-38588c7756fb",
"requested_by_contact_id": "52c7b845-35d3-4f0c-b07f-f172c16b6724",
"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-05-17T00:31:34.9266989+00:00",
"due_date": "2026-05-17T00:31:34.9266989+00:00",
"date_create": "2026-05-17T00:31:34.9266989+00:00",
"date_update": "2026-05-17T00:31:34.9266989+00:00",
"date_closed": "2026-05-17T00:31:34.9266989+00:00",
"suggested_user_id": "fcabe894-3a5d-44fa-9f15-30ca76448e84",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1e31cccd-0ecf-405e-a6e3-d37bc6d618a5",
"db_language_id": "28d3524b-1efc-4d51-8c56-4513c8cbf5e2",
"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-05-17T00:31:34.9266989+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3eb8e4f6-0cff-4752-9535-679ea4667812",
"sales_organization": {
"id": "72197f80-c724-4153-9621-15dbf884d2ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a26def5f-cccc-469b-bc33-3fa7ff01396b",
"db_currency_id": "dafa6be9-379c-4724-9c85-9cc9f9c56b60",
"db_language_id": "6536c13b-c1ab-4e7b-930d-b9752172759b",
"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-05-17T00:31:34.9266989+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6e3f6850-744f-4852-a270-720fa92d1067",
"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": "d75bcd63-d469-474d-bd1f-fda78751193c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-17T00:31:34.9266989+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1e15ce05-9173-43cb-866d-5a25112182e8"
},
"suggested_date_start": "2026-05-17T00:31:34.9266989+00:00",
"skill_id": "67cdfd2a-6cca-48a9-a3fa-50b43e0ec8ac",
"skill_code": "sample string 32",
"skill": {
"id": "f73b6ff2-c148-4c57-911a-c3763320d1af",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "68bbb8ec-3fef-4263-9095-31ef49fcc5ee",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "72197f80-c724-4153-9621-15dbf884d2ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a26def5f-cccc-469b-bc33-3fa7ff01396b",
"db_currency_id": "dafa6be9-379c-4724-9c85-9cc9f9c56b60",
"db_language_id": "6536c13b-c1ab-4e7b-930d-b9752172759b",
"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-05-17T00:31:34.9266989+00:00"
},
"modified_dateutc": "2026-05-17T00:31:34.9266989+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2e5b0689-3b19-4202-bc09-d2ce5b003f9e",
"date_reported_by_company": "2026-05-17T00:31:34.9266989+00:00",
"id2": 36,
"company_id": "abb6d8aa-6b73-42b9-8884-5a718f057cc5",
"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": "2e4c65ba-5759-4d7b-b66a-7bc0f8d27baf",
"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-05-17T00:31:34.9266989+00:00"
},
"work_instruction_details_id": "cab70125-5578-49de-91ee-c6a28916f7ad",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "41a0f763-138e-48be-808b-2cf6ab78b2d1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9f6b1873-f4bd-4a87-8ef8-8f6cadb06e84",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-17T00:31:34.9266989+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": "8b0f81da-bb7a-4d54-aaf3-de4f89f9a414",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-17T00:31:34.9266989+00:00"
}