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": "35a06d8f-5113-452b-822a-a107afefaff2",
"jobs_id": "553136a7-a699-41f8-9e02-f2e8b971e700",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5d3efc7a-112e-48b1-83ee-0fc41767816b",
"_parent_id": "fab39e48-5eab-43cf-ac03-817cbcfb2b60",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1387ab52-3ac5-46d8-805c-d42208937368",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5a66e8b0-70db-449d-b11d-46ae5885cbcc",
"_parent_id": "77754258-01cf-44c3-9daa-806db97e1f70",
"root_parent_id": "4125a2ef-0761-4349-97aa-b09eed5ec3f1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a1bdbf8d-97be-4266-b304-3d96578f0d9f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4c63eddf-fae4-4606-bb20-11f9c2d7bbdc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ea50df42-6e2a-45f9-a167-e20f6873cff2",
"_parent_code": "sample string 6",
"sales_organization_id": "ff5268a6-bd90-4861-9073-294be8a07a0a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bf56e122-cee6-46f2-9adb-0f20816bb3a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7f05725-2e55-481e-a2b1-e5edc8af5fdd",
"db_currency_id": "c666e4bb-1bdd-4bc8-90d1-552db0197922",
"db_language_id": "501f94c4-4dee-40c2-a165-828509cca32d",
"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-06T19:38:52.8344274+00:00"
},
"modified_dateutc": "2026-03-06T19:38:52.8344274+00:00"
},
"equipment_model_id": "24a27077-2f8f-4290-a388-880080c11e3d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ccfa8ab7-5a8e-4a5a-ba49-8a8dbf121ecf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "25861e4e-c55b-4494-a56f-ba25d9c1473d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9643e04f-5cea-4f09-9c0b-551838eb6498",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a6ec301f-05e7-459e-a83a-ced752eb58d2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bf56e122-cee6-46f2-9adb-0f20816bb3a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7f05725-2e55-481e-a2b1-e5edc8af5fdd",
"db_currency_id": "c666e4bb-1bdd-4bc8-90d1-552db0197922",
"db_language_id": "501f94c4-4dee-40c2-a165-828509cca32d",
"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-06T19:38:52.8344274+00:00"
},
"modified_dateutc": "2026-03-06T19:38:52.8344274+00:00"
},
"equipment_family_id": "575edcf2-1c5f-4506-97d4-b1116a6341c7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4c63eddf-fae4-4606-bb20-11f9c2d7bbdc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ea50df42-6e2a-45f9-a167-e20f6873cff2",
"_parent_code": "sample string 6",
"sales_organization_id": "ff5268a6-bd90-4861-9073-294be8a07a0a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bf56e122-cee6-46f2-9adb-0f20816bb3a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7f05725-2e55-481e-a2b1-e5edc8af5fdd",
"db_currency_id": "c666e4bb-1bdd-4bc8-90d1-552db0197922",
"db_language_id": "501f94c4-4dee-40c2-a165-828509cca32d",
"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-06T19:38:52.8344274+00:00"
},
"modified_dateutc": "2026-03-06T19:38:52.8344274+00:00"
},
"date_in_production_since": "2026-03-06T19:38:52.8344274+00:00",
"date_out_of_production_since": "2026-03-06T19:38:52.8344274+00:00",
"date_end_support": "2026-03-06T19:38:52.8344274+00:00",
"sales_organization_id": "4c5cca23-85f9-406b-948a-b04934c47d29",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "bf56e122-cee6-46f2-9adb-0f20816bb3a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7f05725-2e55-481e-a2b1-e5edc8af5fdd",
"db_currency_id": "c666e4bb-1bdd-4bc8-90d1-552db0197922",
"db_language_id": "501f94c4-4dee-40c2-a165-828509cca32d",
"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-06T19:38:52.8344274+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-06T19:38:52.8344274+00:00"
},
"project_status_id": "daf715b7-4690-4c6c-9cff-f67e1816e9fe",
"project_status_code": "sample string 10",
"project_status": {
"id": "cb2d9716-0016-42be-aaeb-acac3edf0632",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5b209f13-642f-483f-9dc9-6a431dcfb0e8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bf56e122-cee6-46f2-9adb-0f20816bb3a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7f05725-2e55-481e-a2b1-e5edc8af5fdd",
"db_currency_id": "c666e4bb-1bdd-4bc8-90d1-552db0197922",
"db_language_id": "501f94c4-4dee-40c2-a165-828509cca32d",
"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-06T19:38:52.8344274+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-06T19:38:52.8344274+00:00"
},
"company_id": "2f6adfa9-2624-481f-abd5-6f291863b1fa",
"company_code": "sample string 12",
"db_address_id": "235dec70-2f1a-4a57-92b6-94e7198f66c0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0a14d2f4-dece-4ed7-b955-9d22acf2e24c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5bb578c4-2c0d-4f98-b648-30c26146aa5e",
"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-06T19:38:52.8344274+00:00",
"date_create": "2026-03-06T19:38:52.8344274+00:00",
"date_update": "2026-03-06T19:38:52.8344274+00:00",
"updated_by_user_id": "d1ff0e57-7d78-4ab2-b787-a99d0da23295",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-06T19:38:52.8344274+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-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-06T19:38:52.8344274+00:00",
"date_last_job": "2026-03-06T19:38:52.8344274+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-06T19:38:52.8344274+00:00",
"modified_dateutc": "2026-03-06T19:38:52.8344274+00:00",
"is_mobile_installation": true
},
"job_type_id": "96717457-588e-48e6-94eb-d18c767b029e",
"job_type_code": "sample string 7",
"job_type": {
"id": "30395078-cc26-4ad1-9d54-1ad1eacda115",
"name": "sample string 2",
"sales_organization_id": "dbbc40e5-d3c5-437a-a151-363c7d9386d0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-06T19:38:52.8344274+00:00",
"code": "sample string 7"
},
"job_priority_id": "c2ac4cda-68e0-443f-8ff5-33e38878a607",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7a6d86ed-39fd-42c3-b0f8-b268d9560da2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2b93f4b4-119f-4315-9d7e-4cd80a06d1b3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bf56e122-cee6-46f2-9adb-0f20816bb3a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7f05725-2e55-481e-a2b1-e5edc8af5fdd",
"db_currency_id": "c666e4bb-1bdd-4bc8-90d1-552db0197922",
"db_language_id": "501f94c4-4dee-40c2-a165-828509cca32d",
"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-06T19:38:52.8344274+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-06T19:38:52.8344274+00:00"
},
"job_status_id": "e982d755-8631-499c-b9e4-7b8e1c437f2c",
"job_status_code": "sample string 11",
"db_address_id": "6b36fcd4-beb3-4c34-9dd7-1036f3891973",
"contact_id": "f7e447cd-3cff-4964-82fa-7afe19899603",
"requested_by_company_id": "c9ed4632-f902-405c-b25b-23f58ca71db3",
"requested_by_contact_id": "a75fe492-a5a0-41b6-a85c-801337ee0e9e",
"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-06T19:38:52.8344274+00:00",
"due_date": "2026-03-06T19:38:52.8344274+00:00",
"date_create": "2026-03-06T19:38:52.8344274+00:00",
"date_update": "2026-03-06T19:38:52.8344274+00:00",
"date_closed": "2026-03-06T19:38:52.8344274+00:00",
"suggested_user_id": "fc0c4b1f-4900-4425-8ee9-47b3d66ffd9f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6548ada5-a6c2-4b00-a94b-407e5f9268cb",
"db_language_id": "70cbe28c-151b-4387-9ba8-255b323dfad1",
"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-06T19:38:52.8344274+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "04a8cfc5-c99e-48e4-ad6e-b868d27f814e",
"sales_organization": {
"id": "bf56e122-cee6-46f2-9adb-0f20816bb3a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7f05725-2e55-481e-a2b1-e5edc8af5fdd",
"db_currency_id": "c666e4bb-1bdd-4bc8-90d1-552db0197922",
"db_language_id": "501f94c4-4dee-40c2-a165-828509cca32d",
"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-06T19:38:52.8344274+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e5b366c6-df00-4f34-acfa-feb9c2a43e0f",
"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": "cfb0f538-76a0-404a-852d-86e3dadb14b7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-06T19:38:52.8344274+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fff571b6-5778-4008-b767-986d743be194"
},
"suggested_date_start": "2026-03-06T19:38:52.8344274+00:00",
"skill_id": "7e829314-21ea-48ce-81c1-186bebae6dc7",
"skill_code": "sample string 32",
"skill": {
"id": "834a57ae-5dc3-41b8-bcaf-0040b0c9ab67",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "24a041bf-100d-467a-9c91-78a819f25af1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bf56e122-cee6-46f2-9adb-0f20816bb3a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7f05725-2e55-481e-a2b1-e5edc8af5fdd",
"db_currency_id": "c666e4bb-1bdd-4bc8-90d1-552db0197922",
"db_language_id": "501f94c4-4dee-40c2-a165-828509cca32d",
"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-06T19:38:52.8344274+00:00"
},
"modified_dateutc": "2026-03-06T19:38:52.8344274+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b39451c3-68a2-4592-827c-edf464b242c7",
"date_reported_by_company": "2026-03-06T19:38:52.8344274+00:00",
"id2": 36,
"company_id": "292c8a0b-2a00-4d39-b396-1b2e0dbfe73c",
"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": "c508f20f-2efe-43f7-b54b-dcacf4564629",
"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-06T19:38:52.8344274+00:00"
},
"work_instruction_details_id": "6c20fe13-07ee-4b47-a567-cfc3f6d8742e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fe3e9d21-d273-4d73-a4a4-bac481a6f667",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1f723d31-6d4d-4c40-82ca-7837ca1de6e0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-06T19:38:52.8344274+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": "d8571545-1078-47b8-b75a-9e69f8fea6cb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-06T19:38:52.8344274+00:00"
}