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": "cfe16f6c-6d02-45f6-9c2a-e954267cbc8b",
"jobs_id": "e605c52b-6219-4593-a5f0-95ef75a93190",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "315fcffb-bcc1-4660-aa07-60deeaaf1258",
"_parent_id": "0ebaad17-5cd3-4ec9-92fa-0a96decaaa02",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "329f5d53-6049-41b6-a56f-b5829f90ef2f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ff698667-57d1-4c75-99b6-4752d8fdaffc",
"_parent_id": "d2b1a485-b4ad-4d05-bfb3-436d30c6a2af",
"root_parent_id": "b3618823-31cc-4c6c-b13f-8d2fea0f0217",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3877c8fd-613e-47bf-a81c-cf27f06e8a3a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "670264e2-1ae6-422a-8cbb-4598d1210f6a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7b9ed44f-2596-4d95-8f46-ba3ebf634753",
"_parent_code": "sample string 6",
"sales_organization_id": "828617f5-1a7b-4cc9-9e3a-f556979fb6ca",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d316f743-459c-4c58-ac7a-c1ad8b0b2dbf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4641747b-ce88-4bd2-a39a-a508061c98a7",
"db_currency_id": "59319a17-3023-4074-a4b8-07945ca41c74",
"db_language_id": "721a4553-27da-4ac2-baf7-04f65cafcada",
"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-02-18T11:24:43.5723728+00:00"
},
"modified_dateutc": "2026-02-18T11:24:43.5723728+00:00"
},
"equipment_model_id": "5df6dc86-b6f1-4554-9d9e-660a0767976c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ff46aba1-f34a-49c6-917c-5df4395fefb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "783fe8a1-b43a-481e-b153-fd0905f3baeb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "38fb6d1a-b5bd-4426-abc1-877aaa8d3d4b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ce8dbc8a-5b6a-488e-be20-611c6c14f27c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d316f743-459c-4c58-ac7a-c1ad8b0b2dbf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4641747b-ce88-4bd2-a39a-a508061c98a7",
"db_currency_id": "59319a17-3023-4074-a4b8-07945ca41c74",
"db_language_id": "721a4553-27da-4ac2-baf7-04f65cafcada",
"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-02-18T11:24:43.5723728+00:00"
},
"modified_dateutc": "2026-02-18T11:24:43.5723728+00:00"
},
"equipment_family_id": "77697687-25d2-4b52-a845-ed24f53e0368",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "670264e2-1ae6-422a-8cbb-4598d1210f6a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7b9ed44f-2596-4d95-8f46-ba3ebf634753",
"_parent_code": "sample string 6",
"sales_organization_id": "828617f5-1a7b-4cc9-9e3a-f556979fb6ca",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d316f743-459c-4c58-ac7a-c1ad8b0b2dbf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4641747b-ce88-4bd2-a39a-a508061c98a7",
"db_currency_id": "59319a17-3023-4074-a4b8-07945ca41c74",
"db_language_id": "721a4553-27da-4ac2-baf7-04f65cafcada",
"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-02-18T11:24:43.5723728+00:00"
},
"modified_dateutc": "2026-02-18T11:24:43.5723728+00:00"
},
"date_in_production_since": "2026-02-18T11:24:43.5723728+00:00",
"date_out_of_production_since": "2026-02-18T11:24:43.5723728+00:00",
"date_end_support": "2026-02-18T11:24:43.5723728+00:00",
"sales_organization_id": "a8b3057c-f408-462e-8638-264692bdb189",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d316f743-459c-4c58-ac7a-c1ad8b0b2dbf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4641747b-ce88-4bd2-a39a-a508061c98a7",
"db_currency_id": "59319a17-3023-4074-a4b8-07945ca41c74",
"db_language_id": "721a4553-27da-4ac2-baf7-04f65cafcada",
"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-02-18T11:24:43.5723728+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-02-18T11:24:43.5723728+00:00"
},
"project_status_id": "4b289c44-5d29-4128-a8cf-1fafa87dd387",
"project_status_code": "sample string 10",
"project_status": {
"id": "c514bef0-0887-41b5-bfd8-a49c48227ef0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8ef38871-e084-4308-83a5-966c5504f6cb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d316f743-459c-4c58-ac7a-c1ad8b0b2dbf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4641747b-ce88-4bd2-a39a-a508061c98a7",
"db_currency_id": "59319a17-3023-4074-a4b8-07945ca41c74",
"db_language_id": "721a4553-27da-4ac2-baf7-04f65cafcada",
"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-02-18T11:24:43.5723728+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-18T11:24:43.5723728+00:00"
},
"company_id": "f3cb0d5b-1618-494b-8660-652bfa8d7deb",
"company_code": "sample string 12",
"db_address_id": "b67498e1-b5a5-475f-a407-803b5c98646b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b0ad2d85-bc58-4a5e-8bbc-95b650d190f7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f8006e89-15cc-44d8-b677-d07b2282b51a",
"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-02-18T11:24:43.5723728+00:00",
"date_create": "2026-02-18T11:24:43.5723728+00:00",
"date_update": "2026-02-18T11:24:43.5723728+00:00",
"updated_by_user_id": "ceb66aa6-4fc0-45c6-9186-1f8ac941f735",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-18T11:24:43.5723728+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-02-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-18T11:24:43.5723728+00:00",
"date_last_job": "2026-02-18T11:24:43.5723728+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-18T11:24:43.5723728+00:00",
"modified_dateutc": "2026-02-18T11:24:43.5723728+00:00",
"is_mobile_installation": true
},
"job_type_id": "92dbd852-d5d6-4233-b184-ad91f5fc5dd9",
"job_type_code": "sample string 7",
"job_type": {
"id": "3b4c5a55-6ced-4cb5-a8f6-ab08294db858",
"name": "sample string 2",
"sales_organization_id": "67c3e399-6eb9-4834-a774-c456f6182446",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-18T11:24:43.5723728+00:00",
"code": "sample string 7"
},
"job_priority_id": "847aedfb-a120-47e9-acfd-ae35bfae306c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a9a4aa68-f328-4542-ad14-373cdca13af6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d3208ca1-ff39-488a-9784-0b2f99726c8a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d316f743-459c-4c58-ac7a-c1ad8b0b2dbf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4641747b-ce88-4bd2-a39a-a508061c98a7",
"db_currency_id": "59319a17-3023-4074-a4b8-07945ca41c74",
"db_language_id": "721a4553-27da-4ac2-baf7-04f65cafcada",
"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-02-18T11:24:43.5723728+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-18T11:24:43.5723728+00:00"
},
"job_status_id": "be063fcd-6028-4e19-9710-bfdb6f251689",
"job_status_code": "sample string 11",
"db_address_id": "0dcd6abd-cc29-4c14-b8b2-0faf5b8d6fd2",
"contact_id": "fd34a8a6-4127-44be-bc6d-7aa170aea9eb",
"requested_by_company_id": "667d1d70-ea3c-4623-89e0-80305ee20ea2",
"requested_by_contact_id": "4fdf8554-6746-4f30-ad0b-00e738b60134",
"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-02-18T11:24:43.5723728+00:00",
"due_date": "2026-02-18T11:24:43.5723728+00:00",
"date_create": "2026-02-18T11:24:43.5723728+00:00",
"date_update": "2026-02-18T11:24:43.5723728+00:00",
"date_closed": "2026-02-18T11:24:43.5723728+00:00",
"suggested_user_id": "24bcd944-b778-497f-9a9d-64388903cfa4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4b385126-89bd-4bc8-b325-ab8a2a94e0cb",
"db_language_id": "dfbfc1f0-35cc-4f8a-9fdc-947a43ee89a3",
"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-02-18T11:24:43.5723728+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d24815b6-5985-4c2d-bd4e-df2f85443970",
"sales_organization": {
"id": "d316f743-459c-4c58-ac7a-c1ad8b0b2dbf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4641747b-ce88-4bd2-a39a-a508061c98a7",
"db_currency_id": "59319a17-3023-4074-a4b8-07945ca41c74",
"db_language_id": "721a4553-27da-4ac2-baf7-04f65cafcada",
"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-02-18T11:24:43.5723728+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ec8f2e55-52b9-4b96-baac-55e830ec02f3",
"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": "6aaaedf3-bad0-404e-bdba-dd160825655e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-18T11:24:43.5723728+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "234ef95a-0a94-498f-b185-59b598a38ee2"
},
"suggested_date_start": "2026-02-18T11:24:43.5723728+00:00",
"skill_id": "984286b7-03d4-4df9-9084-9292e00acabf",
"skill_code": "sample string 32",
"skill": {
"id": "e742c23b-b593-44f2-badb-c00293692871",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7fea949d-50ff-4961-89c2-d1460a28234c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d316f743-459c-4c58-ac7a-c1ad8b0b2dbf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4641747b-ce88-4bd2-a39a-a508061c98a7",
"db_currency_id": "59319a17-3023-4074-a4b8-07945ca41c74",
"db_language_id": "721a4553-27da-4ac2-baf7-04f65cafcada",
"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-02-18T11:24:43.5723728+00:00"
},
"modified_dateutc": "2026-02-18T11:24:43.5723728+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2321378a-2076-41ab-bf75-45eae923ef7c",
"date_reported_by_company": "2026-02-18T11:24:43.5723728+00:00",
"id2": 36,
"company_id": "e5b74137-c351-47e6-a023-8d8a4d4bbdde",
"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": "2605f805-696b-4076-9676-2c906181056c",
"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-02-18T11:24:43.5723728+00:00"
},
"work_instruction_details_id": "91c99ced-0291-4fc1-912e-7ec49c2a32dd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "debcc38e-80ef-4b06-9bbd-355d2d917158",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "75a6af58-f92e-4e1e-9dcd-4c6bcaa2347d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-18T11:24:43.5723728+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": "3bf816fb-a039-4ea2-8a97-6ec5e1a2aff7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-18T11:24:43.5723728+00:00"
}