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": "81949197-fca8-4c5e-8cf7-05e859cd5573",
"jobs_id": "cb365fe5-649b-45f5-9414-9a7296c70fef",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4e44a8a4-0b2a-453b-8936-8fe540e497df",
"_parent_id": "2ced4853-faaa-4786-b11f-1e08e46b7942",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "db08d39d-a8ee-4e9a-bdaa-2b70f7837bf8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6c6a2a06-ed57-4247-96d8-8fc71a5d69a9",
"_parent_id": "196fbec6-e49e-4811-bd16-a2fcd28d865a",
"root_parent_id": "b556b043-bd66-4d07-9c24-7dadec4c939a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bf6c5591-7092-49bd-8a2f-a6305aa1ed89",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1509cd95-599b-413e-a1e2-c3e7665fb830",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ad5eaf1f-cb09-4d1b-875c-345b0ba379c8",
"_parent_code": "sample string 6",
"sales_organization_id": "63d8f31b-a1f3-4343-8153-4ea5d71bd565",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d6dcf3c1-c958-4dfa-912e-b91e2b80c1d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fb11121a-3ccd-43c1-898c-2a9c3a3adf6c",
"db_currency_id": "0b05f1ed-4f9c-40a2-a8d1-16cf635b526e",
"db_language_id": "ebc9c423-ea2d-4536-9dd0-6662281b2ba3",
"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-28T13:14:27.7020068+00:00"
},
"modified_dateutc": "2026-01-28T13:14:27.7020068+00:00"
},
"equipment_model_id": "3ce990ef-8f95-4887-a771-14d1b38d282e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0b4fb884-c164-45a3-8287-5633177b9121",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "273e3e77-6775-4a21-b9bc-74d8dbdeac10",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8c2da569-cd62-48e8-9fe2-134388da8ec0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b4f8ac4a-582e-4e70-9767-949ae64e8009",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d6dcf3c1-c958-4dfa-912e-b91e2b80c1d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fb11121a-3ccd-43c1-898c-2a9c3a3adf6c",
"db_currency_id": "0b05f1ed-4f9c-40a2-a8d1-16cf635b526e",
"db_language_id": "ebc9c423-ea2d-4536-9dd0-6662281b2ba3",
"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-28T13:14:27.7020068+00:00"
},
"modified_dateutc": "2026-01-28T13:14:27.7020068+00:00"
},
"equipment_family_id": "3c807506-7500-47d1-a390-67cf918e39c2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1509cd95-599b-413e-a1e2-c3e7665fb830",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ad5eaf1f-cb09-4d1b-875c-345b0ba379c8",
"_parent_code": "sample string 6",
"sales_organization_id": "63d8f31b-a1f3-4343-8153-4ea5d71bd565",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d6dcf3c1-c958-4dfa-912e-b91e2b80c1d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fb11121a-3ccd-43c1-898c-2a9c3a3adf6c",
"db_currency_id": "0b05f1ed-4f9c-40a2-a8d1-16cf635b526e",
"db_language_id": "ebc9c423-ea2d-4536-9dd0-6662281b2ba3",
"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-28T13:14:27.7020068+00:00"
},
"modified_dateutc": "2026-01-28T13:14:27.7020068+00:00"
},
"date_in_production_since": "2026-01-28T13:14:27.7020068+00:00",
"date_out_of_production_since": "2026-01-28T13:14:27.7020068+00:00",
"date_end_support": "2026-01-28T13:14:27.7020068+00:00",
"sales_organization_id": "c5f9dfd4-8e7f-4856-84a3-263a9bb85a83",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d6dcf3c1-c958-4dfa-912e-b91e2b80c1d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fb11121a-3ccd-43c1-898c-2a9c3a3adf6c",
"db_currency_id": "0b05f1ed-4f9c-40a2-a8d1-16cf635b526e",
"db_language_id": "ebc9c423-ea2d-4536-9dd0-6662281b2ba3",
"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-28T13:14:27.7020068+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-28T13:14:27.7020068+00:00"
},
"project_status_id": "ff7ae78a-0195-401b-95c9-27f80062498c",
"project_status_code": "sample string 10",
"project_status": {
"id": "88e93898-5289-4e93-a467-1b7bfe6d373d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d662d540-2c34-44e6-b851-eb4d1b4d4560",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d6dcf3c1-c958-4dfa-912e-b91e2b80c1d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fb11121a-3ccd-43c1-898c-2a9c3a3adf6c",
"db_currency_id": "0b05f1ed-4f9c-40a2-a8d1-16cf635b526e",
"db_language_id": "ebc9c423-ea2d-4536-9dd0-6662281b2ba3",
"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-28T13:14:27.7020068+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-28T13:14:27.7020068+00:00"
},
"company_id": "cbbadf89-d3dd-4f89-8ca4-e6785b71fc98",
"company_code": "sample string 12",
"db_address_id": "a0d79170-1081-49f9-a3e5-b9bb53ea46c6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9ceccf9d-2d11-4c83-acb4-8a9355b7867d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "43adc161-bb95-4d90-b549-49b019ffebdc",
"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-28T13:14:27.7020068+00:00",
"date_create": "2026-01-28T13:14:27.7020068+00:00",
"date_update": "2026-01-28T13:14:27.7020068+00:00",
"updated_by_user_id": "943aba0c-2dde-4b77-a595-72d67380927a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-28T13:14:27.7020068+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-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-28T13:14:27.7020068+00:00",
"date_last_job": "2026-01-28T13:14:27.7020068+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-28T13:14:27.7020068+00:00",
"modified_dateutc": "2026-01-28T13:14:27.7020068+00:00",
"is_mobile_installation": true
},
"job_type_id": "b79cba15-117d-442e-bd88-e5565d0cf099",
"job_type_code": "sample string 7",
"job_type": {
"id": "5540136e-b2ff-4b16-b3c9-0b632a2836d1",
"name": "sample string 2",
"sales_organization_id": "ea5e9d0f-0667-466b-9e3e-bba627fdba84",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-28T13:14:27.7020068+00:00",
"code": "sample string 7"
},
"job_priority_id": "9b40feb8-6c61-4bf0-84d5-971e73bc0f36",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8232c7e4-c652-4241-a644-375f41b124a2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f10a1a29-f7b9-4fc1-9712-16119fa7ccb2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d6dcf3c1-c958-4dfa-912e-b91e2b80c1d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fb11121a-3ccd-43c1-898c-2a9c3a3adf6c",
"db_currency_id": "0b05f1ed-4f9c-40a2-a8d1-16cf635b526e",
"db_language_id": "ebc9c423-ea2d-4536-9dd0-6662281b2ba3",
"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-28T13:14:27.7020068+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-28T13:14:27.7020068+00:00"
},
"job_status_id": "61ecd145-b506-4bd8-9377-4035e9882be9",
"job_status_code": "sample string 11",
"db_address_id": "5f4c423f-6af8-4563-8968-58b814036761",
"contact_id": "d7667ae1-921f-4473-b35e-f978847edc04",
"requested_by_company_id": "95fdd102-7aa0-47a7-abe4-553d1751380a",
"requested_by_contact_id": "c5c268d6-1806-4511-a5e2-acbeb3af20e1",
"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-28T13:14:27.7020068+00:00",
"due_date": "2026-01-28T13:14:27.7020068+00:00",
"date_create": "2026-01-28T13:14:27.7020068+00:00",
"date_update": "2026-01-28T13:14:27.7020068+00:00",
"date_closed": "2026-01-28T13:14:27.7020068+00:00",
"suggested_user_id": "ed3954a8-059b-4c4c-b7d7-a06ca255c331",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "54167267-c39e-4452-a75c-8c565da49002",
"db_language_id": "f010afda-aaf9-4995-b529-00843bc4a995",
"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-28T13:14:27.7020068+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "49ce8b5d-7875-4b8c-9599-6bd2ecdb36d2",
"sales_organization": {
"id": "d6dcf3c1-c958-4dfa-912e-b91e2b80c1d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fb11121a-3ccd-43c1-898c-2a9c3a3adf6c",
"db_currency_id": "0b05f1ed-4f9c-40a2-a8d1-16cf635b526e",
"db_language_id": "ebc9c423-ea2d-4536-9dd0-6662281b2ba3",
"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-28T13:14:27.7020068+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "08638721-9753-46a0-a066-5ddd4c28e559",
"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": "1dd24e6c-6652-4ee6-a734-4f91ed41b631",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-28T13:14:27.7020068+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "95c66c6a-a222-491e-92da-d215541e5fce"
},
"suggested_date_start": "2026-01-28T13:14:27.7020068+00:00",
"skill_id": "c0cd217a-b63c-4953-a465-6cbf7e9e7592",
"skill_code": "sample string 32",
"skill": {
"id": "56cb5448-9008-4008-87a5-39a171b4dc6c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "928ea4e1-d4e9-4b6b-9031-2e970ab68321",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d6dcf3c1-c958-4dfa-912e-b91e2b80c1d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fb11121a-3ccd-43c1-898c-2a9c3a3adf6c",
"db_currency_id": "0b05f1ed-4f9c-40a2-a8d1-16cf635b526e",
"db_language_id": "ebc9c423-ea2d-4536-9dd0-6662281b2ba3",
"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-28T13:14:27.7020068+00:00"
},
"modified_dateutc": "2026-01-28T13:14:27.7020068+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "917757cf-ab10-4fa6-b129-07db09285d01",
"date_reported_by_company": "2026-01-28T13:14:27.7020068+00:00",
"id2": 36,
"company_id": "78c87397-64ad-4641-94b7-472babfdb025",
"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": "6005d371-344e-4999-a01b-69f41b5f099f",
"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-28T13:14:27.7020068+00:00"
},
"work_instruction_details_id": "f2524e8d-6be1-46ab-a68c-ff3e5d3d57bf",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "04414fdd-8ef5-4699-b913-51249951ef6d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f8de2f81-23a2-4d76-b1cd-719632b67025",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-28T13:14:27.7020068+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": "db8d7668-b365-4446-ae6b-f7d6c6be76da",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-28T13:14:27.7020068+00:00"
}