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": "d9258312-ac9a-4507-97fe-03673c936fcc",
"jobs_id": "599ceffa-87c7-4dbc-af82-7e57d24b3b8b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9685e6f6-2147-4b2c-93ca-df5c48f29a5c",
"_parent_id": "df6c87d4-6445-4ef9-894a-cce132195848",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1adada1c-1ba3-4ba0-a8bb-9eb816a111f3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cd5bcfd0-593a-4027-a0c9-bb29f26446db",
"_parent_id": "f5373294-582b-4fc0-b09e-9d110353661b",
"root_parent_id": "54073259-58ff-4190-ab99-5604e4970439",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e653281b-c5ea-405e-aae8-7afefdec17d5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b6cab3a9-24c8-45a5-8290-682bc057f7dc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a234f7f5-b446-4e97-9131-2aa43f420191",
"_parent_code": "sample string 6",
"sales_organization_id": "1af094a5-87eb-4f38-9491-d41c34b55d4e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8495f142-39bb-48b4-860e-dd73e2cc87fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89572c0d-5e28-4b5f-a324-c3461e270432",
"db_currency_id": "a2e505e7-5b66-4a7d-a824-7186ece41a0c",
"db_language_id": "b624e6f6-be6c-4394-9107-fb4e29651d6e",
"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-06-19T01:52:04.8740357+00:00"
},
"modified_dateutc": "2026-06-19T01:52:04.8740357+00:00"
},
"equipment_model_id": "f5f22d34-878a-4252-b8aa-c4dbee1e6813",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e4f7fb85-62bd-46df-ae31-804aa406049f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2da767fc-3b1f-43cc-b7f9-14b0a61ba964",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "21bedd7b-93f9-459b-bac9-c9cbf1ac4f21",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "55784b41-80f1-44ed-8bda-f9eafef09704",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8495f142-39bb-48b4-860e-dd73e2cc87fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89572c0d-5e28-4b5f-a324-c3461e270432",
"db_currency_id": "a2e505e7-5b66-4a7d-a824-7186ece41a0c",
"db_language_id": "b624e6f6-be6c-4394-9107-fb4e29651d6e",
"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-06-19T01:52:04.8740357+00:00"
},
"modified_dateutc": "2026-06-19T01:52:04.8740357+00:00"
},
"equipment_family_id": "1c7f4142-38c1-41e4-a6c8-73a3f43ebde2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b6cab3a9-24c8-45a5-8290-682bc057f7dc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a234f7f5-b446-4e97-9131-2aa43f420191",
"_parent_code": "sample string 6",
"sales_organization_id": "1af094a5-87eb-4f38-9491-d41c34b55d4e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8495f142-39bb-48b4-860e-dd73e2cc87fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89572c0d-5e28-4b5f-a324-c3461e270432",
"db_currency_id": "a2e505e7-5b66-4a7d-a824-7186ece41a0c",
"db_language_id": "b624e6f6-be6c-4394-9107-fb4e29651d6e",
"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-06-19T01:52:04.8740357+00:00"
},
"modified_dateutc": "2026-06-19T01:52:04.8740357+00:00"
},
"date_in_production_since": "2026-06-19T01:52:04.8740357+00:00",
"date_out_of_production_since": "2026-06-19T01:52:04.8740357+00:00",
"date_end_support": "2026-06-19T01:52:04.8740357+00:00",
"sales_organization_id": "e7c3de3c-b0ec-4782-b940-980c3b1c3d67",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8495f142-39bb-48b4-860e-dd73e2cc87fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89572c0d-5e28-4b5f-a324-c3461e270432",
"db_currency_id": "a2e505e7-5b66-4a7d-a824-7186ece41a0c",
"db_language_id": "b624e6f6-be6c-4394-9107-fb4e29651d6e",
"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-06-19T01:52:04.8740357+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-06-19T01:52:04.8740357+00:00"
},
"project_status_id": "031e5225-ee46-4031-a4e2-e97fb88d7d65",
"project_status_code": "sample string 10",
"project_status": {
"id": "bf92205c-2a1d-42f6-a084-e7e075f63755",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c0862c7e-9f79-477c-ba03-105b306ac4b5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8495f142-39bb-48b4-860e-dd73e2cc87fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89572c0d-5e28-4b5f-a324-c3461e270432",
"db_currency_id": "a2e505e7-5b66-4a7d-a824-7186ece41a0c",
"db_language_id": "b624e6f6-be6c-4394-9107-fb4e29651d6e",
"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-06-19T01:52:04.8740357+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-19T01:52:04.8740357+00:00"
},
"company_id": "bc78bcb6-7eb2-410d-8562-6ef1160e3db8",
"company_code": "sample string 12",
"db_address_id": "53d872e3-a04a-4dbc-bf1b-564e784d4296",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e2cee995-4dc2-4bcd-bb73-d5b7bf9961a2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "41863e7d-a242-4d91-a66e-2d4576b0ca74",
"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-06-19T01:52:04.8740357+00:00",
"date_create": "2026-06-19T01:52:04.8740357+00:00",
"date_update": "2026-06-19T01:52:04.8740357+00:00",
"updated_by_user_id": "8655f570-7429-4741-841d-444cc4f84d46",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-19T01:52:04.8740357+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-06-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-19T01:52:04.8740357+00:00",
"date_last_job": "2026-06-19T01:52:04.8740357+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-19T01:52:04.8740357+00:00",
"modified_dateutc": "2026-06-19T01:52:04.8740357+00:00",
"is_mobile_installation": true
},
"job_type_id": "77e75693-f3e0-4ea4-a02c-01d61e8a51b5",
"job_type_code": "sample string 7",
"job_type": {
"id": "71571a08-e81c-4b29-8ec8-71424e423867",
"name": "sample string 2",
"sales_organization_id": "2c6b99b6-34bd-4700-97f1-5191a8e4a814",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-19T01:52:04.8740357+00:00",
"code": "sample string 7"
},
"job_priority_id": "db1d4778-bfa1-461a-92e4-4d2afadbf7fa",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "032d8e5d-8f0c-4c99-926b-f011af30b308",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1d802017-c30e-44a2-9e17-9d82c535cacd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8495f142-39bb-48b4-860e-dd73e2cc87fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89572c0d-5e28-4b5f-a324-c3461e270432",
"db_currency_id": "a2e505e7-5b66-4a7d-a824-7186ece41a0c",
"db_language_id": "b624e6f6-be6c-4394-9107-fb4e29651d6e",
"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-06-19T01:52:04.8740357+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-19T01:52:04.8740357+00:00"
},
"job_status_id": "c042846a-035c-4345-b124-9566c6e1c9b3",
"job_status_code": "sample string 11",
"db_address_id": "425612c9-083e-4a80-b447-c62fb8b43e8f",
"contact_id": "4c7123a1-6eff-4fbe-b4d2-d5391c43a40d",
"requested_by_company_id": "4e708049-d032-40dd-a632-92707232633d",
"requested_by_contact_id": "2d4caf8b-4cf1-429f-bfa3-e99e4f440050",
"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-06-19T01:52:04.8740357+00:00",
"due_date": "2026-06-19T01:52:04.8740357+00:00",
"date_create": "2026-06-19T01:52:04.8740357+00:00",
"date_update": "2026-06-19T01:52:04.8740357+00:00",
"date_closed": "2026-06-19T01:52:04.8740357+00:00",
"suggested_user_id": "daa96e7e-b294-4211-9ac2-20593efceb5f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a2239575-2351-414a-94c2-4aa363ccddf9",
"db_language_id": "7e9e506c-28f2-4788-a76a-4b2d2ffe4aab",
"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-06-19T01:52:04.8740357+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9d02a742-4b02-4a09-8b8b-36e76069d8ce",
"sales_organization": {
"id": "8495f142-39bb-48b4-860e-dd73e2cc87fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89572c0d-5e28-4b5f-a324-c3461e270432",
"db_currency_id": "a2e505e7-5b66-4a7d-a824-7186ece41a0c",
"db_language_id": "b624e6f6-be6c-4394-9107-fb4e29651d6e",
"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-06-19T01:52:04.8740357+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f8248358-bf23-490c-834d-1d7e8122916c",
"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": "4aea5adc-1e42-4902-97d8-67e74755731a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-19T01:52:04.8740357+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "43a176b2-8d3c-4f95-ade8-813ae0b271b0"
},
"suggested_date_start": "2026-06-19T01:52:04.8740357+00:00",
"skill_id": "f2bd90b7-7193-46df-88cd-20048d54a77b",
"skill_code": "sample string 32",
"skill": {
"id": "496709cc-c364-4b04-8b41-88ea7d14323d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "76640998-e7a2-4a93-bfe2-247a2feffadb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8495f142-39bb-48b4-860e-dd73e2cc87fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89572c0d-5e28-4b5f-a324-c3461e270432",
"db_currency_id": "a2e505e7-5b66-4a7d-a824-7186ece41a0c",
"db_language_id": "b624e6f6-be6c-4394-9107-fb4e29651d6e",
"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-06-19T01:52:04.8740357+00:00"
},
"modified_dateutc": "2026-06-19T01:52:04.8740357+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a3560e44-85c8-42c9-a55f-37c293896d64",
"date_reported_by_company": "2026-06-19T01:52:04.8740357+00:00",
"id2": 36,
"company_id": "abbda942-7fec-4ccf-bd6e-6f28534fe426",
"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": "e9d57599-d00f-4395-ad12-4464823b57af",
"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-06-19T01:52:04.8740357+00:00"
},
"work_instruction_details_id": "b603517a-ec74-4c1d-b5aa-f71bcd59eb6c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4e2c3130-1966-48ac-a0cf-00909b012833",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "130b2151-2815-45c1-b90d-c6392f66967b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-19T01:52:04.8740357+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": "54e4d0a4-f937-4d9c-96d3-318b8b3dbd42",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-19T01:52:04.8740357+00:00"
}