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": "3d9b4a49-1332-4b3f-a7d3-a9aa991b4231",
"jobs_id": "a1a9622e-9a61-46c1-ab3d-d5ac546f050e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c3a7f3ad-854c-4951-ae05-a3e9f8bd3ac1",
"_parent_id": "b16c5583-db42-4830-9e8f-591305ddd3e0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "402ecc2c-c43a-4e43-bc61-eaeb6b05a515",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1af6e8a5-cf8c-48f9-adad-aafe78e1bac9",
"_parent_id": "2b43a2aa-08ad-462b-b993-93bda1fdf465",
"root_parent_id": "63bff1e6-e4a2-45e2-88fd-acaa7cc425a2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2ce48ff7-c974-49c9-baff-4a11e1cf38be",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7ef0f8ec-6de0-4a01-b15c-fed816e8d774",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e6b5401f-c67b-4605-ba9d-16475db1b7e6",
"_parent_code": "sample string 6",
"sales_organization_id": "f8c63459-a60a-48c6-bb13-d031121f0094",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "adf2d69e-1228-4ec7-a180-8e5e37c63f28",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50687b26-176d-4d5b-a92a-bdcd94e18d4b",
"db_currency_id": "c93c0612-af8c-4c96-9724-136cd4653b1b",
"db_language_id": "6c92eb54-820c-48e5-9b7b-85ad56442787",
"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-08-19T14:22:35.6338473+00:00"
},
"modified_dateutc": "2026-08-19T14:22:35.6338473+00:00"
},
"equipment_model_id": "58f09b59-0496-4e46-9b6a-761aa4ce35d0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "eeba4f9b-f9c0-4ece-88bb-5c9151894fe7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0bbd69d2-246e-4f8a-bdf0-b49864f87b38",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a9d13205-9c26-4208-99bf-0c700089865f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e2e8ec47-0fc0-4dd6-a548-201a952bad83",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "adf2d69e-1228-4ec7-a180-8e5e37c63f28",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50687b26-176d-4d5b-a92a-bdcd94e18d4b",
"db_currency_id": "c93c0612-af8c-4c96-9724-136cd4653b1b",
"db_language_id": "6c92eb54-820c-48e5-9b7b-85ad56442787",
"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-08-19T14:22:35.6338473+00:00"
},
"modified_dateutc": "2026-08-19T14:22:35.6338473+00:00"
},
"equipment_family_id": "5bb9d19f-9265-4a51-96db-170aa127123f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7ef0f8ec-6de0-4a01-b15c-fed816e8d774",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e6b5401f-c67b-4605-ba9d-16475db1b7e6",
"_parent_code": "sample string 6",
"sales_organization_id": "f8c63459-a60a-48c6-bb13-d031121f0094",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "adf2d69e-1228-4ec7-a180-8e5e37c63f28",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50687b26-176d-4d5b-a92a-bdcd94e18d4b",
"db_currency_id": "c93c0612-af8c-4c96-9724-136cd4653b1b",
"db_language_id": "6c92eb54-820c-48e5-9b7b-85ad56442787",
"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-08-19T14:22:35.6338473+00:00"
},
"modified_dateutc": "2026-08-19T14:22:35.6338473+00:00"
},
"date_in_production_since": "2026-08-19T14:22:35.6338473+00:00",
"date_out_of_production_since": "2026-08-19T14:22:35.6338473+00:00",
"date_end_support": "2026-08-19T14:22:35.6338473+00:00",
"sales_organization_id": "9afd619f-ece8-4829-be14-b92ba3cb208a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "adf2d69e-1228-4ec7-a180-8e5e37c63f28",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50687b26-176d-4d5b-a92a-bdcd94e18d4b",
"db_currency_id": "c93c0612-af8c-4c96-9724-136cd4653b1b",
"db_language_id": "6c92eb54-820c-48e5-9b7b-85ad56442787",
"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-08-19T14:22:35.6338473+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-08-19T14:22:35.6338473+00:00"
},
"project_status_id": "5840b81e-6af9-46d0-a8f5-af56170e3871",
"project_status_code": "sample string 10",
"project_status": {
"id": "bda0ff3f-b59f-4bd2-bab4-4fcfad040e4d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7260090b-c8d6-41c0-a7d4-d5428f4c4e29",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "adf2d69e-1228-4ec7-a180-8e5e37c63f28",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50687b26-176d-4d5b-a92a-bdcd94e18d4b",
"db_currency_id": "c93c0612-af8c-4c96-9724-136cd4653b1b",
"db_language_id": "6c92eb54-820c-48e5-9b7b-85ad56442787",
"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-08-19T14:22:35.6338473+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-19T14:22:35.6338473+00:00"
},
"company_id": "90fbdbf1-2a3a-467a-8e23-97ed5df4fcfb",
"company_code": "sample string 12",
"db_address_id": "9932dd45-12df-48ce-a7f0-376f3595752c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "16acd589-dc1c-476e-82e0-633ee3068c2a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "994497b4-b375-448f-9838-9a9b64aa24e0",
"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-08-19T14:22:35.6338473+00:00",
"date_create": "2026-08-19T14:22:35.6338473+00:00",
"date_update": "2026-08-19T14:22:35.6338473+00:00",
"updated_by_user_id": "e8421b93-0a63-441c-8af9-2d9143a569d7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-19T14:22:35.6338473+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-08-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-19T14:22:35.6338473+00:00",
"date_last_job": "2026-08-19T14:22:35.6338473+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-19T14:22:35.6338473+00:00",
"modified_dateutc": "2026-08-19T14:22:35.6338473+00:00",
"is_mobile_installation": true
},
"job_type_id": "079ca3a1-3e7f-4818-a168-8b0d07a34d3c",
"job_type_code": "sample string 7",
"job_type": {
"id": "36395d90-b744-4057-904e-ba99dd0c7604",
"name": "sample string 2",
"sales_organization_id": "2a505327-ce17-4211-b8f5-bd88ac1cd8fd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-19T14:22:35.6338473+00:00",
"code": "sample string 7"
},
"job_priority_id": "8a8ed028-7c84-4dfc-9ed1-9cbaacf0e147",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5f79551b-f3a9-42f9-93ff-ac4fbfad05e0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "94837188-0d6d-499e-8819-4d73b91fc2db",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "adf2d69e-1228-4ec7-a180-8e5e37c63f28",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50687b26-176d-4d5b-a92a-bdcd94e18d4b",
"db_currency_id": "c93c0612-af8c-4c96-9724-136cd4653b1b",
"db_language_id": "6c92eb54-820c-48e5-9b7b-85ad56442787",
"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-08-19T14:22:35.6338473+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-19T14:22:35.6338473+00:00"
},
"job_status_id": "9301a51e-cb6a-4dad-bde8-7aeb561100d8",
"job_status_code": "sample string 11",
"db_address_id": "27c10bdf-96b5-440c-881f-8dc82518287a",
"contact_id": "aad47059-1dfc-42b0-af57-4c8ecdbe73c7",
"requested_by_company_id": "aebe6f24-432a-4f2a-a03a-41ff522fa420",
"requested_by_contact_id": "0810e691-7a8b-4684-a99f-302923ab9634",
"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-08-19T14:22:35.6338473+00:00",
"due_date": "2026-08-19T14:22:35.6338473+00:00",
"date_create": "2026-08-19T14:22:35.6338473+00:00",
"date_update": "2026-08-19T14:22:35.6338473+00:00",
"date_closed": "2026-08-19T14:22:35.6338473+00:00",
"suggested_user_id": "901bdee3-491e-4fe8-b7d5-511eec82c132",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ba178e58-68a4-40b9-adfe-0639df0a7d7c",
"db_language_id": "efd0a041-c3c2-44d2-a26d-179b18ddf31a",
"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-08-19T14:22:35.6338473+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dcd7dd55-4f97-4057-ab9b-380371583572",
"sales_organization": {
"id": "adf2d69e-1228-4ec7-a180-8e5e37c63f28",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50687b26-176d-4d5b-a92a-bdcd94e18d4b",
"db_currency_id": "c93c0612-af8c-4c96-9724-136cd4653b1b",
"db_language_id": "6c92eb54-820c-48e5-9b7b-85ad56442787",
"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-08-19T14:22:35.6338473+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5a681a2a-958a-454f-acf4-4cd4a0c2dfa7",
"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": "8b34d576-3e61-4aee-95de-eb5058c3c713",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-19T14:22:35.6338473+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c26f9b50-dc77-4e03-a546-a0167af32bc4"
},
"suggested_date_start": "2026-08-19T14:22:35.6338473+00:00",
"skill_id": "3db46b84-6a6d-4edc-bef4-def4bb66506d",
"skill_code": "sample string 32",
"skill": {
"id": "bac3ea1c-104f-4313-95f7-544e3c9bec8a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ed4a6f5f-1532-4319-a894-c9a34166eec2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "adf2d69e-1228-4ec7-a180-8e5e37c63f28",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50687b26-176d-4d5b-a92a-bdcd94e18d4b",
"db_currency_id": "c93c0612-af8c-4c96-9724-136cd4653b1b",
"db_language_id": "6c92eb54-820c-48e5-9b7b-85ad56442787",
"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-08-19T14:22:35.6338473+00:00"
},
"modified_dateutc": "2026-08-19T14:22:35.6338473+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3a30a28b-84e2-488a-93a1-f8198d829198",
"date_reported_by_company": "2026-08-19T14:22:35.6338473+00:00",
"id2": 36,
"company_id": "1804a172-6b0f-435c-9722-8c9ed0d6ba64",
"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": "4d0531bb-bf9f-4abb-aa37-6e0160d924fe",
"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-08-19T14:22:35.6338473+00:00"
},
"work_instruction_details_id": "04d656e9-3add-4399-97d8-e9775d33aa85",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a5882a1e-fc67-4233-ab92-a78086efd23b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "94ba2c5c-4318-4895-a8af-4565618492c1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-19T14:22:35.6338473+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": "e09825ce-58cb-4c98-a01a-5f01b5eb031c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-19T14:22:35.6338473+00:00"
}