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": "affd2cbf-7233-4c70-a75c-42da4fe96888",
"jobs_id": "7eb80e82-987b-4753-87b7-919fa79c48cf",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "95a3d13a-5168-4529-91e5-6291fca53c7d",
"_parent_id": "f6da7aa3-0ccc-4a69-8820-b882dab9a340",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "34cebc1d-4eed-4692-8904-546e2c83c1b2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "30f5228c-d843-4726-9f3a-1904a08d8a90",
"_parent_id": "1fb9e179-2510-4c0a-b3c7-a3810c7f4521",
"root_parent_id": "c09873b6-1c8c-46cc-b7a2-6b4248effd7b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bee1e301-9f38-4120-ac1b-395449a5da3d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bb13a675-9e23-411a-bd0a-02deab4aa0ea",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9648950e-4b5c-44dc-a358-d2421aebec68",
"_parent_code": "sample string 6",
"sales_organization_id": "9a21cd4b-dee2-4117-a36a-1306ce23e974",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f9eea278-026e-414d-8d6e-97a1752c9714",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a5044402-2d77-44eb-9bbb-6168609bab35",
"db_currency_id": "16fefd5c-4065-42e3-ab13-17f11cb94df5",
"db_language_id": "03b76bf2-f3d3-46a7-b831-1c3aa6445c7f",
"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-01-19T13:41:00.8830486+00:00"
},
"modified_dateutc": "2026-01-19T13:41:00.8830486+00:00"
},
"equipment_model_id": "a8cfa50c-b4b2-4822-8691-d3873216cd9b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "800f8396-cd95-4f68-a4cc-026836e8a666",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "488eebbc-deea-4845-b1ae-9372054b4765",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a9870013-1588-454f-8a22-4788097a0cb6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c7d08191-2d0b-41cd-8648-21ae3b8c123d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f9eea278-026e-414d-8d6e-97a1752c9714",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a5044402-2d77-44eb-9bbb-6168609bab35",
"db_currency_id": "16fefd5c-4065-42e3-ab13-17f11cb94df5",
"db_language_id": "03b76bf2-f3d3-46a7-b831-1c3aa6445c7f",
"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-01-19T13:41:00.8830486+00:00"
},
"modified_dateutc": "2026-01-19T13:41:00.8830486+00:00"
},
"equipment_family_id": "4e8dee89-0381-4c19-a652-948cd1574e1b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bb13a675-9e23-411a-bd0a-02deab4aa0ea",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9648950e-4b5c-44dc-a358-d2421aebec68",
"_parent_code": "sample string 6",
"sales_organization_id": "9a21cd4b-dee2-4117-a36a-1306ce23e974",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f9eea278-026e-414d-8d6e-97a1752c9714",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a5044402-2d77-44eb-9bbb-6168609bab35",
"db_currency_id": "16fefd5c-4065-42e3-ab13-17f11cb94df5",
"db_language_id": "03b76bf2-f3d3-46a7-b831-1c3aa6445c7f",
"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-01-19T13:41:00.8830486+00:00"
},
"modified_dateutc": "2026-01-19T13:41:00.8830486+00:00"
},
"date_in_production_since": "2026-01-19T13:41:00.8830486+00:00",
"date_out_of_production_since": "2026-01-19T13:41:00.8830486+00:00",
"date_end_support": "2026-01-19T13:41:00.8830486+00:00",
"sales_organization_id": "db7e512a-c17f-46db-89ce-197060e10ca4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f9eea278-026e-414d-8d6e-97a1752c9714",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a5044402-2d77-44eb-9bbb-6168609bab35",
"db_currency_id": "16fefd5c-4065-42e3-ab13-17f11cb94df5",
"db_language_id": "03b76bf2-f3d3-46a7-b831-1c3aa6445c7f",
"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-01-19T13:41:00.8830486+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-01-19T13:41:00.8830486+00:00"
},
"project_status_id": "e6d3e5af-20a4-43e2-9895-3c02485d86dc",
"project_status_code": "sample string 10",
"project_status": {
"id": "019c039d-5dc1-4745-a643-712dc0950e4c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fa4be001-5477-4f83-8a73-9c5e100a6fa1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f9eea278-026e-414d-8d6e-97a1752c9714",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a5044402-2d77-44eb-9bbb-6168609bab35",
"db_currency_id": "16fefd5c-4065-42e3-ab13-17f11cb94df5",
"db_language_id": "03b76bf2-f3d3-46a7-b831-1c3aa6445c7f",
"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-01-19T13:41:00.8830486+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-19T13:41:00.8830486+00:00"
},
"company_id": "ce9dc6f8-dcb5-4e9e-b0f3-674220f684e8",
"company_code": "sample string 12",
"db_address_id": "64dee22c-cde1-45c5-a122-d8af698f6b9e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5144c8b9-72b1-4cd5-b3a4-2b24a70d35c9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "12706cf6-5689-48fa-b162-51f70bd941e0",
"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-01-19T13:41:00.8830486+00:00",
"date_create": "2026-01-19T13:41:00.8830486+00:00",
"date_update": "2026-01-19T13:41:00.8830486+00:00",
"updated_by_user_id": "bdebcf21-7e9f-450e-b8a0-c70dc756ad21",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-19T13:41:00.8830486+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-01-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-19T13:41:00.8830486+00:00",
"date_last_job": "2026-01-19T13:41:00.8830486+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-19T13:41:00.8830486+00:00",
"modified_dateutc": "2026-01-19T13:41:00.8830486+00:00",
"is_mobile_installation": true
},
"job_type_id": "3ab0948c-743d-4463-9831-bf670283bc60",
"job_type_code": "sample string 7",
"job_type": {
"id": "54b9754b-bb15-4d2a-ba6b-f6639d0c169f",
"name": "sample string 2",
"sales_organization_id": "4d5eed9f-674d-4f0f-896e-96e34afed259",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-19T13:41:00.8830486+00:00",
"code": "sample string 7"
},
"job_priority_id": "ff046f4e-c100-404d-b29d-62d99b180be6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "05fd0461-e121-4e29-802e-8d41aa3f6b9c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "57199f44-e393-433b-abef-b4a506f1d0e3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f9eea278-026e-414d-8d6e-97a1752c9714",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a5044402-2d77-44eb-9bbb-6168609bab35",
"db_currency_id": "16fefd5c-4065-42e3-ab13-17f11cb94df5",
"db_language_id": "03b76bf2-f3d3-46a7-b831-1c3aa6445c7f",
"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-01-19T13:41:00.8830486+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-19T13:41:00.8830486+00:00"
},
"job_status_id": "75251b5d-abcb-4360-9c83-28d2b3f8b917",
"job_status_code": "sample string 11",
"db_address_id": "77dd9693-7590-4a8f-83a4-212f6ad1f956",
"contact_id": "27e7c162-eede-4ec2-8326-964ee7d08b45",
"requested_by_company_id": "526dd404-1883-444c-a6aa-c4762a22cd86",
"requested_by_contact_id": "fb3e04bf-b21a-4a66-9970-c174469571b0",
"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-01-19T13:41:00.8830486+00:00",
"due_date": "2026-01-19T13:41:00.8830486+00:00",
"date_create": "2026-01-19T13:41:00.8830486+00:00",
"date_update": "2026-01-19T13:41:00.8830486+00:00",
"date_closed": "2026-01-19T13:41:00.8830486+00:00",
"suggested_user_id": "7c014431-a425-4138-82df-78dc5b05c564",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3bce13d2-f7e1-4d67-9861-e9fcb35ea978",
"db_language_id": "7e6ee6b1-cd3b-45ed-9989-787d8057cd94",
"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-01-19T13:41:00.8830486+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e58081bc-fdc5-407d-9c24-827aa691d00b",
"sales_organization": {
"id": "f9eea278-026e-414d-8d6e-97a1752c9714",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a5044402-2d77-44eb-9bbb-6168609bab35",
"db_currency_id": "16fefd5c-4065-42e3-ab13-17f11cb94df5",
"db_language_id": "03b76bf2-f3d3-46a7-b831-1c3aa6445c7f",
"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-01-19T13:41:00.8830486+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e6ec3f9c-5418-474e-9a3e-39318b93c78d",
"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": "03aa747a-2c4d-4c58-ab8f-a9027f756e4b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-19T13:41:00.8830486+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1cf5d9b1-63e8-4e97-a424-c85a45419e42"
},
"suggested_date_start": "2026-01-19T13:41:00.8830486+00:00",
"skill_id": "870ca5b7-d3f5-4c1b-abbb-c6e1f8a96b94",
"skill_code": "sample string 32",
"skill": {
"id": "bd3ded12-5aa5-4562-b098-56bb4a040d1a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "87692f6e-4754-438b-995d-4b222a813916",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f9eea278-026e-414d-8d6e-97a1752c9714",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a5044402-2d77-44eb-9bbb-6168609bab35",
"db_currency_id": "16fefd5c-4065-42e3-ab13-17f11cb94df5",
"db_language_id": "03b76bf2-f3d3-46a7-b831-1c3aa6445c7f",
"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-01-19T13:41:00.8830486+00:00"
},
"modified_dateutc": "2026-01-19T13:41:00.8830486+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a082950e-0d2d-4313-9200-cdb1c153ee21",
"date_reported_by_company": "2026-01-19T13:41:00.8830486+00:00",
"id2": 36,
"company_id": "0b04b221-176c-425e-990e-c54084399b7f",
"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": "c66bf8d7-88b9-4be3-aec0-2c683aed259f",
"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-01-19T13:41:00.8830486+00:00"
},
"work_instruction_details_id": "77573777-621f-4754-bcc6-b76240531f45",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b05648d9-0f71-4b72-9114-2424fa670581",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6e2330f5-133e-442f-a8da-7c119b5e08b3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-19T13:41:00.8830486+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": "b13a5d7c-d0e9-48ce-9e81-fe42bac85c8d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-19T13:41:00.8830486+00:00"
}