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": "25191248-49b1-4b20-b098-0f316912374b",
"jobs_id": "7e09a47f-7b32-4986-b910-12df9d8ccc98",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fa0e2d17-0a87-40d9-9d23-698600d7f4d1",
"_parent_id": "aafe9de7-b88b-4db6-bee2-5c154118ca30",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ad0ac162-fe25-4913-b05b-284c42956ba1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "60a5add5-90e7-4c46-9fc2-5ea0ee78b847",
"_parent_id": "1c2570a1-3e46-4939-a926-7fbfca9665bf",
"root_parent_id": "cf12a201-9257-4df5-954f-8ff8fbafd1a7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fa99e276-7dce-445b-89f9-c1c3428f91c6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a5fe8cd5-ab78-42e6-b71a-e2818196766f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a1b187c8-7473-4c43-98b6-e2b6ddf52ec9",
"_parent_code": "sample string 6",
"sales_organization_id": "929c3d5e-06f8-422e-b391-1ef3577c6a8e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "54e36379-3b32-4413-b755-bcb6ef74c440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14de6863-25de-47a3-976b-b2157c991d20",
"db_currency_id": "9b2072d0-d645-4280-8020-b970b6fc2152",
"db_language_id": "2486f14a-24a2-4115-b4a7-b79b8c63d06a",
"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-13T10:51:49.3862941+00:00"
},
"modified_dateutc": "2025-11-13T10:51:49.3862941+00:00"
},
"equipment_model_id": "9151fdf6-b30d-459f-af51-b24b7622ccc2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1ee3294d-48d2-4fb0-95da-fc5af052eaa8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "65c70f3d-96aa-4d18-b1e9-7cb20b588482",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "695deafc-5fed-44e1-a2b0-7783bcef7f26",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6a1f854a-3961-49cc-bac0-1354b7e7afc1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "54e36379-3b32-4413-b755-bcb6ef74c440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14de6863-25de-47a3-976b-b2157c991d20",
"db_currency_id": "9b2072d0-d645-4280-8020-b970b6fc2152",
"db_language_id": "2486f14a-24a2-4115-b4a7-b79b8c63d06a",
"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-13T10:51:49.3862941+00:00"
},
"modified_dateutc": "2025-11-13T10:51:49.3862941+00:00"
},
"equipment_family_id": "46d72f72-f4fe-4109-8deb-9c487920c481",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a5fe8cd5-ab78-42e6-b71a-e2818196766f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a1b187c8-7473-4c43-98b6-e2b6ddf52ec9",
"_parent_code": "sample string 6",
"sales_organization_id": "929c3d5e-06f8-422e-b391-1ef3577c6a8e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "54e36379-3b32-4413-b755-bcb6ef74c440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14de6863-25de-47a3-976b-b2157c991d20",
"db_currency_id": "9b2072d0-d645-4280-8020-b970b6fc2152",
"db_language_id": "2486f14a-24a2-4115-b4a7-b79b8c63d06a",
"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-13T10:51:49.3862941+00:00"
},
"modified_dateutc": "2025-11-13T10:51:49.3862941+00:00"
},
"date_in_production_since": "2025-11-13T10:51:49.3862941+00:00",
"date_out_of_production_since": "2025-11-13T10:51:49.3862941+00:00",
"date_end_support": "2025-11-13T10:51:49.3862941+00:00",
"sales_organization_id": "3f33ab69-7d19-4863-8880-957a3657d7f8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "54e36379-3b32-4413-b755-bcb6ef74c440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14de6863-25de-47a3-976b-b2157c991d20",
"db_currency_id": "9b2072d0-d645-4280-8020-b970b6fc2152",
"db_language_id": "2486f14a-24a2-4115-b4a7-b79b8c63d06a",
"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-13T10:51:49.3862941+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-13T10:51:49.3862941+00:00"
},
"project_status_id": "6cb222eb-74c5-4f28-be97-9d8075832b11",
"project_status_code": "sample string 10",
"project_status": {
"id": "d7bd2a8e-d291-4f6b-a4f0-c23e4489cbad",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d6dce2c5-d703-4092-a08a-33c788fa20f4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "54e36379-3b32-4413-b755-bcb6ef74c440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14de6863-25de-47a3-976b-b2157c991d20",
"db_currency_id": "9b2072d0-d645-4280-8020-b970b6fc2152",
"db_language_id": "2486f14a-24a2-4115-b4a7-b79b8c63d06a",
"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-13T10:51:49.3862941+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-13T10:51:49.3862941+00:00"
},
"company_id": "f2221775-07aa-4ec3-86bd-edb9fb7df482",
"company_code": "sample string 12",
"db_address_id": "44b56e80-9eaa-4919-9867-f4caef2ebf95",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "91e078b1-b44e-49a8-bcae-16e4991cfcae",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9d2e77ef-ec2b-40e5-aa3d-fceb347a4b2c",
"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-13T10:51:49.3862941+00:00",
"date_create": "2025-11-13T10:51:49.3862941+00:00",
"date_update": "2025-11-13T10:51:49.3862941+00:00",
"updated_by_user_id": "0027e3ce-4f1a-41a5-8d45-689662624b57",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-13T10:51:49.3862941+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-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-13T10:51:49.3862941+00:00",
"date_last_job": "2025-11-13T10:51:49.3862941+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-13T10:51:49.3862941+00:00",
"modified_dateutc": "2025-11-13T10:51:49.3862941+00:00",
"is_mobile_installation": true
},
"job_type_id": "b68f298c-9014-4606-b45f-f3528dc4458a",
"job_type_code": "sample string 7",
"job_type": {
"id": "088ca213-ae91-4492-9209-91e5f0bd239f",
"name": "sample string 2",
"sales_organization_id": "617ba00b-cb90-430b-8fb2-a62eb6fc36de",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-13T10:51:49.3862941+00:00",
"code": "sample string 7"
},
"job_priority_id": "915ca846-3142-4272-abe6-cf2ecf101426",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2dad8fbc-2b64-4242-bfa7-bfe299110123",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8b8dd08c-e3fc-4d1c-ae90-249842ea26c0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "54e36379-3b32-4413-b755-bcb6ef74c440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14de6863-25de-47a3-976b-b2157c991d20",
"db_currency_id": "9b2072d0-d645-4280-8020-b970b6fc2152",
"db_language_id": "2486f14a-24a2-4115-b4a7-b79b8c63d06a",
"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-13T10:51:49.3862941+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-13T10:51:49.3862941+00:00"
},
"job_status_id": "7e9ac9d7-7bc9-4710-a6db-b8eaa18b8374",
"job_status_code": "sample string 11",
"db_address_id": "598130eb-254a-4a19-8102-91d7eb6de3fb",
"contact_id": "1647a968-40de-442c-83ba-73505fda6408",
"requested_by_company_id": "07fc6f77-c1a0-42ff-a8ff-83aa092c1d17",
"requested_by_contact_id": "6775b695-4dc1-47ed-9e4f-7f83a4d83abd",
"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-13T10:51:49.3862941+00:00",
"due_date": "2025-11-13T10:51:49.3862941+00:00",
"date_create": "2025-11-13T10:51:49.3862941+00:00",
"date_update": "2025-11-13T10:51:49.3862941+00:00",
"date_closed": "2025-11-13T10:51:49.3862941+00:00",
"suggested_user_id": "d21871bd-bc62-4af6-b886-9207842b06c9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "17cf6eb9-edde-4dba-9fec-3688bd4c8917",
"db_language_id": "494bb58e-9580-4cad-8c9c-0b5d836ee037",
"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-13T10:51:49.3862941+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9f6c39c4-067e-454a-b9bf-0ead15af278b",
"sales_organization": {
"id": "54e36379-3b32-4413-b755-bcb6ef74c440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14de6863-25de-47a3-976b-b2157c991d20",
"db_currency_id": "9b2072d0-d645-4280-8020-b970b6fc2152",
"db_language_id": "2486f14a-24a2-4115-b4a7-b79b8c63d06a",
"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-13T10:51:49.3862941+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "998c4028-5d0a-421a-b26d-f431cf0f46c8",
"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": "8d11c401-56cb-4bd0-b45e-d275bf43c6a3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-13T10:51:49.3862941+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f8bada3c-cbf1-4b21-adb6-9a6eb9899e33"
},
"suggested_date_start": "2025-11-13T10:51:49.3862941+00:00",
"skill_id": "6945dcbe-13a6-4bd9-9b29-d5c9e4b1054c",
"skill_code": "sample string 32",
"skill": {
"id": "21ff1978-bc86-4d3a-81df-d8d1242effe7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "aa78bb7a-e6f3-4601-9d43-f991fe65e6b1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "54e36379-3b32-4413-b755-bcb6ef74c440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14de6863-25de-47a3-976b-b2157c991d20",
"db_currency_id": "9b2072d0-d645-4280-8020-b970b6fc2152",
"db_language_id": "2486f14a-24a2-4115-b4a7-b79b8c63d06a",
"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-13T10:51:49.3862941+00:00"
},
"modified_dateutc": "2025-11-13T10:51:49.3862941+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7dc817b2-df0f-4803-acb7-38808691e355",
"date_reported_by_company": "2025-11-13T10:51:49.3862941+00:00",
"id2": 36,
"company_id": "a9afc358-a0d6-4804-b4ca-05a158006b1d",
"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": "94254afa-c5ed-4bc2-8f99-11036654bb94",
"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-13T10:51:49.4019459+00:00"
},
"work_instruction_details_id": "9d7e9b12-ec4d-486f-b01a-75350168929b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dd167ae8-a60e-4685-af9e-be7d89d31488",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1404c6cf-2329-4d79-9d04-627b666cc21b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-13T10:51:49.4019459+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": "16d61a17-346d-4113-8584-3e2858f36705",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-13T10:51:49.4019459+00:00"
}