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": "a7cd2cce-fad0-4c2a-8cc1-24ba4d1faaae",
"jobs_id": "8a16daf7-9e73-430d-8a67-514165b91cfe",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c3f3f9a9-9642-4f37-bde1-0042529659d9",
"_parent_id": "4d82bdfb-5882-440e-8c8c-a38644498cb1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "aac39d42-419a-4dfd-a08e-e03714b90f74",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e5f32390-fadd-40c7-86f0-906a5c11d8a2",
"_parent_id": "817278f3-710a-49a4-885c-09578bc6ec6b",
"root_parent_id": "ca9a6480-514e-48f9-ac12-4245b287d1d2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "78753d97-9c3d-4bf4-980a-ccd23bd74212",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4d9a6352-bb75-4ef1-af90-59fc9b7ca75d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2202fd3d-76ef-4867-ae99-f409e133e9ca",
"_parent_code": "sample string 6",
"sales_organization_id": "e83b1d17-75bb-410c-a748-15aa1f8ddc75",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "46362951-1b76-47b4-b4b4-b25743484cf8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1919ceae-9148-4e0d-b206-07a8cc669774",
"db_currency_id": "b480899e-5566-4508-8c6e-ab0245429ab7",
"db_language_id": "2121736a-b27e-4071-9c37-6cf478667721",
"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-09-17T05:44:58.7914343+00:00"
},
"modified_dateutc": "2025-09-17T05:44:58.7914343+00:00"
},
"equipment_model_id": "0ae0d1dd-b2d5-498c-8880-24c72f8d4210",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8da7c487-aae3-45db-8e31-9a8f4e8ab038",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d1e2f139-b7c6-4d0d-a8c0-95d795b24c5e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3ebdfd7c-9f48-4fd3-823e-e525dfc2275d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5e949f01-bde7-40b6-adb5-ce6df1f1c258",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "46362951-1b76-47b4-b4b4-b25743484cf8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1919ceae-9148-4e0d-b206-07a8cc669774",
"db_currency_id": "b480899e-5566-4508-8c6e-ab0245429ab7",
"db_language_id": "2121736a-b27e-4071-9c37-6cf478667721",
"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-09-17T05:44:58.7914343+00:00"
},
"modified_dateutc": "2025-09-17T05:44:58.7914343+00:00"
},
"equipment_family_id": "c44f0c44-834b-41c0-8658-d1d31926d97c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4d9a6352-bb75-4ef1-af90-59fc9b7ca75d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2202fd3d-76ef-4867-ae99-f409e133e9ca",
"_parent_code": "sample string 6",
"sales_organization_id": "e83b1d17-75bb-410c-a748-15aa1f8ddc75",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "46362951-1b76-47b4-b4b4-b25743484cf8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1919ceae-9148-4e0d-b206-07a8cc669774",
"db_currency_id": "b480899e-5566-4508-8c6e-ab0245429ab7",
"db_language_id": "2121736a-b27e-4071-9c37-6cf478667721",
"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-09-17T05:44:58.7914343+00:00"
},
"modified_dateutc": "2025-09-17T05:44:58.7914343+00:00"
},
"date_in_production_since": "2025-09-17T05:44:58.7914343+00:00",
"date_out_of_production_since": "2025-09-17T05:44:58.7914343+00:00",
"date_end_support": "2025-09-17T05:44:58.7914343+00:00",
"sales_organization_id": "a45a35b6-2785-493a-8a7a-3de2f0768618",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "46362951-1b76-47b4-b4b4-b25743484cf8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1919ceae-9148-4e0d-b206-07a8cc669774",
"db_currency_id": "b480899e-5566-4508-8c6e-ab0245429ab7",
"db_language_id": "2121736a-b27e-4071-9c37-6cf478667721",
"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-09-17T05:44:58.7914343+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-09-17T05:44:58.7914343+00:00"
},
"project_status_id": "3c9e6b02-9bf0-43c4-b526-94daacd72ada",
"project_status_code": "sample string 10",
"project_status": {
"id": "be400c58-9fb7-48c3-8a58-3250d89ec2be",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6d345df9-5509-4a73-b7db-2d5718728442",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "46362951-1b76-47b4-b4b4-b25743484cf8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1919ceae-9148-4e0d-b206-07a8cc669774",
"db_currency_id": "b480899e-5566-4508-8c6e-ab0245429ab7",
"db_language_id": "2121736a-b27e-4071-9c37-6cf478667721",
"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-09-17T05:44:58.7914343+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-17T05:44:58.7914343+00:00"
},
"company_id": "8023f358-20bb-4266-a48c-07442778ab5a",
"company_code": "sample string 12",
"db_address_id": "49254711-d927-4761-89c7-f8515072a03e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "74a95a61-7379-4259-94a7-f3df08b9b185",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cccc5599-b219-4b47-bc14-b80a3c8bffe0",
"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-09-17T05:44:58.7914343+00:00",
"date_create": "2025-09-17T05:44:58.7914343+00:00",
"date_update": "2025-09-17T05:44:58.7914343+00:00",
"updated_by_user_id": "859bb663-0a02-4d42-8e15-7fce51386155",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-09-17T05:44:58.7914343+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-09-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-09-17T05:44:58.8070633+00:00",
"date_last_job": "2025-09-17T05:44:58.8070633+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-09-17T05:44:58.8070633+00:00",
"modified_dateutc": "2025-09-17T05:44:58.8070633+00:00",
"is_mobile_installation": true
},
"job_type_id": "65b70687-c8cf-4317-9284-2f5d8cbe2d0f",
"job_type_code": "sample string 7",
"job_type": {
"id": "388fdc0f-cbc2-43f9-a42f-f81d39acc843",
"name": "sample string 2",
"sales_organization_id": "0b9bd867-cc6f-4173-b4ab-90c36c9a7990",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-09-17T05:44:58.8070633+00:00",
"code": "sample string 7"
},
"job_priority_id": "ca616494-cf04-440d-be27-cdcd47aebbcb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "28cfac8c-7ec9-43dc-bf3c-15d17b71df69",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "da98cfd7-ee4b-4f16-ad42-db48c13457c3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "46362951-1b76-47b4-b4b4-b25743484cf8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1919ceae-9148-4e0d-b206-07a8cc669774",
"db_currency_id": "b480899e-5566-4508-8c6e-ab0245429ab7",
"db_language_id": "2121736a-b27e-4071-9c37-6cf478667721",
"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-09-17T05:44:58.7914343+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-17T05:44:58.8070633+00:00"
},
"job_status_id": "dae7a294-c092-4a68-bf41-7dbdef3956d2",
"job_status_code": "sample string 11",
"db_address_id": "d0db4562-b6a5-4ed3-8b7f-f47ced80e831",
"contact_id": "e58af506-ced4-45a1-b16a-a6e9689d30c3",
"requested_by_company_id": "7632f6f7-c8ac-437a-9fa9-0d55a1a56e58",
"requested_by_contact_id": "413a4a9e-3dce-494f-8e58-64c0f9b3a9f2",
"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-09-17T05:44:58.8070633+00:00",
"due_date": "2025-09-17T05:44:58.8070633+00:00",
"date_create": "2025-09-17T05:44:58.8070633+00:00",
"date_update": "2025-09-17T05:44:58.8070633+00:00",
"date_closed": "2025-09-17T05:44:58.8070633+00:00",
"suggested_user_id": "44a3f2a8-5222-4db3-9421-3c151a2d2713",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "dbf912e3-e7da-49d7-b8a7-fd4484b7a260",
"db_language_id": "fde763f6-1abb-47d3-b7d4-23dd6a05c42c",
"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-09-17T05:44:58.8070633+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9b98502c-0aa3-4179-854e-b4eb70418f9f",
"sales_organization": {
"id": "46362951-1b76-47b4-b4b4-b25743484cf8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1919ceae-9148-4e0d-b206-07a8cc669774",
"db_currency_id": "b480899e-5566-4508-8c6e-ab0245429ab7",
"db_language_id": "2121736a-b27e-4071-9c37-6cf478667721",
"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-09-17T05:44:58.7914343+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4cbc17f9-4a59-4c58-a7a2-ea09d455d9fc",
"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": "d69f5e5b-496b-4230-a693-10d551362bfa",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-09-17T05:44:58.8070633+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c2a1a511-dfe5-4d0c-8cbb-569e32a3ecb9"
},
"suggested_date_start": "2025-09-17T05:44:58.8070633+00:00",
"skill_id": "715ee6ae-fb6c-4cce-99f4-ee80e499eadc",
"skill_code": "sample string 32",
"skill": {
"id": "540d3e70-e1d5-4f20-bf71-5cf4b3ba1b2f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "12015b1e-9311-48b5-b5ae-dc539663c0b3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "46362951-1b76-47b4-b4b4-b25743484cf8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1919ceae-9148-4e0d-b206-07a8cc669774",
"db_currency_id": "b480899e-5566-4508-8c6e-ab0245429ab7",
"db_language_id": "2121736a-b27e-4071-9c37-6cf478667721",
"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-09-17T05:44:58.7914343+00:00"
},
"modified_dateutc": "2025-09-17T05:44:58.8070633+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1be5f742-c661-47a8-adfc-4c11fc04fc42",
"date_reported_by_company": "2025-09-17T05:44:58.8070633+00:00",
"id2": 36,
"company_id": "e126c77a-6b3f-4a48-b27a-a5cd2782c917",
"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": "0066038c-a0e1-4d2e-9df5-efe57f2a2dc3",
"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-09-17T05:44:58.8070633+00:00"
},
"work_instruction_details_id": "d19e6fc7-c568-442d-8096-7b2135448272",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "755fce72-c29c-4b33-9f99-f2605fd468bc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9c39e986-119b-4f27-8588-9e0901ccdd2a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-09-17T05:44:58.8070633+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": "1ecd1f07-626c-498b-af0d-1e45d00feb82",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-09-17T05:44:58.8070633+00:00"
}