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": "c5c18ec7-b579-4947-8ce2-3afc96649c46",
"jobs_id": "2c497376-7f65-4c33-a0c1-0dae6f46ae61",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "43ae67c1-521a-4d5b-8b1f-76fc1ad844d7",
"_parent_id": "19c56f22-2d8b-4545-bb62-7920591f9dd9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "84683789-8649-41da-baaa-abc4d4c17b11",
"project_reference_back_office": "sample string 5",
"project": {
"id": "35677a42-c0c0-4d3d-8aeb-3b9d194cad5e",
"_parent_id": "75027b03-469b-470d-933a-0c1a9d910306",
"root_parent_id": "2f3850bf-8a5a-4363-9275-d3b2ff078f88",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9fa8b382-beb1-46cf-9c61-6530b86124ae",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5aa9e8a0-4e08-4c1d-aac3-215ecd8a9470",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "581c15b7-a06c-401f-90b1-9dc13e9cf130",
"_parent_code": "sample string 6",
"sales_organization_id": "dec0a5f3-8355-4c9a-9eb9-d901dcce8182",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "224b9ed4-6251-4fa5-87a1-ca24d7f829a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc0a1423-497f-4841-82d5-d21636305710",
"db_currency_id": "91d44017-302d-45e1-a651-e31d8466959b",
"db_language_id": "8ef6f709-1808-4b63-bc76-128a677b5290",
"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": "2025-11-22T21:48:05.4913595+00:00"
},
"modified_dateutc": "2025-11-22T21:48:05.4913595+00:00"
},
"equipment_model_id": "11504619-b97a-4542-b3f9-5737a7ce7193",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "aa353119-a6d4-45dd-8f07-aa03569d2671",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "362cc432-ee59-4298-9bdc-fc06515e823d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8d3c8f00-52c2-4259-8b4e-a509e67ad637",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ad646fb4-9363-4726-b779-e4b2ebf97c66",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "224b9ed4-6251-4fa5-87a1-ca24d7f829a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc0a1423-497f-4841-82d5-d21636305710",
"db_currency_id": "91d44017-302d-45e1-a651-e31d8466959b",
"db_language_id": "8ef6f709-1808-4b63-bc76-128a677b5290",
"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": "2025-11-22T21:48:05.4913595+00:00"
},
"modified_dateutc": "2025-11-22T21:48:05.4913595+00:00"
},
"equipment_family_id": "33075cea-a3ff-4bfc-b117-caa198ce3104",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5aa9e8a0-4e08-4c1d-aac3-215ecd8a9470",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "581c15b7-a06c-401f-90b1-9dc13e9cf130",
"_parent_code": "sample string 6",
"sales_organization_id": "dec0a5f3-8355-4c9a-9eb9-d901dcce8182",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "224b9ed4-6251-4fa5-87a1-ca24d7f829a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc0a1423-497f-4841-82d5-d21636305710",
"db_currency_id": "91d44017-302d-45e1-a651-e31d8466959b",
"db_language_id": "8ef6f709-1808-4b63-bc76-128a677b5290",
"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": "2025-11-22T21:48:05.4913595+00:00"
},
"modified_dateutc": "2025-11-22T21:48:05.4913595+00:00"
},
"date_in_production_since": "2025-11-22T21:48:05.4913595+00:00",
"date_out_of_production_since": "2025-11-22T21:48:05.4913595+00:00",
"date_end_support": "2025-11-22T21:48:05.4913595+00:00",
"sales_organization_id": "6c81fe93-5503-493c-bf84-460166d62483",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "224b9ed4-6251-4fa5-87a1-ca24d7f829a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc0a1423-497f-4841-82d5-d21636305710",
"db_currency_id": "91d44017-302d-45e1-a651-e31d8466959b",
"db_language_id": "8ef6f709-1808-4b63-bc76-128a677b5290",
"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": "2025-11-22T21:48:05.4913595+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": "2025-11-22T21:48:05.4913595+00:00"
},
"project_status_id": "690cdf0d-e0a3-40f3-9299-24c359697ec9",
"project_status_code": "sample string 10",
"project_status": {
"id": "37323fac-f4ca-4c13-8b9a-8cf18f99778c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a4b87a0c-92b5-4777-a3fd-1fa278cb6f3e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "224b9ed4-6251-4fa5-87a1-ca24d7f829a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc0a1423-497f-4841-82d5-d21636305710",
"db_currency_id": "91d44017-302d-45e1-a651-e31d8466959b",
"db_language_id": "8ef6f709-1808-4b63-bc76-128a677b5290",
"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": "2025-11-22T21:48:05.4913595+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-22T21:48:05.4913595+00:00"
},
"company_id": "f2e4e7c3-1394-47db-aa83-0c46de3cb731",
"company_code": "sample string 12",
"db_address_id": "2af69cec-91c6-4bb5-82a7-e78d9f8fcbc4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "75713b73-2db5-4383-b75b-35afb12ce87a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6f2b6b06-b046-44fe-91d2-53fd983e768b",
"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": "2025-11-22T21:48:05.4913595+00:00",
"date_create": "2025-11-22T21:48:05.4913595+00:00",
"date_update": "2025-11-22T21:48:05.4913595+00:00",
"updated_by_user_id": "fe01d51b-5693-45c6-bcca-ce22232cb3f4",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-22T21:48:05.4913595+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": "2025-11-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-22T21:48:05.4913595+00:00",
"date_last_job": "2025-11-22T21:48:05.4913595+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-22T21:48:05.4913595+00:00",
"modified_dateutc": "2025-11-22T21:48:05.4913595+00:00",
"is_mobile_installation": true
},
"job_type_id": "c6a807fa-afb3-47cc-a106-847253cfc1f8",
"job_type_code": "sample string 7",
"job_type": {
"id": "ea23ed47-8bb3-43d7-a7c8-888417f4fa6b",
"name": "sample string 2",
"sales_organization_id": "76a63f6c-6052-4328-917e-5df1c7ad2c67",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-22T21:48:05.4913595+00:00",
"code": "sample string 7"
},
"job_priority_id": "05a07aa2-aee0-4414-828d-c81839149f40",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "08f995b9-dc7b-4429-9f39-4831d6d01a8f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ab54241f-5a97-4504-a325-beea4b853837",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "224b9ed4-6251-4fa5-87a1-ca24d7f829a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc0a1423-497f-4841-82d5-d21636305710",
"db_currency_id": "91d44017-302d-45e1-a651-e31d8466959b",
"db_language_id": "8ef6f709-1808-4b63-bc76-128a677b5290",
"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": "2025-11-22T21:48:05.4913595+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-22T21:48:05.5069844+00:00"
},
"job_status_id": "59b43071-e1d2-46ae-8faa-899e6e83c02b",
"job_status_code": "sample string 11",
"db_address_id": "57ec2bf9-3026-4cb7-b220-27520b432511",
"contact_id": "321cc805-f84e-4feb-90da-2f6dabb410be",
"requested_by_company_id": "eee10c36-5350-4559-9ee0-21290f3bc500",
"requested_by_contact_id": "5cbdd083-21e7-422d-ab52-2e36b4c9f992",
"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": "2025-11-22T21:48:05.5069844+00:00",
"due_date": "2025-11-22T21:48:05.5069844+00:00",
"date_create": "2025-11-22T21:48:05.5069844+00:00",
"date_update": "2025-11-22T21:48:05.5069844+00:00",
"date_closed": "2025-11-22T21:48:05.5069844+00:00",
"suggested_user_id": "a94aacf3-62cd-418b-ad8f-316b8912e421",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ba66fe7a-bc38-40a5-b56c-49330167a945",
"db_language_id": "7dc61359-312c-4e67-ace1-9e7edd69b3f0",
"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": "2025-11-22T21:48:05.5069844+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "956e96fd-0df4-4d23-b120-b1976c8d6212",
"sales_organization": {
"id": "224b9ed4-6251-4fa5-87a1-ca24d7f829a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc0a1423-497f-4841-82d5-d21636305710",
"db_currency_id": "91d44017-302d-45e1-a651-e31d8466959b",
"db_language_id": "8ef6f709-1808-4b63-bc76-128a677b5290",
"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": "2025-11-22T21:48:05.4913595+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "658f9cc8-dfde-4780-8603-691b5d83c37b",
"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": "41dc6a2d-9703-49ae-8f5b-0a951f84b850",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-22T21:48:05.5069844+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "bb28f17f-4065-4936-bc9d-5d73320cac2a"
},
"suggested_date_start": "2025-11-22T21:48:05.5069844+00:00",
"skill_id": "4a316c37-0d44-4b77-9438-bc2ed58d38b9",
"skill_code": "sample string 32",
"skill": {
"id": "8b7b5e69-fc14-4b4b-ab1b-9a222985977e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0842e776-a677-4fa0-bdc0-a5701f773492",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "224b9ed4-6251-4fa5-87a1-ca24d7f829a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc0a1423-497f-4841-82d5-d21636305710",
"db_currency_id": "91d44017-302d-45e1-a651-e31d8466959b",
"db_language_id": "8ef6f709-1808-4b63-bc76-128a677b5290",
"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": "2025-11-22T21:48:05.4913595+00:00"
},
"modified_dateutc": "2025-11-22T21:48:05.5069844+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "050a000a-bf6e-47eb-ad92-ed253696a778",
"date_reported_by_company": "2025-11-22T21:48:05.5069844+00:00",
"id2": 36,
"company_id": "81d21693-0921-4be2-91da-ad5e374f8833",
"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": "4982d1a6-445f-4dc6-a8e8-373c3d0e0ddd",
"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": "2025-11-22T21:48:05.5069844+00:00"
},
"work_instruction_details_id": "11642fc8-54a0-4b4b-8ea8-fbfde0be87ea",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7c96e570-cce3-4e3e-87e9-4a6f47f3b68d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "84296bec-4470-4d4e-a5aa-fe0cff2a02db",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-22T21:48:05.5069844+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": "51ff817d-6ffd-47ed-aede-a67c79ff6854",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-22T21:48:05.5069844+00:00"
}