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": "8dcdc01b-20dd-49d4-9aa6-0e0f5549ea39",
"jobs_id": "6a32629b-2e5e-4aef-8e46-10dadbf0bd14",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7da78437-5d81-4232-8318-0bac95c2d221",
"_parent_id": "ac2edf69-a55a-4725-8f0f-66ba20906e68",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "109b8697-9c7b-405b-9258-85df901afe7c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2df32d5e-6247-4df9-9608-7b4f5317fbf2",
"_parent_id": "7710bd69-c8cd-4b1a-88c8-7d8122761bdf",
"root_parent_id": "d8c99a08-12d9-42a7-b982-cdf413fee9b6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1750870c-649d-4887-86b9-01ebfb2b331f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f4f15caa-de41-49c4-8b55-5a7c5b163695",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "abce6e63-6062-4e69-93e2-eea584678791",
"_parent_code": "sample string 6",
"sales_organization_id": "2a87cc5f-48dc-4cce-bdad-6986834fd0b3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a2bd5fae-4d5f-46f0-8593-c180c097d5aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f3326a4-86fb-4179-a1b6-2bc6522c38ec",
"db_currency_id": "c885e02c-058d-453d-82f3-2bc094d3df4a",
"db_language_id": "c01a9969-a6f6-4b3d-ad43-780a3daf9b4b",
"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-05T19:48:57.4337027+00:00"
},
"modified_dateutc": "2026-09-05T19:48:57.4337027+00:00"
},
"equipment_model_id": "53cd4f4c-ac8f-453d-a975-ebf6b54b10e1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a85f83b6-800e-40fc-ab75-fc2eebe1f4af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a346d0d0-763e-4f39-8a40-aa82d7f96678",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c3e3f478-43f5-4a16-81e5-f0496eafa2af",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "99039d82-c461-4101-9fcb-bead2f62be69",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a2bd5fae-4d5f-46f0-8593-c180c097d5aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f3326a4-86fb-4179-a1b6-2bc6522c38ec",
"db_currency_id": "c885e02c-058d-453d-82f3-2bc094d3df4a",
"db_language_id": "c01a9969-a6f6-4b3d-ad43-780a3daf9b4b",
"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-05T19:48:57.4337027+00:00"
},
"modified_dateutc": "2026-09-05T19:48:57.4337027+00:00"
},
"equipment_family_id": "06c64d2b-63f7-4842-9629-e58989d9543f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f4f15caa-de41-49c4-8b55-5a7c5b163695",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "abce6e63-6062-4e69-93e2-eea584678791",
"_parent_code": "sample string 6",
"sales_organization_id": "2a87cc5f-48dc-4cce-bdad-6986834fd0b3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a2bd5fae-4d5f-46f0-8593-c180c097d5aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f3326a4-86fb-4179-a1b6-2bc6522c38ec",
"db_currency_id": "c885e02c-058d-453d-82f3-2bc094d3df4a",
"db_language_id": "c01a9969-a6f6-4b3d-ad43-780a3daf9b4b",
"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-05T19:48:57.4337027+00:00"
},
"modified_dateutc": "2026-09-05T19:48:57.4337027+00:00"
},
"date_in_production_since": "2026-09-05T19:48:57.4337027+00:00",
"date_out_of_production_since": "2026-09-05T19:48:57.4337027+00:00",
"date_end_support": "2026-09-05T19:48:57.4337027+00:00",
"sales_organization_id": "cfc8d205-015f-4fab-8a40-5eaa6c5cd28b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a2bd5fae-4d5f-46f0-8593-c180c097d5aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f3326a4-86fb-4179-a1b6-2bc6522c38ec",
"db_currency_id": "c885e02c-058d-453d-82f3-2bc094d3df4a",
"db_language_id": "c01a9969-a6f6-4b3d-ad43-780a3daf9b4b",
"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-05T19:48:57.4337027+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-05T19:48:57.4337027+00:00"
},
"project_status_id": "adb7d757-2f95-46f5-8ec4-214df043f137",
"project_status_code": "sample string 10",
"project_status": {
"id": "2e8db147-87a1-4cff-b9a5-6799eaf8cc86",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4d197a41-0090-4102-9a0b-8de801cfba00",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2bd5fae-4d5f-46f0-8593-c180c097d5aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f3326a4-86fb-4179-a1b6-2bc6522c38ec",
"db_currency_id": "c885e02c-058d-453d-82f3-2bc094d3df4a",
"db_language_id": "c01a9969-a6f6-4b3d-ad43-780a3daf9b4b",
"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-05T19:48:57.4337027+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-05T19:48:57.4337027+00:00"
},
"company_id": "cbab1a66-d9d7-4971-89b0-e2dac35b1010",
"company_code": "sample string 12",
"db_address_id": "a8a34f36-c28f-4853-a38d-0084e2d978ad",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "bf2853ee-6267-45f3-986a-8076d72a3cd5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bd926a18-d9e1-46b8-a02d-dcbe151e6f60",
"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-05T19:48:57.4337027+00:00",
"date_create": "2026-09-05T19:48:57.4337027+00:00",
"date_update": "2026-09-05T19:48:57.4337027+00:00",
"updated_by_user_id": "42965afb-2faf-4467-9748-f90ffbbd8292",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-05T19:48:57.4337027+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-05T19:48:57.4337027+00:00",
"date_last_job": "2026-09-05T19:48:57.4337027+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-05T19:48:57.4337027+00:00",
"modified_dateutc": "2026-09-05T19:48:57.4337027+00:00",
"is_mobile_installation": true
},
"job_type_id": "43343991-d609-4c16-b56a-80aeb1314922",
"job_type_code": "sample string 7",
"job_type": {
"id": "683ff201-d61b-4cc2-aeb1-e856662fff70",
"name": "sample string 2",
"sales_organization_id": "4a8e0fd5-af6e-43c0-987c-a96c743fab2d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-05T19:48:57.4337027+00:00",
"code": "sample string 7"
},
"job_priority_id": "0eaa18e8-4d08-41f6-bd3e-ab3a6778e18a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "01dd8097-e9b5-4124-83e3-f89728536482",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "46073d94-dd8c-4cc8-be61-8f83a4bcea3e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2bd5fae-4d5f-46f0-8593-c180c097d5aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f3326a4-86fb-4179-a1b6-2bc6522c38ec",
"db_currency_id": "c885e02c-058d-453d-82f3-2bc094d3df4a",
"db_language_id": "c01a9969-a6f6-4b3d-ad43-780a3daf9b4b",
"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-05T19:48:57.4337027+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-05T19:48:57.4337027+00:00"
},
"job_status_id": "39a57fbe-123c-472b-b4f5-184238c32cc8",
"job_status_code": "sample string 11",
"db_address_id": "96ac8a59-4028-4d5f-8759-5f590be561d4",
"contact_id": "1516fd67-4869-4000-8e9e-9db263aedaee",
"requested_by_company_id": "30bee03e-b9c5-43c3-8aaf-1f085b5729d6",
"requested_by_contact_id": "7e917188-30e0-4b7b-8cc6-19050bb75b87",
"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-05T19:48:57.4337027+00:00",
"due_date": "2026-09-05T19:48:57.4337027+00:00",
"date_create": "2026-09-05T19:48:57.4337027+00:00",
"date_update": "2026-09-05T19:48:57.4337027+00:00",
"date_closed": "2026-09-05T19:48:57.4337027+00:00",
"suggested_user_id": "b8c3b504-440a-46f0-b4e9-c908d9cde1e3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5c33b296-6f9e-407a-bd23-257d8fba2bb5",
"db_language_id": "bb671548-6bd4-47ea-a677-a9ad1a8f84eb",
"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-05T19:48:57.4337027+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "efd06b4e-ee8c-4ed4-a9b8-3fc269353f19",
"sales_organization": {
"id": "a2bd5fae-4d5f-46f0-8593-c180c097d5aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f3326a4-86fb-4179-a1b6-2bc6522c38ec",
"db_currency_id": "c885e02c-058d-453d-82f3-2bc094d3df4a",
"db_language_id": "c01a9969-a6f6-4b3d-ad43-780a3daf9b4b",
"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-05T19:48:57.4337027+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e4b5d8dd-e7dd-43c1-bb37-be9cbf26c991",
"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": "6b3463f1-97d3-40bc-86b6-8ca6489fdea2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-05T19:48:57.4337027+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "cfae8fee-f1c4-45bf-8471-061734b9f1e5"
},
"suggested_date_start": "2026-09-05T19:48:57.4337027+00:00",
"skill_id": "ded76f91-bb7b-4920-9a14-d74f4b1d8da6",
"skill_code": "sample string 32",
"skill": {
"id": "62f63fb0-e20c-4647-b9e2-42a5462d3a1e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f37b1072-4404-4f0b-9dad-f3cdef8c77d3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2bd5fae-4d5f-46f0-8593-c180c097d5aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f3326a4-86fb-4179-a1b6-2bc6522c38ec",
"db_currency_id": "c885e02c-058d-453d-82f3-2bc094d3df4a",
"db_language_id": "c01a9969-a6f6-4b3d-ad43-780a3daf9b4b",
"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-05T19:48:57.4337027+00:00"
},
"modified_dateutc": "2026-09-05T19:48:57.4337027+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9f396af8-078b-4cdf-a259-20acf882880a",
"date_reported_by_company": "2026-09-05T19:48:57.4337027+00:00",
"id2": 36,
"company_id": "782a57a0-d25a-480b-971a-4c280308be5f",
"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": "78bbcdf0-1184-45d3-b481-4476ee2fa7d8",
"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-05T19:48:57.4337027+00:00"
},
"work_instruction_details_id": "2d4db75e-0801-48f7-aff8-748fed755f13",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3155b440-1c79-4608-a089-d2d586abb9cb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "75baedc8-de7f-4b81-98d7-f3f38d91cdd0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-05T19:48:57.4337027+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": "3e006048-4b60-4745-8175-dad928b127f7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-05T19:48:57.4337027+00:00"
}