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": "e0a01080-7701-48f6-909e-2bcbd54171e2",
"jobs_id": "4facf79e-0bf8-49d2-a52d-d643818141f2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7a9f5931-d443-49d5-ac2b-f3f87b1063cd",
"_parent_id": "de0afe3a-1f0a-4070-9056-c1e51f64245b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e07ced10-553e-424f-8646-04d0ce9a9ccf",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ccac9c16-8b8e-43e1-beed-1e27ad675744",
"_parent_id": "93ab3f12-1b4a-4a92-82f6-ccd17d426d06",
"root_parent_id": "d543c568-6f25-4361-a306-f791176e2924",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "647d8e18-3e74-48c1-95c8-fa801f08ffd5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "beb5ecca-f445-4346-ba35-69a8938b2719",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b25055a9-7d0f-478d-8e9a-f3865d8ff789",
"_parent_code": "sample string 6",
"sales_organization_id": "0a26c448-83fb-45a0-879e-f44efeb18bbf",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5e83cf22-fec6-439d-a762-0d77af018786",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c660680-9b52-4903-94af-fdc02171b432",
"db_currency_id": "a5007198-f701-498d-9071-5d8c60d34318",
"db_language_id": "b4b844d6-65b4-4125-9465-fcadc389ad32",
"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-07-11T10:05:17.4779399+00:00"
},
"modified_dateutc": "2026-07-11T10:05:17.4779399+00:00"
},
"equipment_model_id": "68007d32-b412-4281-90cf-e954d726ca46",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "af76206b-4741-462c-ba49-2c15dd726386",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1144f883-7bd6-4fb3-9d20-49179670206a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6e9f8292-ff1f-4b0b-8dbb-3ab7ffb95fef",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b5febb73-8af5-415c-bd6b-8530a091a329",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5e83cf22-fec6-439d-a762-0d77af018786",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c660680-9b52-4903-94af-fdc02171b432",
"db_currency_id": "a5007198-f701-498d-9071-5d8c60d34318",
"db_language_id": "b4b844d6-65b4-4125-9465-fcadc389ad32",
"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-07-11T10:05:17.4779399+00:00"
},
"modified_dateutc": "2026-07-11T10:05:17.4779399+00:00"
},
"equipment_family_id": "1dfa76bc-1e77-422b-b4b9-1d468521971c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "beb5ecca-f445-4346-ba35-69a8938b2719",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b25055a9-7d0f-478d-8e9a-f3865d8ff789",
"_parent_code": "sample string 6",
"sales_organization_id": "0a26c448-83fb-45a0-879e-f44efeb18bbf",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5e83cf22-fec6-439d-a762-0d77af018786",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c660680-9b52-4903-94af-fdc02171b432",
"db_currency_id": "a5007198-f701-498d-9071-5d8c60d34318",
"db_language_id": "b4b844d6-65b4-4125-9465-fcadc389ad32",
"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-07-11T10:05:17.4779399+00:00"
},
"modified_dateutc": "2026-07-11T10:05:17.4779399+00:00"
},
"date_in_production_since": "2026-07-11T10:05:17.4779399+00:00",
"date_out_of_production_since": "2026-07-11T10:05:17.4779399+00:00",
"date_end_support": "2026-07-11T10:05:17.4779399+00:00",
"sales_organization_id": "a1af502c-a7a1-41d5-a78c-bb7fd4d313fa",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5e83cf22-fec6-439d-a762-0d77af018786",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c660680-9b52-4903-94af-fdc02171b432",
"db_currency_id": "a5007198-f701-498d-9071-5d8c60d34318",
"db_language_id": "b4b844d6-65b4-4125-9465-fcadc389ad32",
"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-07-11T10:05:17.4779399+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-07-11T10:05:17.4779399+00:00"
},
"project_status_id": "593d5921-d087-4837-a1de-0192bf56a544",
"project_status_code": "sample string 10",
"project_status": {
"id": "a80cd0d5-cb64-4830-894d-b987f203c91a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2f18b512-3666-4636-a605-682063cb0588",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5e83cf22-fec6-439d-a762-0d77af018786",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c660680-9b52-4903-94af-fdc02171b432",
"db_currency_id": "a5007198-f701-498d-9071-5d8c60d34318",
"db_language_id": "b4b844d6-65b4-4125-9465-fcadc389ad32",
"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-07-11T10:05:17.4779399+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-11T10:05:17.4779399+00:00"
},
"company_id": "87106813-45f1-42ba-9d1b-3f86f341b38a",
"company_code": "sample string 12",
"db_address_id": "b231b874-26bc-4c33-9a5a-59ee17b88662",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6cf537a2-7c90-4b78-ac4a-d47162a594d3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2f71b4b3-97e8-4a55-8b17-7db675d786da",
"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-07-11T10:05:17.4779399+00:00",
"date_create": "2026-07-11T10:05:17.4779399+00:00",
"date_update": "2026-07-11T10:05:17.4779399+00:00",
"updated_by_user_id": "8201f6ff-c8ac-4d6d-8b0b-8844fc18e244",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-11T10:05:17.4779399+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-07-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-11T10:05:17.4779399+00:00",
"date_last_job": "2026-07-11T10:05:17.4779399+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-11T10:05:17.4779399+00:00",
"modified_dateutc": "2026-07-11T10:05:17.4779399+00:00",
"is_mobile_installation": true
},
"job_type_id": "95f18f5b-d2ea-4acd-acfc-9094692d59c6",
"job_type_code": "sample string 7",
"job_type": {
"id": "34fe5657-2f7b-4e0d-8ef7-7270b12890ea",
"name": "sample string 2",
"sales_organization_id": "faf04c0a-5e4b-4039-8ea4-c03e50260f7c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-11T10:05:17.4779399+00:00",
"code": "sample string 7"
},
"job_priority_id": "d4d21d3d-9006-412e-842f-d374f21cb993",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "02f71bd1-8246-4df9-b993-bcfc7614d1ff",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c135b05f-891e-4d4d-8d8f-201275090354",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5e83cf22-fec6-439d-a762-0d77af018786",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c660680-9b52-4903-94af-fdc02171b432",
"db_currency_id": "a5007198-f701-498d-9071-5d8c60d34318",
"db_language_id": "b4b844d6-65b4-4125-9465-fcadc389ad32",
"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-07-11T10:05:17.4779399+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-11T10:05:17.4779399+00:00"
},
"job_status_id": "8ab45915-9ea0-4f3f-a665-358a350a2082",
"job_status_code": "sample string 11",
"db_address_id": "7cbdca14-1e44-457f-938c-04cff4995e0e",
"contact_id": "e07840fe-8e46-4e74-b711-1588ae338679",
"requested_by_company_id": "e18a8c86-c28f-4566-9113-83fdf6cd40e1",
"requested_by_contact_id": "0d9924c9-7d68-4adc-bcf7-6d65b11b39dc",
"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-07-11T10:05:17.4779399+00:00",
"due_date": "2026-07-11T10:05:17.4779399+00:00",
"date_create": "2026-07-11T10:05:17.4779399+00:00",
"date_update": "2026-07-11T10:05:17.4779399+00:00",
"date_closed": "2026-07-11T10:05:17.4779399+00:00",
"suggested_user_id": "fb116302-7c6c-4cd3-b931-be578e492366",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8f93a307-8347-446b-ab85-0b3ec598de06",
"db_language_id": "4a563495-da30-48ff-8908-585578c0ec34",
"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-07-11T10:05:17.4779399+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "58dee52e-f38a-4c7a-b125-50eea8922f2c",
"sales_organization": {
"id": "5e83cf22-fec6-439d-a762-0d77af018786",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c660680-9b52-4903-94af-fdc02171b432",
"db_currency_id": "a5007198-f701-498d-9071-5d8c60d34318",
"db_language_id": "b4b844d6-65b4-4125-9465-fcadc389ad32",
"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-07-11T10:05:17.4779399+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "469ef166-7aa8-43eb-b362-7a4e0aab21f3",
"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": "be63bcba-b099-4b66-9f1e-c8dccc135c21",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-11T10:05:17.4779399+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c82927e2-90be-4c13-98fe-503e9b5233ca"
},
"suggested_date_start": "2026-07-11T10:05:17.4779399+00:00",
"skill_id": "845622b0-9070-47e2-abf3-433623b43cfb",
"skill_code": "sample string 32",
"skill": {
"id": "78da4209-8cc2-4262-805c-95987a3e65ed",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "77658f08-ca73-47fe-81ee-46119acd1624",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5e83cf22-fec6-439d-a762-0d77af018786",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c660680-9b52-4903-94af-fdc02171b432",
"db_currency_id": "a5007198-f701-498d-9071-5d8c60d34318",
"db_language_id": "b4b844d6-65b4-4125-9465-fcadc389ad32",
"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-07-11T10:05:17.4779399+00:00"
},
"modified_dateutc": "2026-07-11T10:05:17.4779399+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "31a7d368-a465-4b8c-bc0f-d2434ed080db",
"date_reported_by_company": "2026-07-11T10:05:17.4779399+00:00",
"id2": 36,
"company_id": "701ca72a-0bb9-4e5e-960a-314b2961fa06",
"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": "76d0f4ce-cc40-400a-b36f-8a47e282b54d",
"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-07-11T10:05:17.4779399+00:00"
},
"work_instruction_details_id": "b1d2ba98-ce4b-485d-8c3a-4d49bf176ea8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cebcdb08-32ef-4535-87bd-3a0229fef815",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f7b57700-c4be-486f-95f1-25935857d267",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-11T10:05:17.4779399+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": "48e15c32-61a8-41ce-8144-a8fb2f1e1b7e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-11T10:05:17.4779399+00:00"
}