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": "2c68c880-347e-4485-ad48-105b1302830a",
"jobs_id": "c7869b3d-f7a2-47a9-b072-ea09a298724a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2be7af87-a40e-4921-b86b-3658fbc3ebec",
"_parent_id": "4aff0204-a1fa-4899-8dd4-cb4ff6b06ebc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e6ee9060-196f-4de0-9feb-f1c9b366d562",
"project_reference_back_office": "sample string 5",
"project": {
"id": "00b27a07-e4f7-4038-90a7-a961b6ea8ff6",
"_parent_id": "8c23d360-e310-4ca3-840e-003f3445fbd4",
"root_parent_id": "3913e187-ee29-4fcc-8ca0-53f3f2e488ae",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d26d268c-c3e5-4874-9fcb-c4f4a6d1d353",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ab12f0a5-f9ac-4c0d-bead-3bce18ca12d7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "be433d1d-18c4-4326-a156-9e10499f0336",
"_parent_code": "sample string 6",
"sales_organization_id": "78140bf5-d3bc-4911-8060-c1499cabab10",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7edda2dd-d9c1-4960-ba7b-62b532e9ee64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c17212a3-aa00-40d3-9cbf-4f8731fd6466",
"db_currency_id": "863c9ec0-6761-4a97-ab18-f5f80e5d134f",
"db_language_id": "32af3cfa-86c3-4cec-8160-87bbaa379ed5",
"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-09-21T20:11:40.9493537+00:00"
},
"modified_dateutc": "2026-09-21T20:11:40.9493537+00:00"
},
"equipment_model_id": "46da4468-a0e3-4a3f-8505-bc569a89de29",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c2a2e114-8c70-40a7-8e3b-f312de8a793c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4d061b1e-9145-4e22-a966-ee77242eab09",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "73c0c23c-d83e-4d30-b585-c090c88f82af",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "94288fdf-8dd7-4595-82a8-b712d2e47694",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7edda2dd-d9c1-4960-ba7b-62b532e9ee64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c17212a3-aa00-40d3-9cbf-4f8731fd6466",
"db_currency_id": "863c9ec0-6761-4a97-ab18-f5f80e5d134f",
"db_language_id": "32af3cfa-86c3-4cec-8160-87bbaa379ed5",
"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-09-21T20:11:40.9493537+00:00"
},
"modified_dateutc": "2026-09-21T20:11:40.9493537+00:00"
},
"equipment_family_id": "d56841df-9f76-4c1a-96d4-77d31ea88035",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ab12f0a5-f9ac-4c0d-bead-3bce18ca12d7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "be433d1d-18c4-4326-a156-9e10499f0336",
"_parent_code": "sample string 6",
"sales_organization_id": "78140bf5-d3bc-4911-8060-c1499cabab10",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7edda2dd-d9c1-4960-ba7b-62b532e9ee64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c17212a3-aa00-40d3-9cbf-4f8731fd6466",
"db_currency_id": "863c9ec0-6761-4a97-ab18-f5f80e5d134f",
"db_language_id": "32af3cfa-86c3-4cec-8160-87bbaa379ed5",
"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-09-21T20:11:40.9493537+00:00"
},
"modified_dateutc": "2026-09-21T20:11:40.9493537+00:00"
},
"date_in_production_since": "2026-09-21T20:11:40.9493537+00:00",
"date_out_of_production_since": "2026-09-21T20:11:40.9493537+00:00",
"date_end_support": "2026-09-21T20:11:40.9493537+00:00",
"sales_organization_id": "2ffbb4fe-1609-40c7-8c3c-3f760eec00db",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7edda2dd-d9c1-4960-ba7b-62b532e9ee64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c17212a3-aa00-40d3-9cbf-4f8731fd6466",
"db_currency_id": "863c9ec0-6761-4a97-ab18-f5f80e5d134f",
"db_language_id": "32af3cfa-86c3-4cec-8160-87bbaa379ed5",
"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-09-21T20:11:40.9493537+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-09-21T20:11:40.9493537+00:00"
},
"project_status_id": "8d74c750-8a17-42fd-bc7f-10f2477918e3",
"project_status_code": "sample string 10",
"project_status": {
"id": "ff5fb461-50ff-468e-a79c-3ec03987dd1a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9385dda1-8e0e-4162-9a30-1fe33f39a779",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7edda2dd-d9c1-4960-ba7b-62b532e9ee64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c17212a3-aa00-40d3-9cbf-4f8731fd6466",
"db_currency_id": "863c9ec0-6761-4a97-ab18-f5f80e5d134f",
"db_language_id": "32af3cfa-86c3-4cec-8160-87bbaa379ed5",
"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-09-21T20:11:40.9493537+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-21T20:11:40.9493537+00:00"
},
"company_id": "55d22cd0-ae2c-4bc5-b869-69632f4b2727",
"company_code": "sample string 12",
"db_address_id": "97638b0d-5163-4d4a-bdac-cc974a349afb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6bdb989a-31d7-4fa3-946d-7696d2636a9f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3de38589-6cfc-4513-a3b9-decb4a0e8a09",
"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-09-21T20:11:40.9493537+00:00",
"date_create": "2026-09-21T20:11:40.9493537+00:00",
"date_update": "2026-09-21T20:11:40.9493537+00:00",
"updated_by_user_id": "8f481285-5c53-42a9-90dc-4aa38879fc87",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-21T20:11:40.9493537+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-09-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-21T20:11:40.9493537+00:00",
"date_last_job": "2026-09-21T20:11:40.9493537+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-21T20:11:40.9493537+00:00",
"modified_dateutc": "2026-09-21T20:11:40.9493537+00:00",
"is_mobile_installation": true
},
"job_type_id": "225fcbc7-8e61-4a7e-b9e6-ac5362a27c79",
"job_type_code": "sample string 7",
"job_type": {
"id": "34236b5b-dbfd-4b4d-8ece-9c9636033d92",
"name": "sample string 2",
"sales_organization_id": "8807c58c-51bd-460f-837b-4379ac263b38",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-21T20:11:40.9493537+00:00",
"code": "sample string 7"
},
"job_priority_id": "6ca78e11-f6de-4072-8f23-44bd458dc412",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f7227579-a8f1-427a-919a-4544d98c02e6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5bb809a7-38ea-4a7f-a1e8-1470dcd880c6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7edda2dd-d9c1-4960-ba7b-62b532e9ee64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c17212a3-aa00-40d3-9cbf-4f8731fd6466",
"db_currency_id": "863c9ec0-6761-4a97-ab18-f5f80e5d134f",
"db_language_id": "32af3cfa-86c3-4cec-8160-87bbaa379ed5",
"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-09-21T20:11:40.9493537+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-21T20:11:40.9493537+00:00"
},
"job_status_id": "e62182e5-97bd-46e2-b21a-04ef7fd5c362",
"job_status_code": "sample string 11",
"db_address_id": "cb3750a1-fcb4-4835-aa41-a0c2f7ef14b5",
"contact_id": "bdc9118f-b897-4a7b-bd7a-6ba9bfbfe507",
"requested_by_company_id": "834d23b2-d972-4ecf-a70d-a68f8d4e3149",
"requested_by_contact_id": "0af52715-6f0b-4e0a-b181-1def46483338",
"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-09-21T20:11:40.9493537+00:00",
"due_date": "2026-09-21T20:11:40.9493537+00:00",
"date_create": "2026-09-21T20:11:40.9493537+00:00",
"date_update": "2026-09-21T20:11:40.9493537+00:00",
"date_closed": "2026-09-21T20:11:40.9493537+00:00",
"suggested_user_id": "85e3e579-bdd5-4bb9-a8db-269f72c9eae2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6c58394b-02e3-45ae-a26e-d2fc1f2448ae",
"db_language_id": "5b54059b-9725-4d65-b4a3-7e3f8fe05384",
"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-09-21T20:11:40.9493537+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1947695b-6748-4c14-af7e-6ae7fdbe4693",
"sales_organization": {
"id": "7edda2dd-d9c1-4960-ba7b-62b532e9ee64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c17212a3-aa00-40d3-9cbf-4f8731fd6466",
"db_currency_id": "863c9ec0-6761-4a97-ab18-f5f80e5d134f",
"db_language_id": "32af3cfa-86c3-4cec-8160-87bbaa379ed5",
"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-09-21T20:11:40.9493537+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "75f61798-e3f2-4e7d-b50d-daf7ea7bfb7a",
"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": "65574f57-9960-4256-97ac-df9abca8fe88",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-21T20:11:40.9493537+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b988f65e-4bd4-4e78-94e6-f76543cf8f07"
},
"suggested_date_start": "2026-09-21T20:11:40.9493537+00:00",
"skill_id": "e60a4cd7-b07e-4270-a6aa-7e63b8f229db",
"skill_code": "sample string 32",
"skill": {
"id": "aac19103-a2ef-494e-aa21-4423653a3656",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "38ebbb8a-7381-43c4-8064-bd5d9a8d7d94",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7edda2dd-d9c1-4960-ba7b-62b532e9ee64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c17212a3-aa00-40d3-9cbf-4f8731fd6466",
"db_currency_id": "863c9ec0-6761-4a97-ab18-f5f80e5d134f",
"db_language_id": "32af3cfa-86c3-4cec-8160-87bbaa379ed5",
"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-09-21T20:11:40.9493537+00:00"
},
"modified_dateutc": "2026-09-21T20:11:40.9493537+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "78c8381b-bd15-4e4f-b035-3e0b74fe76a2",
"date_reported_by_company": "2026-09-21T20:11:40.9493537+00:00",
"id2": 36,
"company_id": "24d17e98-fc24-4e22-9f16-94864a74dfb6",
"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": "cf3e9757-cd2a-434f-8a62-589a45a274d5",
"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-09-21T20:11:40.9493537+00:00"
},
"work_instruction_details_id": "3b455f9b-55bc-47c1-b3f1-9dc3af221489",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "58fb1d33-27d6-4e2c-98c3-c2d79ee75e34",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fdd7bdd5-d6d5-4f85-a406-b1fe9a9a3495",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-21T20:11:40.9493537+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": "4d6c3bf2-fc7d-443c-988b-1fb27d889ec7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-21T20:11:40.9493537+00:00"
}