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": "2bcd2b9c-17f9-4925-b61d-566c6b248bd4",
"jobs_id": "3026dd6f-146c-4ae7-91ff-64a65588699c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "93fe6947-10a9-4fa5-a434-024324d9d4f7",
"_parent_id": "47a8dd8d-3bd2-4385-941b-f931ad307e62",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "df174df6-928f-4d3d-91ca-a6d32c536a99",
"project_reference_back_office": "sample string 5",
"project": {
"id": "90f56cf6-9632-4daf-b4ef-b9053643c6cb",
"_parent_id": "1ea484d3-9928-49e8-9f37-f27391c790c2",
"root_parent_id": "9b29b6b7-be83-447d-b5b7-a2499ca03568",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "beee744b-f1e9-4f82-b8dd-6a558044e8a1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ba4c41a1-0d35-445f-a052-96e3c084d44b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f8c5f490-1a39-4a78-93fe-982ffb540465",
"_parent_code": "sample string 6",
"sales_organization_id": "022c4c6c-dfe2-47a0-8e36-5b1edba2a61e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6c723536-844b-4d87-a8c3-2cc88c13da42",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f2f442a-ddb3-43d6-a38b-617167c99232",
"db_currency_id": "1724571b-58d1-452c-8837-88bffb9a4f38",
"db_language_id": "e4a4caae-0c7a-4703-91a4-9cb6b4a079fa",
"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-11-14T23:51:59.2498447+00:00"
},
"modified_dateutc": "2026-11-14T23:51:59.2498447+00:00"
},
"equipment_model_id": "2d8e7056-6331-49ae-81f1-34d0e1aeb60b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "64b102cd-69d6-4400-92aa-b754028a56d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ac26422e-ecfe-4f9d-bc16-431a6bc8dd57",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "263c60de-a2a9-48e8-a31f-abfcfcdb0d98",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "50603d6a-ae91-45b0-8624-74a9b523e88c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6c723536-844b-4d87-a8c3-2cc88c13da42",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f2f442a-ddb3-43d6-a38b-617167c99232",
"db_currency_id": "1724571b-58d1-452c-8837-88bffb9a4f38",
"db_language_id": "e4a4caae-0c7a-4703-91a4-9cb6b4a079fa",
"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-11-14T23:51:59.2498447+00:00"
},
"modified_dateutc": "2026-11-14T23:51:59.2498447+00:00"
},
"equipment_family_id": "d079c274-db4b-4384-804a-185923d0398b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ba4c41a1-0d35-445f-a052-96e3c084d44b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f8c5f490-1a39-4a78-93fe-982ffb540465",
"_parent_code": "sample string 6",
"sales_organization_id": "022c4c6c-dfe2-47a0-8e36-5b1edba2a61e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6c723536-844b-4d87-a8c3-2cc88c13da42",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f2f442a-ddb3-43d6-a38b-617167c99232",
"db_currency_id": "1724571b-58d1-452c-8837-88bffb9a4f38",
"db_language_id": "e4a4caae-0c7a-4703-91a4-9cb6b4a079fa",
"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-11-14T23:51:59.2498447+00:00"
},
"modified_dateutc": "2026-11-14T23:51:59.2498447+00:00"
},
"date_in_production_since": "2026-11-14T23:51:59.2498447+00:00",
"date_out_of_production_since": "2026-11-14T23:51:59.2498447+00:00",
"date_end_support": "2026-11-14T23:51:59.2498447+00:00",
"sales_organization_id": "aeeb6175-be74-4102-aa3b-1817b3518463",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6c723536-844b-4d87-a8c3-2cc88c13da42",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f2f442a-ddb3-43d6-a38b-617167c99232",
"db_currency_id": "1724571b-58d1-452c-8837-88bffb9a4f38",
"db_language_id": "e4a4caae-0c7a-4703-91a4-9cb6b4a079fa",
"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-11-14T23:51:59.2498447+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-11-14T23:51:59.2498447+00:00"
},
"project_status_id": "6b50ff41-2d32-4bc1-85bd-1bc14e682234",
"project_status_code": "sample string 10",
"project_status": {
"id": "e03baa9a-2843-4e5b-ba1a-2a36046cbb5d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fae96411-c15f-4ad9-b204-b01a3067bff6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6c723536-844b-4d87-a8c3-2cc88c13da42",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f2f442a-ddb3-43d6-a38b-617167c99232",
"db_currency_id": "1724571b-58d1-452c-8837-88bffb9a4f38",
"db_language_id": "e4a4caae-0c7a-4703-91a4-9cb6b4a079fa",
"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-11-14T23:51:59.2498447+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-14T23:51:59.2498447+00:00"
},
"company_id": "8767e7f4-66a0-40b6-88ad-6cdea779ff8a",
"company_code": "sample string 12",
"db_address_id": "8f8bab7e-3bf1-4ee2-b3e3-5a0c8d1b2a1e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3a061aee-f494-4c16-adc1-b3f2a8680c45",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ce4dbeab-ac1d-49f1-8403-0b1e8024f907",
"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-11-14T23:51:59.2498447+00:00",
"date_create": "2026-11-14T23:51:59.2498447+00:00",
"date_update": "2026-11-14T23:51:59.2498447+00:00",
"updated_by_user_id": "d7321b62-90a5-4e4c-8488-06a0717808a4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-14T23:51:59.2498447+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-11-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-14T23:51:59.2498447+00:00",
"date_last_job": "2026-11-14T23:51:59.2498447+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-14T23:51:59.2498447+00:00",
"modified_dateutc": "2026-11-14T23:51:59.2498447+00:00",
"is_mobile_installation": true
},
"job_type_id": "2def9779-10b3-4f32-82a0-9f69e8f782d3",
"job_type_code": "sample string 7",
"job_type": {
"id": "6830d83b-b328-4882-afea-ad23dde7d3c9",
"name": "sample string 2",
"sales_organization_id": "eec1ede7-a752-46f8-a814-0c82ef97ffe1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-14T23:51:59.2498447+00:00",
"code": "sample string 7"
},
"job_priority_id": "389d954b-219c-474a-aabf-a80de2fa5d40",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4ef18f37-6955-4575-a98f-3bff05db7ae6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4d10d595-58e5-4536-85d3-c99c1f1451ff",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6c723536-844b-4d87-a8c3-2cc88c13da42",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f2f442a-ddb3-43d6-a38b-617167c99232",
"db_currency_id": "1724571b-58d1-452c-8837-88bffb9a4f38",
"db_language_id": "e4a4caae-0c7a-4703-91a4-9cb6b4a079fa",
"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-11-14T23:51:59.2498447+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-14T23:51:59.2498447+00:00"
},
"job_status_id": "a576062f-8c53-4f75-a567-fc510d07b86e",
"job_status_code": "sample string 11",
"db_address_id": "dd46e4ae-0d5a-4550-8d5c-0ebb8dd9998f",
"contact_id": "f7c2a946-2532-4aa2-9956-5a3b22829e55",
"requested_by_company_id": "57b197aa-e666-44a0-b762-555c4cb5f185",
"requested_by_contact_id": "1b3e7a38-fdb4-4a2c-9643-17c5c2dc5539",
"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-11-14T23:51:59.2498447+00:00",
"due_date": "2026-11-14T23:51:59.2498447+00:00",
"date_create": "2026-11-14T23:51:59.2498447+00:00",
"date_update": "2026-11-14T23:51:59.2498447+00:00",
"date_closed": "2026-11-14T23:51:59.2498447+00:00",
"suggested_user_id": "4d0dcb68-5aca-4685-b332-63d29e64b2e7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e8f20755-9897-45b5-9727-53e2b4302853",
"db_language_id": "97c54358-fc48-479c-9bb8-902fde072d4e",
"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-11-14T23:51:59.2498447+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a53e287f-4aaa-4efb-84ad-e2b0249663c8",
"sales_organization": {
"id": "6c723536-844b-4d87-a8c3-2cc88c13da42",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f2f442a-ddb3-43d6-a38b-617167c99232",
"db_currency_id": "1724571b-58d1-452c-8837-88bffb9a4f38",
"db_language_id": "e4a4caae-0c7a-4703-91a4-9cb6b4a079fa",
"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-11-14T23:51:59.2498447+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f56e78b8-cac8-4eae-b81d-8cce59bbc503",
"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": "de968b25-6890-4def-8c91-9e2f7f0df70b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-14T23:51:59.2498447+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "19461049-db01-4832-8bf1-254cd31614f6"
},
"suggested_date_start": "2026-11-14T23:51:59.2498447+00:00",
"skill_id": "c74e52d0-8390-491b-89e2-4b894c0d3455",
"skill_code": "sample string 32",
"skill": {
"id": "aabba1a2-9cc4-4fd5-94c0-cb27311e1b90",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "67e9ce89-927c-4447-b0c9-85f2f5a2a0d2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6c723536-844b-4d87-a8c3-2cc88c13da42",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f2f442a-ddb3-43d6-a38b-617167c99232",
"db_currency_id": "1724571b-58d1-452c-8837-88bffb9a4f38",
"db_language_id": "e4a4caae-0c7a-4703-91a4-9cb6b4a079fa",
"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-11-14T23:51:59.2498447+00:00"
},
"modified_dateutc": "2026-11-14T23:51:59.2498447+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ca1fc4c2-46bf-436b-9776-ea396e4125a8",
"date_reported_by_company": "2026-11-14T23:51:59.2498447+00:00",
"id2": 36,
"company_id": "73c8bc47-b374-4218-afda-f35106ab0189",
"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": "38144658-1b0c-4b82-94f8-91e30b16775b",
"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-11-14T23:51:59.2498447+00:00"
},
"work_instruction_details_id": "38d140f0-55c7-44c5-ba1c-4126e87ee7ad",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "13b06a8d-2c32-40eb-addf-441923e558d0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "22b80aed-6bdc-47cb-8198-19fba5faebdc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-14T23:51:59.2498447+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": "8c602d4e-39f8-4c7a-8c50-50b9361bae38",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-14T23:51:59.2498447+00:00"
}