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": "ddf2537f-4663-4b18-814e-cc33f95cb53c",
"jobs_id": "aab99423-d02c-4a6b-b8c5-cc9d895b5bd1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d591296b-57d8-46a7-a3be-b49c3bcd159d",
"_parent_id": "2adfc339-1bc8-4b8a-8fa1-36e1485f9811",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3b1627b5-4b4f-4438-bc4c-aaa696b3a2be",
"project_reference_back_office": "sample string 5",
"project": {
"id": "96c527db-9b3f-4106-b988-8b4c8e36b807",
"_parent_id": "56ae3316-3b85-490c-ae7f-884de424e6b0",
"root_parent_id": "f76453ea-3982-4405-8562-93367dff9108",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cddce0c8-afa6-47fa-8dd3-375529fcfd95",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b0bf5bbd-c8b1-4a14-abb3-454e4f2bf29f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "736f8cf6-6b8d-4e91-a0bc-575719cede41",
"_parent_code": "sample string 6",
"sales_organization_id": "b5bf9957-d2ff-4ab2-b090-91323958a366",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "73c15d23-c5e6-4fc4-9aa4-bc516e73f9ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb592274-62c6-412e-9568-4a7cf75edf96",
"db_currency_id": "fb3f8c20-3268-42b2-a549-8967e14d2d46",
"db_language_id": "fa8db3b2-912c-41a4-9398-ed6d687ddaef",
"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-05-23T10:05:29.4919989+00:00"
},
"modified_dateutc": "2026-05-23T10:05:29.4919989+00:00"
},
"equipment_model_id": "f71e58bb-7579-449b-b93e-25cfa6f84680",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8b9fb490-c5aa-4215-8b26-ca9d7fd2957f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a151dfbb-1bc6-4ffd-bf36-704403642209",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "25e9ff2b-3819-448e-85f4-bb8b23443e84",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c724003b-8dda-450b-8952-80baabcd8464",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "73c15d23-c5e6-4fc4-9aa4-bc516e73f9ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb592274-62c6-412e-9568-4a7cf75edf96",
"db_currency_id": "fb3f8c20-3268-42b2-a549-8967e14d2d46",
"db_language_id": "fa8db3b2-912c-41a4-9398-ed6d687ddaef",
"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-05-23T10:05:29.4919989+00:00"
},
"modified_dateutc": "2026-05-23T10:05:29.4919989+00:00"
},
"equipment_family_id": "2c7d3193-6f80-4486-96bb-cecc5e44dbd7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b0bf5bbd-c8b1-4a14-abb3-454e4f2bf29f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "736f8cf6-6b8d-4e91-a0bc-575719cede41",
"_parent_code": "sample string 6",
"sales_organization_id": "b5bf9957-d2ff-4ab2-b090-91323958a366",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "73c15d23-c5e6-4fc4-9aa4-bc516e73f9ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb592274-62c6-412e-9568-4a7cf75edf96",
"db_currency_id": "fb3f8c20-3268-42b2-a549-8967e14d2d46",
"db_language_id": "fa8db3b2-912c-41a4-9398-ed6d687ddaef",
"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-05-23T10:05:29.4919989+00:00"
},
"modified_dateutc": "2026-05-23T10:05:29.4919989+00:00"
},
"date_in_production_since": "2026-05-23T10:05:29.4919989+00:00",
"date_out_of_production_since": "2026-05-23T10:05:29.4919989+00:00",
"date_end_support": "2026-05-23T10:05:29.4919989+00:00",
"sales_organization_id": "5f378c7c-fa8f-4d28-a047-5ae35931c5e3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "73c15d23-c5e6-4fc4-9aa4-bc516e73f9ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb592274-62c6-412e-9568-4a7cf75edf96",
"db_currency_id": "fb3f8c20-3268-42b2-a549-8967e14d2d46",
"db_language_id": "fa8db3b2-912c-41a4-9398-ed6d687ddaef",
"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-05-23T10:05:29.4919989+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-05-23T10:05:29.4919989+00:00"
},
"project_status_id": "16f920fb-67be-44dd-8336-84c9df18a725",
"project_status_code": "sample string 10",
"project_status": {
"id": "e1206d8d-862a-443c-9cb6-07e6a563539b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c35bb52c-278c-4f3d-9328-99fa339692ca",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "73c15d23-c5e6-4fc4-9aa4-bc516e73f9ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb592274-62c6-412e-9568-4a7cf75edf96",
"db_currency_id": "fb3f8c20-3268-42b2-a549-8967e14d2d46",
"db_language_id": "fa8db3b2-912c-41a4-9398-ed6d687ddaef",
"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-05-23T10:05:29.4919989+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-23T10:05:29.4919989+00:00"
},
"company_id": "ff96f08e-1142-41ab-9dd4-ed2731c8e833",
"company_code": "sample string 12",
"db_address_id": "1d4e0188-e1bc-4aea-898f-289740d9d035",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9141032c-686b-49d1-929a-61912f718bb3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "866d87a2-ad33-482a-9ce0-69841d07276a",
"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-05-23T10:05:29.4919989+00:00",
"date_create": "2026-05-23T10:05:29.4919989+00:00",
"date_update": "2026-05-23T10:05:29.4919989+00:00",
"updated_by_user_id": "55d55bcb-5d70-46cc-9b21-624b681f6083",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-23T10:05:29.4919989+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-05-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-23T10:05:29.4919989+00:00",
"date_last_job": "2026-05-23T10:05:29.4919989+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-23T10:05:29.4919989+00:00",
"modified_dateutc": "2026-05-23T10:05:29.4919989+00:00",
"is_mobile_installation": true
},
"job_type_id": "257ee6fa-5b07-46e3-9db1-a6d4b0f94693",
"job_type_code": "sample string 7",
"job_type": {
"id": "5659ac46-26be-459e-a122-c1ccf535218e",
"name": "sample string 2",
"sales_organization_id": "e2b7872a-bcb0-4cea-aad3-fa7794df04ac",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-23T10:05:29.4919989+00:00",
"code": "sample string 7"
},
"job_priority_id": "4374d059-3500-439f-8f0f-0bfe9646eab0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a5d7e634-8319-4c85-a445-c49bd2538ed6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0b15069e-3a8d-47d9-aec0-d0c673071dee",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "73c15d23-c5e6-4fc4-9aa4-bc516e73f9ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb592274-62c6-412e-9568-4a7cf75edf96",
"db_currency_id": "fb3f8c20-3268-42b2-a549-8967e14d2d46",
"db_language_id": "fa8db3b2-912c-41a4-9398-ed6d687ddaef",
"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-05-23T10:05:29.4919989+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-23T10:05:29.4919989+00:00"
},
"job_status_id": "2291033a-e1e1-4c86-a567-87181dcc8dcc",
"job_status_code": "sample string 11",
"db_address_id": "7f31f060-0323-4c4b-aaf4-6c349f5b6481",
"contact_id": "6e761fac-f9b6-4e34-a470-03ab97c1af83",
"requested_by_company_id": "1d5630f4-e3fd-4ae8-9b35-9fb409748893",
"requested_by_contact_id": "d8c2d7b2-a838-450f-9012-c5fa2f3016bd",
"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-05-23T10:05:29.4919989+00:00",
"due_date": "2026-05-23T10:05:29.4919989+00:00",
"date_create": "2026-05-23T10:05:29.4919989+00:00",
"date_update": "2026-05-23T10:05:29.4919989+00:00",
"date_closed": "2026-05-23T10:05:29.4919989+00:00",
"suggested_user_id": "1d5c2649-0327-4930-bf19-989e471bc211",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a0f33154-969f-4937-8fd1-ebfa2bc4a65f",
"db_language_id": "af7ecb5e-5567-4974-a03d-59aa7ebd0bdd",
"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-05-23T10:05:29.4919989+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7c9e5e75-8bd3-4008-9f41-ceff67835656",
"sales_organization": {
"id": "73c15d23-c5e6-4fc4-9aa4-bc516e73f9ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb592274-62c6-412e-9568-4a7cf75edf96",
"db_currency_id": "fb3f8c20-3268-42b2-a549-8967e14d2d46",
"db_language_id": "fa8db3b2-912c-41a4-9398-ed6d687ddaef",
"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-05-23T10:05:29.4919989+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "12db5c8f-933c-4086-bd3f-7008dc6b785e",
"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": "8b096471-6b47-4ae7-91ee-358e16b84308",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-23T10:05:29.4919989+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1349bc06-79c5-40c7-88a3-2b1aedfc25cf"
},
"suggested_date_start": "2026-05-23T10:05:29.4919989+00:00",
"skill_id": "1329c7b9-1bb3-4cb7-ba47-0e31078f19cc",
"skill_code": "sample string 32",
"skill": {
"id": "9d52cf5f-c458-4997-963f-7f7b23a357e1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3a4ee730-6414-4319-b2e2-3828f1f31e3f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "73c15d23-c5e6-4fc4-9aa4-bc516e73f9ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb592274-62c6-412e-9568-4a7cf75edf96",
"db_currency_id": "fb3f8c20-3268-42b2-a549-8967e14d2d46",
"db_language_id": "fa8db3b2-912c-41a4-9398-ed6d687ddaef",
"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-05-23T10:05:29.4919989+00:00"
},
"modified_dateutc": "2026-05-23T10:05:29.4919989+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9f1b2ebd-dd51-4691-897b-96e7a383402f",
"date_reported_by_company": "2026-05-23T10:05:29.4919989+00:00",
"id2": 36,
"company_id": "eee85394-f7fc-4cc5-a51a-5407ff1d5296",
"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": "90a520ac-3509-41e8-bdf2-f7eaedb14a52",
"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-05-23T10:05:29.4919989+00:00"
},
"work_instruction_details_id": "fcc054d5-075e-46d0-a18e-1c5db731ecff",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5f078b60-2bff-4b31-823b-50d093b8e711",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3518c8ba-e045-4155-bcf2-3697c9fed182",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-23T10:05:29.4919989+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": "3b9df8f5-e3bb-4e38-800e-3507567d20f7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-23T10:05:29.4919989+00:00"
}