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": "fe7f52cb-ae46-4988-a143-0ad7ce680067",
"jobs_id": "def9ca6b-b063-42c5-9527-a390604e2e2a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f14a24a5-82fe-4fd6-9d73-d9f2d1b63845",
"_parent_id": "fa3391a7-933b-4139-96a8-6f4968ad185f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2cd3fe53-9475-4f0c-addd-9363415da2a4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6de95e6c-7290-4c62-8de8-fe01d079e576",
"_parent_id": "09f4f9ab-a7f8-4796-b6ad-61dab9e4c81a",
"root_parent_id": "498bd530-edfa-4b36-9bde-4daed3865ca2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e4aee627-dc49-4d7b-aeed-5bfeb353eed6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "dbb57974-5a0a-4f22-b0c4-7234a17b38a9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "52aa0fc7-8200-4ab7-bc15-711b79e7e793",
"_parent_code": "sample string 6",
"sales_organization_id": "59dd94fa-dac9-4817-8a4e-89e3e24c739d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a465f5c4-efc9-4b6b-a33e-fb4b11961249",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6cb82b6-4c7c-4efb-8da0-d238e5e2b6cc",
"db_currency_id": "919cb3f4-e6fd-4c65-bbc9-ce72c4686aa3",
"db_language_id": "469efee4-764a-48fa-9210-5528dc61df38",
"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-12-30T02:43:11.375601+00:00"
},
"modified_dateutc": "2025-12-30T02:43:11.375601+00:00"
},
"equipment_model_id": "466392b6-a983-45ab-99f4-638b4068c641",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "db301a49-8361-4b70-98fb-471e4eccbbf3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f8492fa8-f3da-4e25-903e-3d92e4825b4a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f20277ac-0f66-4c4b-a427-0d3137263f60",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "10635157-6e5c-4f16-91e0-f5febe76f050",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a465f5c4-efc9-4b6b-a33e-fb4b11961249",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6cb82b6-4c7c-4efb-8da0-d238e5e2b6cc",
"db_currency_id": "919cb3f4-e6fd-4c65-bbc9-ce72c4686aa3",
"db_language_id": "469efee4-764a-48fa-9210-5528dc61df38",
"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-12-30T02:43:11.375601+00:00"
},
"modified_dateutc": "2025-12-30T02:43:11.375601+00:00"
},
"equipment_family_id": "1fc0db24-f1b9-4a42-a592-bd498298601f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "dbb57974-5a0a-4f22-b0c4-7234a17b38a9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "52aa0fc7-8200-4ab7-bc15-711b79e7e793",
"_parent_code": "sample string 6",
"sales_organization_id": "59dd94fa-dac9-4817-8a4e-89e3e24c739d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a465f5c4-efc9-4b6b-a33e-fb4b11961249",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6cb82b6-4c7c-4efb-8da0-d238e5e2b6cc",
"db_currency_id": "919cb3f4-e6fd-4c65-bbc9-ce72c4686aa3",
"db_language_id": "469efee4-764a-48fa-9210-5528dc61df38",
"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-12-30T02:43:11.375601+00:00"
},
"modified_dateutc": "2025-12-30T02:43:11.375601+00:00"
},
"date_in_production_since": "2025-12-30T02:43:11.375601+00:00",
"date_out_of_production_since": "2025-12-30T02:43:11.375601+00:00",
"date_end_support": "2025-12-30T02:43:11.375601+00:00",
"sales_organization_id": "e46e63cc-491f-4f37-9e7e-b2a212945c9b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a465f5c4-efc9-4b6b-a33e-fb4b11961249",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6cb82b6-4c7c-4efb-8da0-d238e5e2b6cc",
"db_currency_id": "919cb3f4-e6fd-4c65-bbc9-ce72c4686aa3",
"db_language_id": "469efee4-764a-48fa-9210-5528dc61df38",
"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-12-30T02:43:11.375601+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-12-30T02:43:11.3912241+00:00"
},
"project_status_id": "e02b1e2b-a9bf-4dd1-81e3-8d75c8dc38ee",
"project_status_code": "sample string 10",
"project_status": {
"id": "dc9248b8-9ad3-4ff1-a368-5ae6818d5206",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "01d5408c-2a21-4cf5-be63-2b67765455bc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a465f5c4-efc9-4b6b-a33e-fb4b11961249",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6cb82b6-4c7c-4efb-8da0-d238e5e2b6cc",
"db_currency_id": "919cb3f4-e6fd-4c65-bbc9-ce72c4686aa3",
"db_language_id": "469efee4-764a-48fa-9210-5528dc61df38",
"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-12-30T02:43:11.375601+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-30T02:43:11.3912241+00:00"
},
"company_id": "e883cb8b-143a-4271-bc00-57e47bafcc19",
"company_code": "sample string 12",
"db_address_id": "df87707d-a356-4943-91f8-9fbb48caa37f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "83bea1d5-d35a-4220-a9c5-50fdb1cb81be",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f22ec66b-5fb3-4e3c-82e1-d12a978573d2",
"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-12-30T02:43:11.3912241+00:00",
"date_create": "2025-12-30T02:43:11.3912241+00:00",
"date_update": "2025-12-30T02:43:11.3912241+00:00",
"updated_by_user_id": "b6935dc1-159d-4e32-9801-4626f77c825d",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-30T02:43:11.3912241+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-12-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-30T02:43:11.3912241+00:00",
"date_last_job": "2025-12-30T02:43:11.3912241+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-30T02:43:11.3912241+00:00",
"modified_dateutc": "2025-12-30T02:43:11.3912241+00:00",
"is_mobile_installation": true
},
"job_type_id": "833c3354-74ed-4c0e-ae3b-670ad7276088",
"job_type_code": "sample string 7",
"job_type": {
"id": "c60c3430-d157-4537-a87d-df1d5609c998",
"name": "sample string 2",
"sales_organization_id": "3559b7bd-51e8-4625-b551-9f822c9860b4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-30T02:43:11.3912241+00:00",
"code": "sample string 7"
},
"job_priority_id": "1d878098-a797-4e4b-9867-7a164b538274",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b1530abc-b76e-465e-a988-1db6f0866551",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c92c3763-0e6c-4def-b69c-5c59997ae5f4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a465f5c4-efc9-4b6b-a33e-fb4b11961249",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6cb82b6-4c7c-4efb-8da0-d238e5e2b6cc",
"db_currency_id": "919cb3f4-e6fd-4c65-bbc9-ce72c4686aa3",
"db_language_id": "469efee4-764a-48fa-9210-5528dc61df38",
"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-12-30T02:43:11.375601+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-30T02:43:11.3912241+00:00"
},
"job_status_id": "65de3fa6-7710-4f46-98e3-e8433b104c87",
"job_status_code": "sample string 11",
"db_address_id": "d71273e6-f237-4db3-8845-6c8977bfe6d9",
"contact_id": "bdfe232b-9bbc-4bd8-a3b6-f7d20dec0500",
"requested_by_company_id": "19122e0e-5e4e-4161-9abc-85e7a4ccb5ef",
"requested_by_contact_id": "4d85c5db-f8ff-41ba-9347-285fcdf707a2",
"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-12-30T02:43:11.3912241+00:00",
"due_date": "2025-12-30T02:43:11.3912241+00:00",
"date_create": "2025-12-30T02:43:11.3912241+00:00",
"date_update": "2025-12-30T02:43:11.3912241+00:00",
"date_closed": "2025-12-30T02:43:11.3912241+00:00",
"suggested_user_id": "130df168-aca3-4193-9d90-127a1a3b0109",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "88197e5a-9efc-4083-86d2-aee74c025719",
"db_language_id": "468521a4-154e-4453-87f6-d5f0c736925a",
"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-12-30T02:43:11.3912241+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6cf2a0d4-ed4a-4a39-a538-ee72a797c2bc",
"sales_organization": {
"id": "a465f5c4-efc9-4b6b-a33e-fb4b11961249",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6cb82b6-4c7c-4efb-8da0-d238e5e2b6cc",
"db_currency_id": "919cb3f4-e6fd-4c65-bbc9-ce72c4686aa3",
"db_language_id": "469efee4-764a-48fa-9210-5528dc61df38",
"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-12-30T02:43:11.375601+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "61e53109-1aea-4221-9983-aa25e63ab038",
"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": "128d39b7-ef4f-4406-ac13-5777bb66de71",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-30T02:43:11.3912241+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7517e24f-3695-4731-9956-5118a8091edc"
},
"suggested_date_start": "2025-12-30T02:43:11.3912241+00:00",
"skill_id": "4e6c246c-6ae4-48a9-9fbd-c243fcce9163",
"skill_code": "sample string 32",
"skill": {
"id": "ca381961-20cb-42a1-8dc0-e45bf8ae9ce9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6920fcb9-b28b-4663-aa96-dc3b47b261cd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a465f5c4-efc9-4b6b-a33e-fb4b11961249",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6cb82b6-4c7c-4efb-8da0-d238e5e2b6cc",
"db_currency_id": "919cb3f4-e6fd-4c65-bbc9-ce72c4686aa3",
"db_language_id": "469efee4-764a-48fa-9210-5528dc61df38",
"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-12-30T02:43:11.375601+00:00"
},
"modified_dateutc": "2025-12-30T02:43:11.3912241+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d3c17b2b-633a-4e76-b34b-65bd7ed9d368",
"date_reported_by_company": "2025-12-30T02:43:11.3912241+00:00",
"id2": 36,
"company_id": "98dee921-f37d-4863-a9db-f479d1fdd0a7",
"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": "86b88e1b-628d-409a-8d58-ce30c7d2a1b2",
"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-12-30T02:43:11.3912241+00:00"
},
"work_instruction_details_id": "d0737f05-2753-4066-977e-6479cc47f74b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e1f6130b-498d-4992-a623-e3df80d79965",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2e024545-2296-43bd-9ec0-8482ce63c38e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-30T02:43:11.3912241+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": "94b09a0f-235e-4bbf-8f84-d6d764999ef5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-30T02:43:11.3912241+00:00"
}