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": "3078cf52-e23f-4128-968c-fa32d959c7b1",
"jobs_id": "c0c02c0b-7d14-4f96-aeb6-0c066166e1ab",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "50679f75-e194-4308-b361-46a446f86cab",
"_parent_id": "239258cc-b609-4ca6-83eb-b1576653a66f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "dc316adc-d996-4863-992a-d275796764c2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d3fa049c-cd03-40a0-adda-ceeb88b9e1f8",
"_parent_id": "4551a5d0-810e-4cbd-8589-98e7a9876f41",
"root_parent_id": "269f19c7-54ea-44b6-b0a7-fc05f92c4db7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "99d8f19c-f06d-49d4-8edc-e6f5a9550b49",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e928a58c-59f6-426a-9654-89596e720cf5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b386a820-e6fc-4367-890b-22e95ee82ea9",
"_parent_code": "sample string 6",
"sales_organization_id": "dff20e34-f636-4ec2-8175-422118b82be5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b5b2db38-d669-4143-9dae-7b1b6a7cede5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85935e42-2e72-4d5e-8bf7-0fe7a4fd6805",
"db_currency_id": "e7284039-c4b2-4b69-ad46-1a85d9b7676b",
"db_language_id": "581a4325-1d65-4c56-80c3-acf189791828",
"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-04T06:19:14.0234953+00:00"
},
"modified_dateutc": "2026-04-04T06:19:14.0234953+00:00"
},
"equipment_model_id": "8f91d6bb-39cd-4f5b-a031-ada730f3abc2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "adc97046-7f21-4d2c-a6fe-c0b75e1abc44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4f6c29aa-c834-4e9e-b9c8-4acf1fc3d232",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b7552ad9-446c-4f63-9e37-9880307aaedb",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "69e33c5d-730c-4716-8250-028d99e3cf64",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b5b2db38-d669-4143-9dae-7b1b6a7cede5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85935e42-2e72-4d5e-8bf7-0fe7a4fd6805",
"db_currency_id": "e7284039-c4b2-4b69-ad46-1a85d9b7676b",
"db_language_id": "581a4325-1d65-4c56-80c3-acf189791828",
"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-04T06:19:14.0234953+00:00"
},
"modified_dateutc": "2026-04-04T06:19:14.0234953+00:00"
},
"equipment_family_id": "b42624cc-0179-4cf5-8aa8-d136e30ba481",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e928a58c-59f6-426a-9654-89596e720cf5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b386a820-e6fc-4367-890b-22e95ee82ea9",
"_parent_code": "sample string 6",
"sales_organization_id": "dff20e34-f636-4ec2-8175-422118b82be5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b5b2db38-d669-4143-9dae-7b1b6a7cede5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85935e42-2e72-4d5e-8bf7-0fe7a4fd6805",
"db_currency_id": "e7284039-c4b2-4b69-ad46-1a85d9b7676b",
"db_language_id": "581a4325-1d65-4c56-80c3-acf189791828",
"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-04T06:19:14.0234953+00:00"
},
"modified_dateutc": "2026-04-04T06:19:14.0234953+00:00"
},
"date_in_production_since": "2026-04-04T06:19:14.0234953+00:00",
"date_out_of_production_since": "2026-04-04T06:19:14.0234953+00:00",
"date_end_support": "2026-04-04T06:19:14.0234953+00:00",
"sales_organization_id": "9c1c8596-e767-449a-9aa1-7d7e401fb4d8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b5b2db38-d669-4143-9dae-7b1b6a7cede5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85935e42-2e72-4d5e-8bf7-0fe7a4fd6805",
"db_currency_id": "e7284039-c4b2-4b69-ad46-1a85d9b7676b",
"db_language_id": "581a4325-1d65-4c56-80c3-acf189791828",
"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-04T06:19:14.0234953+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-04T06:19:14.0234953+00:00"
},
"project_status_id": "99eefed0-6fb6-4301-a274-07c419141f59",
"project_status_code": "sample string 10",
"project_status": {
"id": "83031b89-7ecd-4cc9-91bd-9cb6d64f9800",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3edd6437-1598-42ac-83c3-c62d8bd1e531",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b5b2db38-d669-4143-9dae-7b1b6a7cede5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85935e42-2e72-4d5e-8bf7-0fe7a4fd6805",
"db_currency_id": "e7284039-c4b2-4b69-ad46-1a85d9b7676b",
"db_language_id": "581a4325-1d65-4c56-80c3-acf189791828",
"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-04T06:19:14.0234953+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-04T06:19:14.0234953+00:00"
},
"company_id": "74f5c73a-2281-461f-8b8d-d4482d657e7d",
"company_code": "sample string 12",
"db_address_id": "96c8daf7-a6b3-4a3b-b508-38ddf4e6b465",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "61ffd525-4fae-458f-b710-6a08dc1d9866",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "15854172-836f-4dc5-849c-41d9d0e6e0af",
"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-04T06:19:14.0234953+00:00",
"date_create": "2026-04-04T06:19:14.0234953+00:00",
"date_update": "2026-04-04T06:19:14.0234953+00:00",
"updated_by_user_id": "aabcedfa-b56c-4f8a-8575-f0480160f359",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-04T06:19:14.0234953+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-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-04T06:19:14.0234953+00:00",
"date_last_job": "2026-04-04T06:19:14.0234953+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-04T06:19:14.0234953+00:00",
"modified_dateutc": "2026-04-04T06:19:14.0234953+00:00",
"is_mobile_installation": true
},
"job_type_id": "fdc2b9ca-4763-4d8f-b119-38d647ded60f",
"job_type_code": "sample string 7",
"job_type": {
"id": "b1753c57-9516-4577-9320-74f497fba9d6",
"name": "sample string 2",
"sales_organization_id": "1e5447d8-c0c9-406a-92ee-e201c67d96e2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-04T06:19:14.0234953+00:00",
"code": "sample string 7"
},
"job_priority_id": "e47a9182-ad24-42a3-9a3b-b9552e60de87",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7a723c37-1225-4191-b02a-d889ac660d98",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "46b0351e-f583-4d64-9ab4-8784de8d13d8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b5b2db38-d669-4143-9dae-7b1b6a7cede5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85935e42-2e72-4d5e-8bf7-0fe7a4fd6805",
"db_currency_id": "e7284039-c4b2-4b69-ad46-1a85d9b7676b",
"db_language_id": "581a4325-1d65-4c56-80c3-acf189791828",
"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-04T06:19:14.0234953+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-04T06:19:14.0234953+00:00"
},
"job_status_id": "89aa7604-7a48-4500-88bf-dec99e126b8e",
"job_status_code": "sample string 11",
"db_address_id": "ab200f84-ca8b-4fae-af07-b0bf0c52363a",
"contact_id": "8547d870-1e44-49d3-b180-6572f168ff45",
"requested_by_company_id": "a4271417-fef8-44dd-80c2-bc2cbeb0ff83",
"requested_by_contact_id": "5dbf6d51-d466-4873-8a1b-f5bbce04e36e",
"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-04T06:19:14.0234953+00:00",
"due_date": "2026-04-04T06:19:14.0234953+00:00",
"date_create": "2026-04-04T06:19:14.0234953+00:00",
"date_update": "2026-04-04T06:19:14.0234953+00:00",
"date_closed": "2026-04-04T06:19:14.0234953+00:00",
"suggested_user_id": "56d93c74-1d5e-4d7b-a87f-895e4733d5bc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "84443e06-394e-48cc-9ac8-6de1efbad525",
"db_language_id": "20f3861e-8923-4eea-b182-56404296d2c1",
"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-04T06:19:14.0234953+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1777c128-7620-4c60-b459-ba46ae65da05",
"sales_organization": {
"id": "b5b2db38-d669-4143-9dae-7b1b6a7cede5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85935e42-2e72-4d5e-8bf7-0fe7a4fd6805",
"db_currency_id": "e7284039-c4b2-4b69-ad46-1a85d9b7676b",
"db_language_id": "581a4325-1d65-4c56-80c3-acf189791828",
"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-04T06:19:14.0234953+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "531a57d3-860c-4bac-8740-219be29c6ce8",
"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": "6c1c005b-a314-4034-b0ce-2ee89948e0ec",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-04T06:19:14.0234953+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c8ab4d6d-417f-4aa3-aa25-31494a18f4d3"
},
"suggested_date_start": "2026-04-04T06:19:14.0234953+00:00",
"skill_id": "f9a2a6ba-d346-49dd-b538-e10f8a77a0fc",
"skill_code": "sample string 32",
"skill": {
"id": "a09b9bdb-3f34-40b5-ad81-29d64a6743af",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "94cd3e3b-b7e3-4461-81de-671e19b5c0b6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b5b2db38-d669-4143-9dae-7b1b6a7cede5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85935e42-2e72-4d5e-8bf7-0fe7a4fd6805",
"db_currency_id": "e7284039-c4b2-4b69-ad46-1a85d9b7676b",
"db_language_id": "581a4325-1d65-4c56-80c3-acf189791828",
"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-04T06:19:14.0234953+00:00"
},
"modified_dateutc": "2026-04-04T06:19:14.0234953+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "14d30fa0-2e3f-4b6b-ba5d-3bf2a8bf6fe6",
"date_reported_by_company": "2026-04-04T06:19:14.0234953+00:00",
"id2": 36,
"company_id": "7973a2bd-a918-4b4c-a150-5f3f18d9ea26",
"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": "4bc29ed9-1909-465f-bd80-34a5ec36d9a4",
"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-04T06:19:14.0234953+00:00"
},
"work_instruction_details_id": "0a63269a-eea5-463c-8f50-8bb3afa39450",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "abd9254a-0d29-49bb-a9dd-d0b5d4493de9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ff32fc10-1593-4a24-8a56-8e0818e3d751",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-04T06:19:14.0234953+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": "7ac352fa-157e-4730-ae59-8b71d56c106b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-04T06:19:14.0234953+00:00"
}