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": "528e113f-6def-42ec-a393-fb7d95a39097",
"jobs_id": "dc8abff7-3453-40be-843a-e79d25755888",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f91d81e6-a0bc-4511-853c-8945a53201e2",
"_parent_id": "9d28e8cc-1515-4e91-8a0e-db045d4db5e2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "90e740eb-4043-4c7c-950f-6714eacd5e09",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9a36e7d4-4170-459b-959b-82432c9ee843",
"_parent_id": "c35d792e-a726-4e3f-825b-198a763b4dac",
"root_parent_id": "0beafcb8-46ca-469e-b9ba-69aa43057668",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b5e000f5-a8f4-43b5-b89b-7701ee849142",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5eb8c940-afc1-42ce-83a9-d646f5f5393e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4e9d5631-348b-4a6d-9485-bf45216fc019",
"_parent_code": "sample string 6",
"sales_organization_id": "e4b0cf0c-c128-4ad7-b1ae-75a4a20e3e10",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "767787db-8f76-415c-9e01-f279c21523b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3fff712-c084-450f-a8b5-a960485eb446",
"db_currency_id": "041a7347-341f-4634-a550-55f46daf8265",
"db_language_id": "99cf8ea6-d82f-4314-8ff2-b7340150e8bf",
"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-26T10:12:21.7070817+00:00"
},
"modified_dateutc": "2026-10-26T10:12:21.7070817+00:00"
},
"equipment_model_id": "849b8404-d382-4329-b089-e6d3a686688e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d1f38efa-bf8a-4f44-b25e-7dce5d4fa60f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f6dfdb35-a107-4151-8712-08b5423d3efb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0be0afb0-8320-4614-b78d-81928c11232b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b4d51697-29b7-4a33-b58c-b3a6c70a228a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "767787db-8f76-415c-9e01-f279c21523b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3fff712-c084-450f-a8b5-a960485eb446",
"db_currency_id": "041a7347-341f-4634-a550-55f46daf8265",
"db_language_id": "99cf8ea6-d82f-4314-8ff2-b7340150e8bf",
"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-26T10:12:21.7070817+00:00"
},
"modified_dateutc": "2026-10-26T10:12:21.7176475+00:00"
},
"equipment_family_id": "d6619183-bd2c-4473-a1ad-659f5e8cff0a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5eb8c940-afc1-42ce-83a9-d646f5f5393e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4e9d5631-348b-4a6d-9485-bf45216fc019",
"_parent_code": "sample string 6",
"sales_organization_id": "e4b0cf0c-c128-4ad7-b1ae-75a4a20e3e10",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "767787db-8f76-415c-9e01-f279c21523b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3fff712-c084-450f-a8b5-a960485eb446",
"db_currency_id": "041a7347-341f-4634-a550-55f46daf8265",
"db_language_id": "99cf8ea6-d82f-4314-8ff2-b7340150e8bf",
"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-26T10:12:21.7070817+00:00"
},
"modified_dateutc": "2026-10-26T10:12:21.7070817+00:00"
},
"date_in_production_since": "2026-10-26T10:12:21.7176475+00:00",
"date_out_of_production_since": "2026-10-26T10:12:21.7176475+00:00",
"date_end_support": "2026-10-26T10:12:21.7176475+00:00",
"sales_organization_id": "9695c662-67c4-448e-8029-40df3bcc41e3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "767787db-8f76-415c-9e01-f279c21523b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3fff712-c084-450f-a8b5-a960485eb446",
"db_currency_id": "041a7347-341f-4634-a550-55f46daf8265",
"db_language_id": "99cf8ea6-d82f-4314-8ff2-b7340150e8bf",
"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-26T10:12:21.7070817+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-26T10:12:21.7176475+00:00"
},
"project_status_id": "736de179-1483-436f-9686-e91c4e3e26ca",
"project_status_code": "sample string 10",
"project_status": {
"id": "48053c09-4f33-44e1-af26-42cd75ccf1f6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "64afffa7-2d66-4076-b0a1-94afe9126e32",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "767787db-8f76-415c-9e01-f279c21523b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3fff712-c084-450f-a8b5-a960485eb446",
"db_currency_id": "041a7347-341f-4634-a550-55f46daf8265",
"db_language_id": "99cf8ea6-d82f-4314-8ff2-b7340150e8bf",
"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-26T10:12:21.7070817+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-26T10:12:21.7176475+00:00"
},
"company_id": "3cac9221-6938-4f67-92f0-672ece829b98",
"company_code": "sample string 12",
"db_address_id": "942f7d19-94c1-4dbf-ac87-3968465c97ac",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "64bcdc1d-f8ac-4899-8cf1-ea6aec3f4f18",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e4e13b59-cb97-4022-a9f5-95b02943ee2c",
"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-26T10:12:21.7176475+00:00",
"date_create": "2026-10-26T10:12:21.7176475+00:00",
"date_update": "2026-10-26T10:12:21.7176475+00:00",
"updated_by_user_id": "6b535de1-e129-4c21-9e5b-a5bbe969961d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-26T10:12:21.7176475+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-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-26T10:12:21.7176475+00:00",
"date_last_job": "2026-10-26T10:12:21.7176475+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-26T10:12:21.7176475+00:00",
"modified_dateutc": "2026-10-26T10:12:21.7176475+00:00",
"is_mobile_installation": true
},
"job_type_id": "b02e767b-b3c0-4e7a-a667-c44498ec7b8a",
"job_type_code": "sample string 7",
"job_type": {
"id": "2e25beff-8474-4c3f-9187-a26a19211efd",
"name": "sample string 2",
"sales_organization_id": "cd922e83-77cc-4b7b-ae7f-5bad93aa8c6b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-26T10:12:21.7176475+00:00",
"code": "sample string 7"
},
"job_priority_id": "db0cbc3a-061b-4c2c-893e-0607d00e9d7f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f70e8092-439d-425a-b543-54b86b54a9b2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "56d7d7e6-9b47-450b-b3f9-4cae99b23d25",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "767787db-8f76-415c-9e01-f279c21523b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3fff712-c084-450f-a8b5-a960485eb446",
"db_currency_id": "041a7347-341f-4634-a550-55f46daf8265",
"db_language_id": "99cf8ea6-d82f-4314-8ff2-b7340150e8bf",
"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-26T10:12:21.7070817+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-26T10:12:21.7367173+00:00"
},
"job_status_id": "2f63bad4-3517-4413-815f-3d99045b41c6",
"job_status_code": "sample string 11",
"db_address_id": "07933d72-e09e-491c-81e6-b4c2cc8db53e",
"contact_id": "75ee8927-5697-4bdc-8030-418e4b39b7b2",
"requested_by_company_id": "2e419465-12db-48d3-8efb-ffb8de1a15a6",
"requested_by_contact_id": "5a1a6ee1-8110-41e9-a243-4c4c0692e385",
"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-26T10:12:21.7367173+00:00",
"due_date": "2026-10-26T10:12:21.7367173+00:00",
"date_create": "2026-10-26T10:12:21.7367173+00:00",
"date_update": "2026-10-26T10:12:21.7367173+00:00",
"date_closed": "2026-10-26T10:12:21.7367173+00:00",
"suggested_user_id": "8d4cec73-7954-493c-8737-b68f2c9f9980",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "10890a0c-e51e-4fd1-801e-de7a0bb9b0b1",
"db_language_id": "32678a79-b6e2-4c23-a921-8985f1e631a3",
"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-26T10:12:21.7367173+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fd439aa0-00da-40be-ae26-d0ad5e61988a",
"sales_organization": {
"id": "767787db-8f76-415c-9e01-f279c21523b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3fff712-c084-450f-a8b5-a960485eb446",
"db_currency_id": "041a7347-341f-4634-a550-55f46daf8265",
"db_language_id": "99cf8ea6-d82f-4314-8ff2-b7340150e8bf",
"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-26T10:12:21.7070817+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e0f8b6d9-16b7-4a53-b8b3-6ea29efbfc45",
"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": "b9f5e91b-e138-4e60-a844-de3927a1f7b3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-26T10:12:21.7367173+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "cc9b00aa-d990-43eb-9d5d-9307e8179427"
},
"suggested_date_start": "2026-10-26T10:12:21.7367173+00:00",
"skill_id": "673c4757-e23a-4454-a0e1-04ec12938960",
"skill_code": "sample string 32",
"skill": {
"id": "3bbed3f3-4454-45e5-9728-da8ff3206915",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a915250e-5907-418a-86e1-fa649caeff07",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "767787db-8f76-415c-9e01-f279c21523b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3fff712-c084-450f-a8b5-a960485eb446",
"db_currency_id": "041a7347-341f-4634-a550-55f46daf8265",
"db_language_id": "99cf8ea6-d82f-4314-8ff2-b7340150e8bf",
"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-26T10:12:21.7070817+00:00"
},
"modified_dateutc": "2026-10-26T10:12:21.7367173+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e50ab1f2-8c04-4130-8e1a-106ed8400b4d",
"date_reported_by_company": "2026-10-26T10:12:21.7367173+00:00",
"id2": 36,
"company_id": "bdd6dd48-3388-41eb-a699-cf4b025cde6c",
"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": "c3b0021f-4781-413d-8b57-7974a28a708d",
"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-26T10:12:21.7367173+00:00"
},
"work_instruction_details_id": "aa03afd1-999b-4c6b-a7a5-4d53d8310691",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4a7f7edc-d5f0-40d6-b0a9-6f6ed332f522",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3ab0137e-5b93-40d4-b005-43b9ef144f0f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-26T10:12:21.7367173+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": "f4b62a4e-be75-4818-bacd-4986e96caaee",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-26T10:12:21.7367173+00:00"
}