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": "eda2b83b-664a-4ffc-95ce-13f0e228611b",
"jobs_id": "f33be01b-a7ae-4647-97f4-3d3ed7a7f97d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7de81f51-7bb7-4a4c-bef3-623ff8be4040",
"_parent_id": "d4c39620-577d-4440-b342-9558c8f81acc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "08c07837-df4d-45d9-aa1f-5b23d63f8b2a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7df14cf7-7960-43b6-a813-f05358c234f4",
"_parent_id": "72136f18-3c48-4bd0-ab35-78d4abad9a52",
"root_parent_id": "8a1118f4-1973-4cbf-96fc-0d97a144c60d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4aa72bb2-15b1-4cbd-a9f8-93f1bf5b65ef",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a7e738c9-a850-426d-83c5-79a3218bfa22",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ddd42094-712f-44fb-8629-3588c046ed17",
"_parent_code": "sample string 6",
"sales_organization_id": "1c5bae3d-8747-484e-925a-aa70bb0e8aa4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a9b9ceca-2c7a-4c86-957f-d79a35938dc5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "44a3e54a-76a9-4c0c-9444-2295f1b45fa4",
"db_currency_id": "7b336731-5dd4-47b1-9c16-486044596016",
"db_language_id": "1fdbc015-4f7e-4f14-8182-d3a041e0bc19",
"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-29T20:48:25.5987445+00:00"
},
"modified_dateutc": "2026-04-29T20:48:25.5987445+00:00"
},
"equipment_model_id": "2a05c34d-8322-4f3b-96e7-3720002c2272",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0a3c3ade-2ab7-468b-9a52-9d9d5a6895a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ea9b668b-9ca0-4b1c-a065-e46d11386955",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f1582064-1427-4455-b7a2-bbb6082cc6d2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "33991f03-6a49-46f5-95fc-beaeb15e624d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a9b9ceca-2c7a-4c86-957f-d79a35938dc5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "44a3e54a-76a9-4c0c-9444-2295f1b45fa4",
"db_currency_id": "7b336731-5dd4-47b1-9c16-486044596016",
"db_language_id": "1fdbc015-4f7e-4f14-8182-d3a041e0bc19",
"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-29T20:48:25.5987445+00:00"
},
"modified_dateutc": "2026-04-29T20:48:25.5987445+00:00"
},
"equipment_family_id": "1b658452-c7e8-40e6-bbc5-7f357cd0d08a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a7e738c9-a850-426d-83c5-79a3218bfa22",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ddd42094-712f-44fb-8629-3588c046ed17",
"_parent_code": "sample string 6",
"sales_organization_id": "1c5bae3d-8747-484e-925a-aa70bb0e8aa4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a9b9ceca-2c7a-4c86-957f-d79a35938dc5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "44a3e54a-76a9-4c0c-9444-2295f1b45fa4",
"db_currency_id": "7b336731-5dd4-47b1-9c16-486044596016",
"db_language_id": "1fdbc015-4f7e-4f14-8182-d3a041e0bc19",
"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-29T20:48:25.5987445+00:00"
},
"modified_dateutc": "2026-04-29T20:48:25.5987445+00:00"
},
"date_in_production_since": "2026-04-29T20:48:25.5987445+00:00",
"date_out_of_production_since": "2026-04-29T20:48:25.5987445+00:00",
"date_end_support": "2026-04-29T20:48:25.5987445+00:00",
"sales_organization_id": "268a0501-35c0-48a5-931a-f5b617e0d228",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a9b9ceca-2c7a-4c86-957f-d79a35938dc5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "44a3e54a-76a9-4c0c-9444-2295f1b45fa4",
"db_currency_id": "7b336731-5dd4-47b1-9c16-486044596016",
"db_language_id": "1fdbc015-4f7e-4f14-8182-d3a041e0bc19",
"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-29T20:48:25.5987445+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-29T20:48:25.5987445+00:00"
},
"project_status_id": "79ca8dcb-3472-40cb-ab51-4b15b6ee9175",
"project_status_code": "sample string 10",
"project_status": {
"id": "45f8eada-171b-44c3-b612-24fa25f21ce5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0f994a90-e524-49eb-aebb-8414b1048221",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a9b9ceca-2c7a-4c86-957f-d79a35938dc5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "44a3e54a-76a9-4c0c-9444-2295f1b45fa4",
"db_currency_id": "7b336731-5dd4-47b1-9c16-486044596016",
"db_language_id": "1fdbc015-4f7e-4f14-8182-d3a041e0bc19",
"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-29T20:48:25.5987445+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-29T20:48:25.5987445+00:00"
},
"company_id": "c8e7f69b-d74d-450d-b2fe-2e9e0129c136",
"company_code": "sample string 12",
"db_address_id": "c9ec8b22-12c2-4e87-9562-4ec199fed492",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fb99b889-f67b-471b-ae31-1d5b3ccf87ae",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2376edb2-d53a-4d8f-9a46-bb8afb452e6d",
"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-29T20:48:25.5987445+00:00",
"date_create": "2026-04-29T20:48:25.5987445+00:00",
"date_update": "2026-04-29T20:48:25.5987445+00:00",
"updated_by_user_id": "f0d84d67-a8ca-4e0a-ba5d-db9c635c03da",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-29T20:48:25.5987445+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-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-29T20:48:25.5987445+00:00",
"date_last_job": "2026-04-29T20:48:25.5987445+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-29T20:48:25.5987445+00:00",
"modified_dateutc": "2026-04-29T20:48:25.5987445+00:00",
"is_mobile_installation": true
},
"job_type_id": "a4123504-19f8-4fa3-a7fc-1db7a5b4423f",
"job_type_code": "sample string 7",
"job_type": {
"id": "a8b36462-8f39-4022-bc67-460459ac7f4d",
"name": "sample string 2",
"sales_organization_id": "b99fac1f-490d-47b6-92fd-9783ed33f3ba",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-29T20:48:25.5987445+00:00",
"code": "sample string 7"
},
"job_priority_id": "4e5c883a-2123-46e5-91b1-d1e15adc2b24",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f71e2aa3-b37b-445c-8e79-2c9ad02a0595",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d28b30ab-6a38-4418-9893-c2636a2b1651",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a9b9ceca-2c7a-4c86-957f-d79a35938dc5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "44a3e54a-76a9-4c0c-9444-2295f1b45fa4",
"db_currency_id": "7b336731-5dd4-47b1-9c16-486044596016",
"db_language_id": "1fdbc015-4f7e-4f14-8182-d3a041e0bc19",
"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-29T20:48:25.5987445+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-29T20:48:25.5987445+00:00"
},
"job_status_id": "88a5426d-14e9-40b5-a7a1-15b71fa805f9",
"job_status_code": "sample string 11",
"db_address_id": "99971d85-b18c-4851-a816-cdca855d8c49",
"contact_id": "80a21a30-47ae-4326-92e4-1debd7106b0b",
"requested_by_company_id": "3692c939-31ae-4860-bb8f-0707fb2e656b",
"requested_by_contact_id": "851b8388-7646-441c-9f24-8963675f1499",
"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-29T20:48:25.5987445+00:00",
"due_date": "2026-04-29T20:48:25.5987445+00:00",
"date_create": "2026-04-29T20:48:25.5987445+00:00",
"date_update": "2026-04-29T20:48:25.5987445+00:00",
"date_closed": "2026-04-29T20:48:25.5987445+00:00",
"suggested_user_id": "c9ebb792-31b8-4ca1-9bbb-82f0fc0535e8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "93db59b2-50d0-4828-a71e-cead9c95eba6",
"db_language_id": "3c502735-d6c0-4fca-b2d9-850605768c1b",
"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-29T20:48:25.5987445+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6842e16b-7657-4b58-aba2-71163fdf3106",
"sales_organization": {
"id": "a9b9ceca-2c7a-4c86-957f-d79a35938dc5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "44a3e54a-76a9-4c0c-9444-2295f1b45fa4",
"db_currency_id": "7b336731-5dd4-47b1-9c16-486044596016",
"db_language_id": "1fdbc015-4f7e-4f14-8182-d3a041e0bc19",
"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-29T20:48:25.5987445+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c7df802d-8335-49b2-bbb7-d8e3e552ac00",
"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": "455d9c14-9c7f-41ca-a994-dd5c0cd6ab39",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-29T20:48:25.5987445+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "32839391-be90-4482-8d16-b65c7dde5fd7"
},
"suggested_date_start": "2026-04-29T20:48:25.5987445+00:00",
"skill_id": "ac61ccf3-a15d-4da7-ac86-075e0c393f91",
"skill_code": "sample string 32",
"skill": {
"id": "f2a6cf9b-6918-4456-a141-c7af0d04b8e3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "695e71a9-7c47-4846-b867-19215eef981b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a9b9ceca-2c7a-4c86-957f-d79a35938dc5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "44a3e54a-76a9-4c0c-9444-2295f1b45fa4",
"db_currency_id": "7b336731-5dd4-47b1-9c16-486044596016",
"db_language_id": "1fdbc015-4f7e-4f14-8182-d3a041e0bc19",
"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-29T20:48:25.5987445+00:00"
},
"modified_dateutc": "2026-04-29T20:48:25.5987445+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "03639986-6283-4dee-9f1f-a7cf76fa015f",
"date_reported_by_company": "2026-04-29T20:48:25.5987445+00:00",
"id2": 36,
"company_id": "7d193d9d-5b5b-4ae4-af34-1ec797279940",
"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": "e980864c-7476-4560-b9e8-3e4722c0ee49",
"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-29T20:48:25.5987445+00:00"
},
"work_instruction_details_id": "ccf35705-78c6-441f-a712-06c6eda1a6e5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0cc72309-dc40-4612-8cdb-0450523e5e04",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b5f625cf-0305-47c3-954c-a4b794ec1a5a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-29T20:48:25.5987445+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": "f9b2297e-3288-4af2-9f29-b07ab8a65cc7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-29T20:48:25.5987445+00:00"
}