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": "8b09ae0f-6ac3-425f-b56c-a2d4acc1cb65",
"jobs_id": "c0ecdb96-770c-4b2e-bc39-82df18f9ed6f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d6ef1165-a93d-40b3-aec2-dfaca7d8645f",
"_parent_id": "07eadd0d-fad4-40cd-a0a4-011a99c44121",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "13aae77e-8fd6-4f7f-9533-6be17edf0786",
"project_reference_back_office": "sample string 5",
"project": {
"id": "142011b3-9409-40d2-94e7-ccf5537347d4",
"_parent_id": "0ae6d554-49a8-4b41-aa68-9fc2e3f322d3",
"root_parent_id": "f6b8705e-4567-4f25-9a46-a04f634c6465",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "88c4ad72-811b-4fa5-8ec9-f37d2c44d20b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1f85c759-87e2-4110-838e-5e78e1437ed8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "744b7ccd-d8cb-4f78-9e00-f2ffacee9547",
"_parent_code": "sample string 6",
"sales_organization_id": "789f1b75-5e13-4802-a41e-1f1acd649849",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "edf022ae-45d9-4af9-b4bd-7ae20833e5bb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed64241f-3e05-4830-b561-4f71bab52b4d",
"db_currency_id": "a15df99f-2a82-4634-ad35-b0904ea39a42",
"db_language_id": "11e91cf3-07d5-45ed-ab22-4afdc4fd7b2b",
"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-13T09:09:00.4308949+00:00"
},
"modified_dateutc": "2026-05-13T09:09:00.4308949+00:00"
},
"equipment_model_id": "f8b6e740-5d96-4623-9555-54790ca3dff9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f540aab2-ca03-4486-a509-5be4cdbbab20",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8d10dd22-4aac-42f3-ace7-e71af4a8347a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "63965b0e-42c0-41e9-9830-53083f7ac48e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "95b1319a-46cc-4ce9-a2eb-6d7e6cfff285",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "edf022ae-45d9-4af9-b4bd-7ae20833e5bb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed64241f-3e05-4830-b561-4f71bab52b4d",
"db_currency_id": "a15df99f-2a82-4634-ad35-b0904ea39a42",
"db_language_id": "11e91cf3-07d5-45ed-ab22-4afdc4fd7b2b",
"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-13T09:09:00.4308949+00:00"
},
"modified_dateutc": "2026-05-13T09:09:00.4308949+00:00"
},
"equipment_family_id": "d49876a9-38f0-4fa1-a97d-8b99cec2dc96",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1f85c759-87e2-4110-838e-5e78e1437ed8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "744b7ccd-d8cb-4f78-9e00-f2ffacee9547",
"_parent_code": "sample string 6",
"sales_organization_id": "789f1b75-5e13-4802-a41e-1f1acd649849",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "edf022ae-45d9-4af9-b4bd-7ae20833e5bb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed64241f-3e05-4830-b561-4f71bab52b4d",
"db_currency_id": "a15df99f-2a82-4634-ad35-b0904ea39a42",
"db_language_id": "11e91cf3-07d5-45ed-ab22-4afdc4fd7b2b",
"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-13T09:09:00.4308949+00:00"
},
"modified_dateutc": "2026-05-13T09:09:00.4308949+00:00"
},
"date_in_production_since": "2026-05-13T09:09:00.4308949+00:00",
"date_out_of_production_since": "2026-05-13T09:09:00.4308949+00:00",
"date_end_support": "2026-05-13T09:09:00.4308949+00:00",
"sales_organization_id": "8285a0c0-ac52-4fd5-be50-6b438e2d628e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "edf022ae-45d9-4af9-b4bd-7ae20833e5bb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed64241f-3e05-4830-b561-4f71bab52b4d",
"db_currency_id": "a15df99f-2a82-4634-ad35-b0904ea39a42",
"db_language_id": "11e91cf3-07d5-45ed-ab22-4afdc4fd7b2b",
"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-13T09:09:00.4308949+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-13T09:09:00.4465149+00:00"
},
"project_status_id": "b57d32a1-ca8c-4c94-8f99-bd548e4d7956",
"project_status_code": "sample string 10",
"project_status": {
"id": "343497f8-3514-4aa7-b172-52a0ec71c007",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "62d7702e-73d6-4d95-aa68-53247e9c5ca0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "edf022ae-45d9-4af9-b4bd-7ae20833e5bb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed64241f-3e05-4830-b561-4f71bab52b4d",
"db_currency_id": "a15df99f-2a82-4634-ad35-b0904ea39a42",
"db_language_id": "11e91cf3-07d5-45ed-ab22-4afdc4fd7b2b",
"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-13T09:09:00.4308949+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-13T09:09:00.4465149+00:00"
},
"company_id": "9d9a1977-554c-4561-bf2d-9549e1c9770c",
"company_code": "sample string 12",
"db_address_id": "cfcf63cc-426f-4948-a751-f375246a8bcd",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0edf09ab-00ac-425a-867e-4c3d34e79aff",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2ad3e0af-af95-4582-9360-e8462c4a5423",
"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-13T09:09:00.4465149+00:00",
"date_create": "2026-05-13T09:09:00.4465149+00:00",
"date_update": "2026-05-13T09:09:00.4465149+00:00",
"updated_by_user_id": "af9219f5-6976-4697-8164-fab1d5cb05bd",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-13T09:09:00.4465149+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-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-13T09:09:00.4465149+00:00",
"date_last_job": "2026-05-13T09:09:00.4465149+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-13T09:09:00.4465149+00:00",
"modified_dateutc": "2026-05-13T09:09:00.4465149+00:00",
"is_mobile_installation": true
},
"job_type_id": "ee8cc2ff-3d5d-461b-9805-7f32213e4633",
"job_type_code": "sample string 7",
"job_type": {
"id": "e812c3a9-2068-4400-8da1-32d49811c5f6",
"name": "sample string 2",
"sales_organization_id": "1b9f6f2a-fd09-4f4f-b029-207bd04bacf1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-13T09:09:00.4465149+00:00",
"code": "sample string 7"
},
"job_priority_id": "30410d1b-7adf-466e-adfc-ec06427ee496",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4a4df82d-05ad-4979-9268-87df94be2074",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "90c18764-56ef-4fb3-ae67-40c961c5290c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "edf022ae-45d9-4af9-b4bd-7ae20833e5bb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed64241f-3e05-4830-b561-4f71bab52b4d",
"db_currency_id": "a15df99f-2a82-4634-ad35-b0904ea39a42",
"db_language_id": "11e91cf3-07d5-45ed-ab22-4afdc4fd7b2b",
"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-13T09:09:00.4308949+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-13T09:09:00.4465149+00:00"
},
"job_status_id": "779da06d-a69c-4696-a08f-dc25b176c50b",
"job_status_code": "sample string 11",
"db_address_id": "b72c37b8-e4a6-4e7f-9ce8-4fa3a4a90df5",
"contact_id": "143716d0-71e8-4891-bbec-c27729922c04",
"requested_by_company_id": "7a99e660-b1a8-4616-9bcb-9e2a99ae008f",
"requested_by_contact_id": "e9e06f63-bbc7-455c-8154-37bda37388e4",
"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-13T09:09:00.4465149+00:00",
"due_date": "2026-05-13T09:09:00.4465149+00:00",
"date_create": "2026-05-13T09:09:00.4465149+00:00",
"date_update": "2026-05-13T09:09:00.4465149+00:00",
"date_closed": "2026-05-13T09:09:00.4465149+00:00",
"suggested_user_id": "0c1b5990-193c-41c9-864b-e5960db92141",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "564a4831-8141-4071-ad99-49f0e4026238",
"db_language_id": "6e594af8-7f1d-44ef-8e7d-36c178e812b0",
"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-13T09:09:00.4465149+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b3ba76fa-5d28-4622-b460-79b69cea0c8c",
"sales_organization": {
"id": "edf022ae-45d9-4af9-b4bd-7ae20833e5bb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed64241f-3e05-4830-b561-4f71bab52b4d",
"db_currency_id": "a15df99f-2a82-4634-ad35-b0904ea39a42",
"db_language_id": "11e91cf3-07d5-45ed-ab22-4afdc4fd7b2b",
"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-13T09:09:00.4308949+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ca63c518-509d-488e-bb98-40485f082c65",
"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": "d4f326c0-804d-45e7-b559-8b7020827770",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-13T09:09:00.4465149+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "64e6aa60-60f2-47a3-b46e-23da2e514e7a"
},
"suggested_date_start": "2026-05-13T09:09:00.4465149+00:00",
"skill_id": "df24203a-ee1b-4fd2-bd0f-2c1ddfe97565",
"skill_code": "sample string 32",
"skill": {
"id": "12d0ab93-9bad-4c12-a08f-a49a9c6ddb99",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6615be8b-7175-4b0b-8adf-4a64ecc49a89",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "edf022ae-45d9-4af9-b4bd-7ae20833e5bb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed64241f-3e05-4830-b561-4f71bab52b4d",
"db_currency_id": "a15df99f-2a82-4634-ad35-b0904ea39a42",
"db_language_id": "11e91cf3-07d5-45ed-ab22-4afdc4fd7b2b",
"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-13T09:09:00.4308949+00:00"
},
"modified_dateutc": "2026-05-13T09:09:00.4465149+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5e6922d1-a492-451c-ba32-fae323fe4452",
"date_reported_by_company": "2026-05-13T09:09:00.4465149+00:00",
"id2": 36,
"company_id": "0e7aaa2e-58e9-43e1-bef1-86ff7696c0d4",
"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": "65f4c9c6-b6e4-4412-9936-199219728166",
"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-13T09:09:00.4465149+00:00"
},
"work_instruction_details_id": "437faa9e-a0c3-46ad-a82a-4c1375e85e46",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b00f91b3-af52-4b09-beea-0a77290ceb3e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3dda65da-34d7-404f-a38f-44dcb16c0d84",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-13T09:09:00.4465149+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": "90523539-c3a2-40d9-852c-5fbf5429863a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-13T09:09:00.4465149+00:00"
}