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": "34a002f6-8702-47ed-a3dd-98c2e55eb42b",
"jobs_id": "d8bee76b-2501-4d6c-b2e7-a44e50795bff",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "315f3754-b3f5-49b0-ba9d-7f8d674d2a72",
"_parent_id": "87749244-a667-494d-b8e1-7399fb86d965",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bfa15df4-c316-4a9e-812b-90e192cc85f6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "edfcae94-b956-41c6-b68f-490b89f885a2",
"_parent_id": "8643c8d0-88b3-422a-9372-58cfcbf43fc6",
"root_parent_id": "68a6401c-0cba-48d5-985d-56983eca378c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "802414a3-09e9-4e65-951c-210bdff3a426",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b21a50ad-e241-4b15-aaa8-a29f0a244f5e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c83abf2f-3a45-4eb9-a520-d4244da474fa",
"_parent_code": "sample string 6",
"sales_organization_id": "5a292557-3596-4cd5-96d8-3783e7d6e6f5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "449752f0-9958-4f7a-b33e-63c98b0c203b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7838f5bc-5ff3-4a61-a178-c2aba1ba24da",
"db_currency_id": "b16a2c9a-ed36-4154-ac7a-97e7cec02e39",
"db_language_id": "9d997d79-5bfd-4044-9025-240efb90ce2f",
"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-01-18T11:29:01.8626838+00:00"
},
"modified_dateutc": "2026-01-18T11:29:01.8626838+00:00"
},
"equipment_model_id": "14053aee-37c9-4f52-aff1-e7862e0aa4ef",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "64da176f-c1f7-4b82-bcea-d7049640516a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a66bac4c-9250-4c7f-a1a0-eb0204c60364",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ef4cce68-5bfb-4f48-b78a-a373a4b6e6f5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "475ce09b-55e0-469d-8e7d-dd9dae911e53",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "449752f0-9958-4f7a-b33e-63c98b0c203b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7838f5bc-5ff3-4a61-a178-c2aba1ba24da",
"db_currency_id": "b16a2c9a-ed36-4154-ac7a-97e7cec02e39",
"db_language_id": "9d997d79-5bfd-4044-9025-240efb90ce2f",
"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-01-18T11:29:01.8626838+00:00"
},
"modified_dateutc": "2026-01-18T11:29:01.878309+00:00"
},
"equipment_family_id": "3a32084e-84ef-4977-bffc-287e9fab1c5b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b21a50ad-e241-4b15-aaa8-a29f0a244f5e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c83abf2f-3a45-4eb9-a520-d4244da474fa",
"_parent_code": "sample string 6",
"sales_organization_id": "5a292557-3596-4cd5-96d8-3783e7d6e6f5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "449752f0-9958-4f7a-b33e-63c98b0c203b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7838f5bc-5ff3-4a61-a178-c2aba1ba24da",
"db_currency_id": "b16a2c9a-ed36-4154-ac7a-97e7cec02e39",
"db_language_id": "9d997d79-5bfd-4044-9025-240efb90ce2f",
"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-01-18T11:29:01.8626838+00:00"
},
"modified_dateutc": "2026-01-18T11:29:01.8626838+00:00"
},
"date_in_production_since": "2026-01-18T11:29:01.878309+00:00",
"date_out_of_production_since": "2026-01-18T11:29:01.878309+00:00",
"date_end_support": "2026-01-18T11:29:01.878309+00:00",
"sales_organization_id": "9ca0b502-edc7-40d1-ae22-353e29c223f6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "449752f0-9958-4f7a-b33e-63c98b0c203b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7838f5bc-5ff3-4a61-a178-c2aba1ba24da",
"db_currency_id": "b16a2c9a-ed36-4154-ac7a-97e7cec02e39",
"db_language_id": "9d997d79-5bfd-4044-9025-240efb90ce2f",
"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-01-18T11:29:01.8626838+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-01-18T11:29:01.878309+00:00"
},
"project_status_id": "51d452f1-8cf3-4dc9-8e94-b96d77cc58f3",
"project_status_code": "sample string 10",
"project_status": {
"id": "a07f686d-1b82-4f5a-ba88-6ae0822823ff",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "22fd67d4-6937-4ee0-ae55-50038bd165f7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "449752f0-9958-4f7a-b33e-63c98b0c203b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7838f5bc-5ff3-4a61-a178-c2aba1ba24da",
"db_currency_id": "b16a2c9a-ed36-4154-ac7a-97e7cec02e39",
"db_language_id": "9d997d79-5bfd-4044-9025-240efb90ce2f",
"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-01-18T11:29:01.8626838+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-18T11:29:01.878309+00:00"
},
"company_id": "26dea29c-e365-4acf-ab03-6f9df3b8e2d7",
"company_code": "sample string 12",
"db_address_id": "70935e69-5b0c-4e45-b857-385e7c91a452",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "dcf4fe05-cecb-4930-826b-64801a48da24",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ffb22a51-ff31-4ebf-bb91-21992a516c2c",
"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-01-18T11:29:01.878309+00:00",
"date_create": "2026-01-18T11:29:01.878309+00:00",
"date_update": "2026-01-18T11:29:01.878309+00:00",
"updated_by_user_id": "57b7d7df-f16b-488f-a9b5-a643dd4af9df",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-18T11:29:01.878309+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-01-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-18T11:29:01.893946+00:00",
"date_last_job": "2026-01-18T11:29:01.893946+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-18T11:29:01.893946+00:00",
"modified_dateutc": "2026-01-18T11:29:01.893946+00:00",
"is_mobile_installation": true
},
"job_type_id": "8c3330a3-7ce2-43f2-ba23-c64e99e7bbe5",
"job_type_code": "sample string 7",
"job_type": {
"id": "f823aef8-b02b-45b9-a4f7-1704185f030a",
"name": "sample string 2",
"sales_organization_id": "64056f39-182f-4449-87f5-d0808f438163",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-18T11:29:01.893946+00:00",
"code": "sample string 7"
},
"job_priority_id": "2237a2a8-2260-47fc-bf95-6490099f0925",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0b06f0cf-7194-440b-af2c-18054e4cd32a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e3f2a5b5-3291-4bf5-9aaf-aea54fece78b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "449752f0-9958-4f7a-b33e-63c98b0c203b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7838f5bc-5ff3-4a61-a178-c2aba1ba24da",
"db_currency_id": "b16a2c9a-ed36-4154-ac7a-97e7cec02e39",
"db_language_id": "9d997d79-5bfd-4044-9025-240efb90ce2f",
"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-01-18T11:29:01.8626838+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-18T11:29:01.893946+00:00"
},
"job_status_id": "44e3a22a-7473-4daa-8e5a-f94b39e6375b",
"job_status_code": "sample string 11",
"db_address_id": "426515cf-357b-4d76-bfe5-9a2db8831577",
"contact_id": "8df96f5f-2309-4b4c-873e-e2ed26ea0ace",
"requested_by_company_id": "b8d15c5d-736a-47d9-b5d7-2df1332746b2",
"requested_by_contact_id": "37ef2c79-b79c-4ce8-a9f6-cf73a5dc5afb",
"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-01-18T11:29:01.893946+00:00",
"due_date": "2026-01-18T11:29:01.893946+00:00",
"date_create": "2026-01-18T11:29:01.893946+00:00",
"date_update": "2026-01-18T11:29:01.893946+00:00",
"date_closed": "2026-01-18T11:29:01.893946+00:00",
"suggested_user_id": "28719936-2bc0-4cde-86ef-f853d712fcc7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "89b79391-cb0f-4f92-84f2-c9fa53f0e782",
"db_language_id": "790b7e9e-de23-43ff-9cc1-75b14fd06f14",
"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-01-18T11:29:01.893946+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b4394978-ba60-4565-9b09-07a0e9d2660b",
"sales_organization": {
"id": "449752f0-9958-4f7a-b33e-63c98b0c203b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7838f5bc-5ff3-4a61-a178-c2aba1ba24da",
"db_currency_id": "b16a2c9a-ed36-4154-ac7a-97e7cec02e39",
"db_language_id": "9d997d79-5bfd-4044-9025-240efb90ce2f",
"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-01-18T11:29:01.8626838+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "15a33a5e-fa51-4bc6-be8d-da62666f8bd1",
"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": "dd55ea08-8777-409f-a858-cea73e959262",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-18T11:29:01.893946+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0d9046d2-ed92-404f-bf0e-11702923990a"
},
"suggested_date_start": "2026-01-18T11:29:01.893946+00:00",
"skill_id": "9a4f218f-c989-42b2-b8ea-e0d6611e4621",
"skill_code": "sample string 32",
"skill": {
"id": "569b177f-3dc8-4c2a-83dc-3357982a83f0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "918d639a-3f6b-4236-8482-2d4bbd7e3c4a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "449752f0-9958-4f7a-b33e-63c98b0c203b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7838f5bc-5ff3-4a61-a178-c2aba1ba24da",
"db_currency_id": "b16a2c9a-ed36-4154-ac7a-97e7cec02e39",
"db_language_id": "9d997d79-5bfd-4044-9025-240efb90ce2f",
"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-01-18T11:29:01.8626838+00:00"
},
"modified_dateutc": "2026-01-18T11:29:01.893946+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6520787b-4f0e-4b83-a418-f797ed6167ca",
"date_reported_by_company": "2026-01-18T11:29:01.893946+00:00",
"id2": 36,
"company_id": "0edd0d0b-0b71-4322-b9ba-1896f2642d23",
"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": "4893bbd3-7e88-4beb-a170-bb67b0524146",
"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-01-18T11:29:01.893946+00:00"
},
"work_instruction_details_id": "5299d7db-da0c-40cf-8bcb-a1218121174d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "686df74d-3afc-4ee2-a87f-074fdd50aca1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4386527e-56b3-4a84-ae43-0b78881bed62",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-18T11:29:01.893946+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": "e79f8534-de39-434d-a17e-e25c91f170e7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-18T11:29:01.893946+00:00"
}