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": "99a9838e-4c50-49b6-9d79-369b36952289",
"jobs_id": "2ab501c3-8334-4c04-a7f9-c5d9b5fd0846",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b8d405f8-e1b9-4688-9153-1089226d32ba",
"_parent_id": "f7194a2b-2de4-4b3c-9e45-d04b1cd6dae0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a26eed9d-5f3d-49ff-9447-425ad5fb3b1a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c991e58c-9167-4287-a8f5-881639c185cb",
"_parent_id": "a92835c6-ac6a-4e6a-85e8-9a63687ecd01",
"root_parent_id": "c2481f41-9ecb-4b4e-98ee-6182227b1ccb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "05e1f48b-4181-4513-aa4d-b88f0b0ee641",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bde806e1-36fa-42fc-838b-1d5bb2d2b26d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "59924a22-0095-448f-b401-918f24fcccd4",
"_parent_code": "sample string 6",
"sales_organization_id": "e1980ed8-2efa-40ad-8422-eea34836a90e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2d8fa144-6bf3-4c51-b6fd-1dfc1dbcc5db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89b228ff-99ce-45f6-8fca-cad3a739ee88",
"db_currency_id": "770a115c-c37e-4799-8a30-df3bfa3b5dd2",
"db_language_id": "a1d58d52-6f73-4058-ad7b-61c84e3835c1",
"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-10-19T06:44:26.8191915+00:00"
},
"modified_dateutc": "2026-10-19T06:44:26.8191915+00:00"
},
"equipment_model_id": "c19396d8-2676-4db3-aaa9-7b478d315c7d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "89962bef-de4b-4ed3-bd42-be26a4abe6a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a05e0023-6f29-4e99-b039-a8122c899c52",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "35af2811-5af0-4597-9ca2-8942d231d6d8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bf0d777f-b8ec-4ca3-82ca-3ec720193910",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2d8fa144-6bf3-4c51-b6fd-1dfc1dbcc5db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89b228ff-99ce-45f6-8fca-cad3a739ee88",
"db_currency_id": "770a115c-c37e-4799-8a30-df3bfa3b5dd2",
"db_language_id": "a1d58d52-6f73-4058-ad7b-61c84e3835c1",
"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-10-19T06:44:26.8191915+00:00"
},
"modified_dateutc": "2026-10-19T06:44:26.8191915+00:00"
},
"equipment_family_id": "8bd934b0-2989-4cf7-abe7-c05a30f03fa7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bde806e1-36fa-42fc-838b-1d5bb2d2b26d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "59924a22-0095-448f-b401-918f24fcccd4",
"_parent_code": "sample string 6",
"sales_organization_id": "e1980ed8-2efa-40ad-8422-eea34836a90e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2d8fa144-6bf3-4c51-b6fd-1dfc1dbcc5db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89b228ff-99ce-45f6-8fca-cad3a739ee88",
"db_currency_id": "770a115c-c37e-4799-8a30-df3bfa3b5dd2",
"db_language_id": "a1d58d52-6f73-4058-ad7b-61c84e3835c1",
"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-10-19T06:44:26.8191915+00:00"
},
"modified_dateutc": "2026-10-19T06:44:26.8191915+00:00"
},
"date_in_production_since": "2026-10-19T06:44:26.8191915+00:00",
"date_out_of_production_since": "2026-10-19T06:44:26.8191915+00:00",
"date_end_support": "2026-10-19T06:44:26.8191915+00:00",
"sales_organization_id": "903ebfbb-2968-4609-9cfc-7dc7ba353e60",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2d8fa144-6bf3-4c51-b6fd-1dfc1dbcc5db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89b228ff-99ce-45f6-8fca-cad3a739ee88",
"db_currency_id": "770a115c-c37e-4799-8a30-df3bfa3b5dd2",
"db_language_id": "a1d58d52-6f73-4058-ad7b-61c84e3835c1",
"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-10-19T06:44:26.8191915+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-10-19T06:44:26.8191915+00:00"
},
"project_status_id": "41d6937a-ac8f-45b7-bdb1-e24d22c217f3",
"project_status_code": "sample string 10",
"project_status": {
"id": "bddb8443-2d64-45f6-a866-af9570661948",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "596af957-d231-4be4-abb2-4c54677ff76d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2d8fa144-6bf3-4c51-b6fd-1dfc1dbcc5db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89b228ff-99ce-45f6-8fca-cad3a739ee88",
"db_currency_id": "770a115c-c37e-4799-8a30-df3bfa3b5dd2",
"db_language_id": "a1d58d52-6f73-4058-ad7b-61c84e3835c1",
"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-10-19T06:44:26.8191915+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-19T06:44:26.8377157+00:00"
},
"company_id": "e5bc9fc3-6fa7-42bc-816c-8fdc9bf8c5a8",
"company_code": "sample string 12",
"db_address_id": "49c35d86-32a1-4c4f-9869-0e0832f073d6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a3ab0986-1a50-41cf-bde4-41eb240b932c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a0e4e31f-bafb-47f1-97ec-bd6691551f5d",
"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-10-19T06:44:26.8377157+00:00",
"date_create": "2026-10-19T06:44:26.8377157+00:00",
"date_update": "2026-10-19T06:44:26.8377157+00:00",
"updated_by_user_id": "c3f7591c-734e-4c85-acce-221015d388ee",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-19T06:44:26.8377157+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-10-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-19T06:44:26.8377157+00:00",
"date_last_job": "2026-10-19T06:44:26.8377157+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-19T06:44:26.8377157+00:00",
"modified_dateutc": "2026-10-19T06:44:26.8377157+00:00",
"is_mobile_installation": true
},
"job_type_id": "212bf5e8-db21-4b9d-b40a-5be9f74b9edd",
"job_type_code": "sample string 7",
"job_type": {
"id": "11fad106-00e4-4b81-9850-402a03b74edb",
"name": "sample string 2",
"sales_organization_id": "a3c39b5d-45f6-49e2-b74b-858b9f46bd98",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-19T06:44:26.8377157+00:00",
"code": "sample string 7"
},
"job_priority_id": "8f6ef924-f0ad-41aa-8517-916713fb9233",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fdde7a5e-2c92-4af6-aec3-bddf9073556b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "37ed8535-f740-4306-b9c3-680c6e2da250",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2d8fa144-6bf3-4c51-b6fd-1dfc1dbcc5db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89b228ff-99ce-45f6-8fca-cad3a739ee88",
"db_currency_id": "770a115c-c37e-4799-8a30-df3bfa3b5dd2",
"db_language_id": "a1d58d52-6f73-4058-ad7b-61c84e3835c1",
"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-10-19T06:44:26.8191915+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-19T06:44:26.8377157+00:00"
},
"job_status_id": "6af8b9af-5bf3-462c-bc10-f50556ff3049",
"job_status_code": "sample string 11",
"db_address_id": "84063a23-d315-4ca8-9e5a-9531853a3545",
"contact_id": "a7caf409-7458-4a9f-aedc-8182efe37399",
"requested_by_company_id": "3dc3f95d-ca94-4022-a5be-5d112b24be90",
"requested_by_contact_id": "4087631a-5ddd-47c8-aa29-f2b54c1f3aa0",
"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-10-19T06:44:26.8377157+00:00",
"due_date": "2026-10-19T06:44:26.8377157+00:00",
"date_create": "2026-10-19T06:44:26.8377157+00:00",
"date_update": "2026-10-19T06:44:26.8377157+00:00",
"date_closed": "2026-10-19T06:44:26.8377157+00:00",
"suggested_user_id": "1f72c407-82bd-4bb2-bca9-a6a5c04db3d7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "13dc4a85-c3bb-4f08-90f2-46aa3806ceda",
"db_language_id": "03b1d4bd-9c7e-40f3-a7d4-0dbbb27860a6",
"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-10-19T06:44:26.8377157+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "30c57113-bcec-4869-abb1-7c791ce77b9e",
"sales_organization": {
"id": "2d8fa144-6bf3-4c51-b6fd-1dfc1dbcc5db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89b228ff-99ce-45f6-8fca-cad3a739ee88",
"db_currency_id": "770a115c-c37e-4799-8a30-df3bfa3b5dd2",
"db_language_id": "a1d58d52-6f73-4058-ad7b-61c84e3835c1",
"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-10-19T06:44:26.8191915+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "442c2899-7587-4893-993e-6b10a60142f4",
"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": "7c1b9849-c6c0-4e0e-900d-5ca6bdb7f558",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-19T06:44:26.8377157+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "24101ff7-48b0-4b50-8f12-3b61a28f99ed"
},
"suggested_date_start": "2026-10-19T06:44:26.8377157+00:00",
"skill_id": "bbaea15c-a1b7-44f3-8db8-c250c1388970",
"skill_code": "sample string 32",
"skill": {
"id": "e115de13-c91e-4ac2-9d30-1a515ea18554",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f47f4daa-6728-4ae4-9e53-a04caf0bd15b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2d8fa144-6bf3-4c51-b6fd-1dfc1dbcc5db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89b228ff-99ce-45f6-8fca-cad3a739ee88",
"db_currency_id": "770a115c-c37e-4799-8a30-df3bfa3b5dd2",
"db_language_id": "a1d58d52-6f73-4058-ad7b-61c84e3835c1",
"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-10-19T06:44:26.8191915+00:00"
},
"modified_dateutc": "2026-10-19T06:44:26.8377157+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "16c2bede-9179-401f-a11f-023df414701c",
"date_reported_by_company": "2026-10-19T06:44:26.8377157+00:00",
"id2": 36,
"company_id": "d76a372e-d71b-40fb-ac01-3a0a6d34b70f",
"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": "77f3b113-696a-4efe-9e9c-1e7eb61f870a",
"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-10-19T06:44:26.8377157+00:00"
},
"work_instruction_details_id": "7bfa6a36-f39c-4219-a638-045f02d3c8ff",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "369eebb2-581c-4dcb-910a-e200b593d4c4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0d4d2b8b-4295-41d9-aca0-bb9d6a768098",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-19T06:44:26.8377157+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": "c30ccccd-3b02-4eee-ab3a-6a6cf9140ef2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-19T06:44:26.8377157+00:00"
}