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": "4015b6a9-52c3-41ab-976d-697718c2a418",
"jobs_id": "19cdb9a3-bcac-4b48-b5df-4ef0220ab87d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "558b203c-7b41-4c75-9a24-443ac4f3336e",
"_parent_id": "e4af2ccd-a3ac-430a-86ed-2cbd0c5f2b1f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "772bd806-28a6-430a-b688-df8d06d030ed",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e48198b4-2d39-41aa-9d07-c2871fe5e3bf",
"_parent_id": "1eefb160-57d6-4e5d-82a4-0f56dfc87e7d",
"root_parent_id": "e2a75f1b-9e64-49d1-b665-6cf7c5b013e5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a139ddd4-decf-4a98-82f2-8094d19c44f0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "45301dad-cf00-448a-b441-108b6c224e04",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cba61480-efde-4e5e-a2da-91a82cb3b620",
"_parent_code": "sample string 6",
"sales_organization_id": "ee38c109-ee37-4058-b98d-c3381e5cbb40",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ceb44191-80ef-4e9e-a51c-21a4d2314764",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bae402aa-eb37-43ea-a861-8a0ee539b970",
"db_currency_id": "09e17521-b9bb-4b43-ba48-3d666b54f2f2",
"db_language_id": "cb4e4ed7-0dad-42db-80a4-5df7620b796e",
"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-09T15:28:02.2436552+00:00"
},
"modified_dateutc": "2026-10-09T15:28:02.2601342+00:00"
},
"equipment_model_id": "d95f73fd-c9fc-4dfe-9bf5-7f5c69391452",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1c8cf1d1-f65b-487a-add6-a0c0aa1c9121",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9bce7a6a-2768-4d27-91d2-83f9d8d7109e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fbe42d81-e92e-41fe-818b-24f25f7562a6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3afe5067-e076-4635-8d6b-41e69a4409e3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ceb44191-80ef-4e9e-a51c-21a4d2314764",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bae402aa-eb37-43ea-a861-8a0ee539b970",
"db_currency_id": "09e17521-b9bb-4b43-ba48-3d666b54f2f2",
"db_language_id": "cb4e4ed7-0dad-42db-80a4-5df7620b796e",
"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-09T15:28:02.2436552+00:00"
},
"modified_dateutc": "2026-10-09T15:28:02.2601342+00:00"
},
"equipment_family_id": "890fc1a5-cebc-46ec-b285-6840a8a0e993",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "45301dad-cf00-448a-b441-108b6c224e04",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cba61480-efde-4e5e-a2da-91a82cb3b620",
"_parent_code": "sample string 6",
"sales_organization_id": "ee38c109-ee37-4058-b98d-c3381e5cbb40",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ceb44191-80ef-4e9e-a51c-21a4d2314764",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bae402aa-eb37-43ea-a861-8a0ee539b970",
"db_currency_id": "09e17521-b9bb-4b43-ba48-3d666b54f2f2",
"db_language_id": "cb4e4ed7-0dad-42db-80a4-5df7620b796e",
"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-09T15:28:02.2436552+00:00"
},
"modified_dateutc": "2026-10-09T15:28:02.2601342+00:00"
},
"date_in_production_since": "2026-10-09T15:28:02.2601342+00:00",
"date_out_of_production_since": "2026-10-09T15:28:02.2601342+00:00",
"date_end_support": "2026-10-09T15:28:02.2601342+00:00",
"sales_organization_id": "2d1d6ea6-b4f3-4bf5-a535-2b89a9fa73b1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ceb44191-80ef-4e9e-a51c-21a4d2314764",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bae402aa-eb37-43ea-a861-8a0ee539b970",
"db_currency_id": "09e17521-b9bb-4b43-ba48-3d666b54f2f2",
"db_language_id": "cb4e4ed7-0dad-42db-80a4-5df7620b796e",
"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-09T15:28:02.2436552+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-09T15:28:02.2601342+00:00"
},
"project_status_id": "d3a08d4c-0a91-45cc-8f07-2e839beae72a",
"project_status_code": "sample string 10",
"project_status": {
"id": "b4d8a198-23a3-4aed-bef5-b14828d78d77",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "939a1195-f516-472a-aff5-0e2b4562e513",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ceb44191-80ef-4e9e-a51c-21a4d2314764",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bae402aa-eb37-43ea-a861-8a0ee539b970",
"db_currency_id": "09e17521-b9bb-4b43-ba48-3d666b54f2f2",
"db_language_id": "cb4e4ed7-0dad-42db-80a4-5df7620b796e",
"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-09T15:28:02.2436552+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-09T15:28:02.2601342+00:00"
},
"company_id": "29f8ea5c-564a-48d4-8e42-6bfc8a0ebd11",
"company_code": "sample string 12",
"db_address_id": "7ee272fc-57d9-48e3-a53d-0b1ed504e92e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6387e492-1480-4582-af61-17e4ad76495b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8b98761d-8de0-4ca8-bd14-3f1f2cb11690",
"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-09T15:28:02.2601342+00:00",
"date_create": "2026-10-09T15:28:02.2601342+00:00",
"date_update": "2026-10-09T15:28:02.2601342+00:00",
"updated_by_user_id": "41e117f0-18ac-47e0-ae3e-01243350e41b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-09T15:28:02.2601342+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-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-09T15:28:02.2601342+00:00",
"date_last_job": "2026-10-09T15:28:02.2601342+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-09T15:28:02.2601342+00:00",
"modified_dateutc": "2026-10-09T15:28:02.2601342+00:00",
"is_mobile_installation": true
},
"job_type_id": "c11e4aff-4353-4958-9408-f153085f7142",
"job_type_code": "sample string 7",
"job_type": {
"id": "e3abcb64-01a3-43c9-837e-cbbd0731deb2",
"name": "sample string 2",
"sales_organization_id": "21612be5-d560-4976-a117-26bbbdffa17f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-09T15:28:02.2601342+00:00",
"code": "sample string 7"
},
"job_priority_id": "07d4c70e-8f0e-4101-964b-c06eed9e5a2b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "583c30f8-3130-4ac0-889d-ed15ad3aad96",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6b84a0ac-6d41-4d16-8110-8d8aa0ca1e86",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ceb44191-80ef-4e9e-a51c-21a4d2314764",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bae402aa-eb37-43ea-a861-8a0ee539b970",
"db_currency_id": "09e17521-b9bb-4b43-ba48-3d666b54f2f2",
"db_language_id": "cb4e4ed7-0dad-42db-80a4-5df7620b796e",
"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-09T15:28:02.2436552+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-09T15:28:02.2601342+00:00"
},
"job_status_id": "7cc813b5-e306-4249-83e7-b897ecb1c621",
"job_status_code": "sample string 11",
"db_address_id": "4addf722-e32a-4e9b-ae7e-933fe470aaba",
"contact_id": "753cf875-c64f-432b-b3c8-bac239d7b6d5",
"requested_by_company_id": "a2489ce3-a5b4-4161-a3f1-eea06471dcfe",
"requested_by_contact_id": "cbb39833-8fe1-4931-8a03-127e640f75cc",
"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-09T15:28:02.2601342+00:00",
"due_date": "2026-10-09T15:28:02.2601342+00:00",
"date_create": "2026-10-09T15:28:02.2601342+00:00",
"date_update": "2026-10-09T15:28:02.2601342+00:00",
"date_closed": "2026-10-09T15:28:02.2601342+00:00",
"suggested_user_id": "919638aa-ba74-4c8e-8ee9-b353ff243973",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8014c428-4bb0-45f9-8c54-968d211a564f",
"db_language_id": "6d934c8c-7b97-4fe8-abd7-b9807eb65ab5",
"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-09T15:28:02.2601342+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fb33aaed-8f17-4b6e-b421-d2ff01c628d7",
"sales_organization": {
"id": "ceb44191-80ef-4e9e-a51c-21a4d2314764",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bae402aa-eb37-43ea-a861-8a0ee539b970",
"db_currency_id": "09e17521-b9bb-4b43-ba48-3d666b54f2f2",
"db_language_id": "cb4e4ed7-0dad-42db-80a4-5df7620b796e",
"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-09T15:28:02.2436552+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ea0a9c07-6c36-4bd6-992f-b01a68f71cfe",
"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": "0fc8a3eb-e478-417e-9eb4-dc1731017f67",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-09T15:28:02.2601342+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b31aa161-2525-40bf-9af5-37db713b2211"
},
"suggested_date_start": "2026-10-09T15:28:02.2601342+00:00",
"skill_id": "3569d934-5c3c-47d6-b4a4-9db8262c4a46",
"skill_code": "sample string 32",
"skill": {
"id": "cdf46582-4b67-4fc6-8921-fd8e7cc56f35",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "073d72a6-efa8-4180-bc18-0327ecc0e0e9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ceb44191-80ef-4e9e-a51c-21a4d2314764",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bae402aa-eb37-43ea-a861-8a0ee539b970",
"db_currency_id": "09e17521-b9bb-4b43-ba48-3d666b54f2f2",
"db_language_id": "cb4e4ed7-0dad-42db-80a4-5df7620b796e",
"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-09T15:28:02.2436552+00:00"
},
"modified_dateutc": "2026-10-09T15:28:02.2601342+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a35ca4a8-6ca7-4457-a922-7cefea614eec",
"date_reported_by_company": "2026-10-09T15:28:02.2601342+00:00",
"id2": 36,
"company_id": "176e6142-47df-4d32-84cf-3ed80c06b7df",
"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": "e7b36340-7b9a-408e-a0d7-7f471864acfb",
"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-09T15:28:02.2601342+00:00"
},
"work_instruction_details_id": "d20b8bab-f499-4c6a-9e1c-5764f21ccab5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a0b22c52-c271-401f-a698-ad7296e9cc98",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d304df9a-bb01-44a6-8164-0ca6fd3adca0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-09T15:28:02.2601342+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": "12e09e30-77fe-4658-8432-5bd207c51c38",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-09T15:28:02.2601342+00:00"
}