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": "30b34226-f941-4ef9-96d0-ae0e0d530bc4",
"jobs_id": "dcd80510-e6ec-442f-98a9-08e57c3bb320",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "09abd8d3-7b97-4794-96b4-4d3092611b09",
"_parent_id": "84eb724e-c87a-4121-a664-5864059206fa",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7cdc585c-2086-4e4b-83f8-ec4f9dabfcc1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8ce6e3b6-7e45-401f-bd1a-d21051ca80ac",
"_parent_id": "153f0454-a25c-4dca-88f6-20d38ca4bf2e",
"root_parent_id": "d878db66-e4f6-42ca-ab0f-a1530257c2ff",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d21ef04a-b6bc-4b80-9fdf-8fbd188abdc6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "258e5746-3c42-4984-8e8d-76acbfb7caec",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6bbc6986-3e67-4349-9c86-70d50b9b3405",
"_parent_code": "sample string 6",
"sales_organization_id": "f939a17c-27a9-4119-928b-086a9434e86b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b4f96a4d-3d01-4a96-9413-99f63255f886",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50e9038a-7068-44ae-9fd4-3a9852c7a7be",
"db_currency_id": "fbc61990-935f-477d-a8da-5183d3259c19",
"db_language_id": "3b51247d-4d4a-4884-8fe2-52209c5e788c",
"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-18T07:55:24.4374768+00:00"
},
"modified_dateutc": "2026-10-18T07:55:24.4374768+00:00"
},
"equipment_model_id": "cbb1030c-6028-43eb-8cad-1b4cd19ad698",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e53f839f-3011-4ae6-ae9c-40816a4b872c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ec498d55-709d-41c3-b9be-b6d675c3c067",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a12d3054-4180-4fd6-a4a6-7a0a85a32ad1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "61021d82-9625-4289-b78e-645500018eb3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b4f96a4d-3d01-4a96-9413-99f63255f886",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50e9038a-7068-44ae-9fd4-3a9852c7a7be",
"db_currency_id": "fbc61990-935f-477d-a8da-5183d3259c19",
"db_language_id": "3b51247d-4d4a-4884-8fe2-52209c5e788c",
"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-18T07:55:24.4374768+00:00"
},
"modified_dateutc": "2026-10-18T07:55:24.4374768+00:00"
},
"equipment_family_id": "27aa2b61-6d6b-459c-88c4-471d02a06597",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "258e5746-3c42-4984-8e8d-76acbfb7caec",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6bbc6986-3e67-4349-9c86-70d50b9b3405",
"_parent_code": "sample string 6",
"sales_organization_id": "f939a17c-27a9-4119-928b-086a9434e86b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b4f96a4d-3d01-4a96-9413-99f63255f886",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50e9038a-7068-44ae-9fd4-3a9852c7a7be",
"db_currency_id": "fbc61990-935f-477d-a8da-5183d3259c19",
"db_language_id": "3b51247d-4d4a-4884-8fe2-52209c5e788c",
"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-18T07:55:24.4374768+00:00"
},
"modified_dateutc": "2026-10-18T07:55:24.4374768+00:00"
},
"date_in_production_since": "2026-10-18T07:55:24.4374768+00:00",
"date_out_of_production_since": "2026-10-18T07:55:24.4374768+00:00",
"date_end_support": "2026-10-18T07:55:24.4374768+00:00",
"sales_organization_id": "b76c1c7c-44f6-4211-b38f-698f7bce6c41",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b4f96a4d-3d01-4a96-9413-99f63255f886",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50e9038a-7068-44ae-9fd4-3a9852c7a7be",
"db_currency_id": "fbc61990-935f-477d-a8da-5183d3259c19",
"db_language_id": "3b51247d-4d4a-4884-8fe2-52209c5e788c",
"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-18T07:55:24.4374768+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-18T07:55:24.4374768+00:00"
},
"project_status_id": "5776ccc3-7845-48d5-8b80-10b060c37251",
"project_status_code": "sample string 10",
"project_status": {
"id": "d48e1a61-c495-40a6-99d2-b8f175834a65",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b738eec0-ac4f-46d9-af71-a4a19cd44b07",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b4f96a4d-3d01-4a96-9413-99f63255f886",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50e9038a-7068-44ae-9fd4-3a9852c7a7be",
"db_currency_id": "fbc61990-935f-477d-a8da-5183d3259c19",
"db_language_id": "3b51247d-4d4a-4884-8fe2-52209c5e788c",
"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-18T07:55:24.4374768+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-18T07:55:24.4374768+00:00"
},
"company_id": "908437b5-1782-41fd-82ca-74c16e9a4632",
"company_code": "sample string 12",
"db_address_id": "4a7c5d36-fda8-4432-bd30-49b1b942069a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9ccc585d-734a-40d3-8e98-d5cbee7cc97a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c2d1720b-1a0a-40ad-963b-ba393c4ebc2b",
"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-18T07:55:24.4374768+00:00",
"date_create": "2026-10-18T07:55:24.4374768+00:00",
"date_update": "2026-10-18T07:55:24.4374768+00:00",
"updated_by_user_id": "bcd931c8-92b6-4669-b264-f6f386e900c1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-18T07:55:24.4374768+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-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-18T07:55:24.4374768+00:00",
"date_last_job": "2026-10-18T07:55:24.4374768+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-18T07:55:24.4374768+00:00",
"modified_dateutc": "2026-10-18T07:55:24.4374768+00:00",
"is_mobile_installation": true
},
"job_type_id": "5dc6befc-6322-4243-8dc8-b536a11c180c",
"job_type_code": "sample string 7",
"job_type": {
"id": "6a4f7e03-01a0-4143-80a6-e4bd5767560d",
"name": "sample string 2",
"sales_organization_id": "ab331371-7fbc-44b1-898c-6a118b09a2df",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-18T07:55:24.4374768+00:00",
"code": "sample string 7"
},
"job_priority_id": "7d8dc87a-553f-481f-8cfe-85c907e0e2e5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bb9e1671-fbf5-447b-878a-47f635f8d4be",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "73825086-14bb-4f7c-947f-8ccc84cee905",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b4f96a4d-3d01-4a96-9413-99f63255f886",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50e9038a-7068-44ae-9fd4-3a9852c7a7be",
"db_currency_id": "fbc61990-935f-477d-a8da-5183d3259c19",
"db_language_id": "3b51247d-4d4a-4884-8fe2-52209c5e788c",
"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-18T07:55:24.4374768+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-18T07:55:24.4374768+00:00"
},
"job_status_id": "a2bd7272-cc37-412d-9da5-bb7668b3ac1c",
"job_status_code": "sample string 11",
"db_address_id": "25c56fe6-0e28-4447-8a38-793b512981c6",
"contact_id": "622c1c54-712e-4164-a81a-d7af8dbb4fb2",
"requested_by_company_id": "86cd67ed-bccb-4c04-b176-ba108871c617",
"requested_by_contact_id": "ff153152-8d14-47d0-8281-81b1010d5199",
"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-18T07:55:24.4374768+00:00",
"due_date": "2026-10-18T07:55:24.4374768+00:00",
"date_create": "2026-10-18T07:55:24.4374768+00:00",
"date_update": "2026-10-18T07:55:24.4374768+00:00",
"date_closed": "2026-10-18T07:55:24.4374768+00:00",
"suggested_user_id": "fa22c644-ad9d-4d8a-9e79-328a36d6728b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2afe721e-4654-4857-8e64-525b7e7de395",
"db_language_id": "c185e28e-fb2f-44a0-b6d4-9a3f70e77846",
"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-18T07:55:24.4374768+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1f67ff5a-030e-4160-a693-0227eeab3d99",
"sales_organization": {
"id": "b4f96a4d-3d01-4a96-9413-99f63255f886",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50e9038a-7068-44ae-9fd4-3a9852c7a7be",
"db_currency_id": "fbc61990-935f-477d-a8da-5183d3259c19",
"db_language_id": "3b51247d-4d4a-4884-8fe2-52209c5e788c",
"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-18T07:55:24.4374768+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "98aae206-a268-4004-a289-343c5335c523",
"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": "355d620b-1bce-44fc-8901-0b9784700560",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-18T07:55:24.4374768+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0f91d709-ad40-4fcc-95c9-aa1bb8262899"
},
"suggested_date_start": "2026-10-18T07:55:24.4565288+00:00",
"skill_id": "9aacadc4-0c70-464c-bbc3-1d4d0c7c753d",
"skill_code": "sample string 32",
"skill": {
"id": "0718b1ef-29d7-435d-adaf-f0ec4a9e6257",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "144d30d5-f3dd-4fa8-8ea8-856b99913dae",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b4f96a4d-3d01-4a96-9413-99f63255f886",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50e9038a-7068-44ae-9fd4-3a9852c7a7be",
"db_currency_id": "fbc61990-935f-477d-a8da-5183d3259c19",
"db_language_id": "3b51247d-4d4a-4884-8fe2-52209c5e788c",
"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-18T07:55:24.4374768+00:00"
},
"modified_dateutc": "2026-10-18T07:55:24.4565288+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fbcfa738-1115-4ce8-af9c-97407fff656c",
"date_reported_by_company": "2026-10-18T07:55:24.4565288+00:00",
"id2": 36,
"company_id": "7f62a197-7157-4b2d-a1e0-00f907783e65",
"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": "ec1fe0cd-f8f8-4abd-8c55-7357f53948c4",
"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-18T07:55:24.4565288+00:00"
},
"work_instruction_details_id": "6c51af1c-8a36-43eb-8b8d-6e7106dcc157",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cb70fbc7-c327-4ff0-b786-8e697acaa437",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "007f75a8-0fbc-49b3-bd7c-f14012d06bda",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-18T07:55:24.4565288+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": "c34605f1-e068-4f48-8f28-f0c2456bed61",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-18T07:55:24.4565288+00:00"
}