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": "e1792de5-ecaa-4a41-8f3d-d144bbf0f5b0",
"jobs_id": "053c9e71-2ede-48a8-86f5-741fac8d1cd3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ad4bab27-8d5c-48b4-a10a-57121b72f481",
"_parent_id": "215b32ca-86e4-488e-b740-c1e404b014a9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ec7fd7f8-ef7c-47f2-90ac-73acb0e4e2a5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "030a2b67-ec3b-48b2-bb44-ad6acf6e58f9",
"_parent_id": "e76e0469-babb-4b8c-85b7-70aa94d340d0",
"root_parent_id": "6d3532e2-7539-4fbc-848b-2ffae44089fd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "18d3e608-5357-4fd3-8275-02c2196e80ff",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9cd3d39c-4166-4bc8-b7ed-f449e3a15e23",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c05d699b-292d-436f-aee2-d0d2ccd65c2c",
"_parent_code": "sample string 6",
"sales_organization_id": "b298ee7d-5b0b-4ef9-a61f-1d01ee35e3de",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "12b7844b-4206-4d83-8ace-a4b403237bd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "953f2b49-804d-4c41-b2f6-099ca925a2a3",
"db_currency_id": "8e53e301-fb52-485d-9ade-1526133fc402",
"db_language_id": "7cb7495c-e111-4cd1-83b4-bb7e4db79339",
"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-03-19T22:56:23.8936406+00:00"
},
"modified_dateutc": "2026-03-19T22:56:23.8936406+00:00"
},
"equipment_model_id": "c633e108-c981-45ea-8a15-6e187f770979",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6576d126-e079-418d-85ae-987c3326d861",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "56f8c281-cb97-4ea9-9389-c16077bbc49c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0da987c6-68fe-4ab0-809d-5785a7cb1808",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "337c1207-ce29-4acc-8a7b-55be0d0d30aa",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "12b7844b-4206-4d83-8ace-a4b403237bd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "953f2b49-804d-4c41-b2f6-099ca925a2a3",
"db_currency_id": "8e53e301-fb52-485d-9ade-1526133fc402",
"db_language_id": "7cb7495c-e111-4cd1-83b4-bb7e4db79339",
"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-03-19T22:56:23.8936406+00:00"
},
"modified_dateutc": "2026-03-19T22:56:23.8936406+00:00"
},
"equipment_family_id": "768a9df8-1a03-4f77-acbf-f1d90e0f1055",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9cd3d39c-4166-4bc8-b7ed-f449e3a15e23",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c05d699b-292d-436f-aee2-d0d2ccd65c2c",
"_parent_code": "sample string 6",
"sales_organization_id": "b298ee7d-5b0b-4ef9-a61f-1d01ee35e3de",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "12b7844b-4206-4d83-8ace-a4b403237bd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "953f2b49-804d-4c41-b2f6-099ca925a2a3",
"db_currency_id": "8e53e301-fb52-485d-9ade-1526133fc402",
"db_language_id": "7cb7495c-e111-4cd1-83b4-bb7e4db79339",
"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-03-19T22:56:23.8936406+00:00"
},
"modified_dateutc": "2026-03-19T22:56:23.8936406+00:00"
},
"date_in_production_since": "2026-03-19T22:56:23.8936406+00:00",
"date_out_of_production_since": "2026-03-19T22:56:23.8936406+00:00",
"date_end_support": "2026-03-19T22:56:23.8936406+00:00",
"sales_organization_id": "73657a12-bc3d-4f7d-8727-6b1f21d1f36f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "12b7844b-4206-4d83-8ace-a4b403237bd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "953f2b49-804d-4c41-b2f6-099ca925a2a3",
"db_currency_id": "8e53e301-fb52-485d-9ade-1526133fc402",
"db_language_id": "7cb7495c-e111-4cd1-83b4-bb7e4db79339",
"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-03-19T22:56:23.8936406+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-03-19T22:56:23.8936406+00:00"
},
"project_status_id": "93830774-e54d-4926-b7c2-1844388d4140",
"project_status_code": "sample string 10",
"project_status": {
"id": "686598a5-a7ae-4b14-9453-54eaff6e9b20",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "21d083f1-71c7-4998-a3d4-d5be10fd8170",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "12b7844b-4206-4d83-8ace-a4b403237bd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "953f2b49-804d-4c41-b2f6-099ca925a2a3",
"db_currency_id": "8e53e301-fb52-485d-9ade-1526133fc402",
"db_language_id": "7cb7495c-e111-4cd1-83b4-bb7e4db79339",
"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-03-19T22:56:23.8936406+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-19T22:56:23.8936406+00:00"
},
"company_id": "ad46a75e-f8f1-417a-b1e9-8c8c60c4d9b3",
"company_code": "sample string 12",
"db_address_id": "6fa1666a-2397-45a8-ad69-1887d93638ab",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cadb7d04-098e-4a92-8b44-5d8e3d60ce1c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f78a659a-2621-46ef-9968-2c81da6558e2",
"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-03-19T22:56:23.8936406+00:00",
"date_create": "2026-03-19T22:56:23.8936406+00:00",
"date_update": "2026-03-19T22:56:23.8936406+00:00",
"updated_by_user_id": "17152478-4285-490b-a628-58eeecfcbb56",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-19T22:56:23.8936406+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-03-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-19T22:56:23.8936406+00:00",
"date_last_job": "2026-03-19T22:56:23.8936406+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-19T22:56:23.8936406+00:00",
"modified_dateutc": "2026-03-19T22:56:23.8936406+00:00",
"is_mobile_installation": true
},
"job_type_id": "a7e502ae-a1d2-400f-b25b-02ec2b7d2127",
"job_type_code": "sample string 7",
"job_type": {
"id": "8a3389e8-2b22-4956-8931-6b1a9a68b38b",
"name": "sample string 2",
"sales_organization_id": "3a00b4a5-30d1-43e8-9b2a-ff3386c1bdcb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-19T22:56:23.8936406+00:00",
"code": "sample string 7"
},
"job_priority_id": "843f4916-683f-4a32-837b-f949257702e4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0982ebd2-252d-4e0c-b39d-8a283ef7f13d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f5841147-ada9-432e-890f-22fb2006d5a9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "12b7844b-4206-4d83-8ace-a4b403237bd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "953f2b49-804d-4c41-b2f6-099ca925a2a3",
"db_currency_id": "8e53e301-fb52-485d-9ade-1526133fc402",
"db_language_id": "7cb7495c-e111-4cd1-83b4-bb7e4db79339",
"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-03-19T22:56:23.8936406+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-19T22:56:23.8936406+00:00"
},
"job_status_id": "a4701576-32e8-44a1-840d-126ce3535b0a",
"job_status_code": "sample string 11",
"db_address_id": "19857ef9-d86b-4b95-8272-32573cf62839",
"contact_id": "f3b8b7c2-f928-4ca0-b391-45537ee7bf1a",
"requested_by_company_id": "264a7f47-2c4e-4161-9ec9-8433c92c4314",
"requested_by_contact_id": "60a9555a-511a-4303-9967-fa709f94201c",
"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-03-19T22:56:23.8936406+00:00",
"due_date": "2026-03-19T22:56:23.8936406+00:00",
"date_create": "2026-03-19T22:56:23.8936406+00:00",
"date_update": "2026-03-19T22:56:23.8936406+00:00",
"date_closed": "2026-03-19T22:56:23.8936406+00:00",
"suggested_user_id": "f068ffb1-2f1a-479f-8673-d1b3f0318e52",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "64dd6d07-c6d3-4014-84e5-8e18025e1102",
"db_language_id": "85524d38-70a5-4f66-aca7-a0e3b4599168",
"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-03-19T22:56:23.8936406+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9a292e24-5d3d-4667-a71e-f3f7ed93c2f8",
"sales_organization": {
"id": "12b7844b-4206-4d83-8ace-a4b403237bd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "953f2b49-804d-4c41-b2f6-099ca925a2a3",
"db_currency_id": "8e53e301-fb52-485d-9ade-1526133fc402",
"db_language_id": "7cb7495c-e111-4cd1-83b4-bb7e4db79339",
"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-03-19T22:56:23.8936406+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "984cffe1-fba5-4250-8c47-733b6b0a8272",
"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": "b019b45a-5ba3-403f-826e-19ffbe5950be",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-19T22:56:23.8936406+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b4170025-bb8a-4792-b776-5250b1fe5748"
},
"suggested_date_start": "2026-03-19T22:56:23.8936406+00:00",
"skill_id": "025531ab-46bd-4abc-a984-cfe0542547d6",
"skill_code": "sample string 32",
"skill": {
"id": "70c923bc-19f4-41c2-82cd-a56fdf959bdf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "58ac638d-65bd-4d5a-adc7-d0ad33635244",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "12b7844b-4206-4d83-8ace-a4b403237bd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "953f2b49-804d-4c41-b2f6-099ca925a2a3",
"db_currency_id": "8e53e301-fb52-485d-9ade-1526133fc402",
"db_language_id": "7cb7495c-e111-4cd1-83b4-bb7e4db79339",
"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-03-19T22:56:23.8936406+00:00"
},
"modified_dateutc": "2026-03-19T22:56:23.8936406+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "017010f5-b829-4a71-80ee-bbcd986ad7d8",
"date_reported_by_company": "2026-03-19T22:56:23.8936406+00:00",
"id2": 36,
"company_id": "45086934-1d4c-4eae-afec-3a24f2779c8b",
"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": "04142357-4a55-4150-9c7d-4c374761aeb7",
"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-03-19T22:56:23.8936406+00:00"
},
"work_instruction_details_id": "33f797a2-aee1-4a02-b16b-438c60cc3b6e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "011b0855-39c2-4cee-ba3b-e89e2b752359",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bb81c4a2-e5be-4053-b9a7-64d1d13f1203",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-19T22:56:23.8936406+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": "ad0612f2-4f4e-4444-abc0-4bd0958ed2bd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-19T22:56:23.8936406+00:00"
}