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": "9db7c83a-2f5e-47cf-955f-5a1a810dcd34",
"jobs_id": "66b5cc1e-9472-4cb8-950b-7e54d80a2401",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5bc72263-5d61-4f68-bd9e-ad3738bf1164",
"_parent_id": "17765ea3-8968-49fa-81a5-601ca0088de9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4329679b-4d71-4382-8ed0-f1d04f23b47a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3960eca7-9b25-425a-84bd-e7f6b33c89af",
"_parent_id": "b4fa1313-a23b-40bf-8351-2b745d970577",
"root_parent_id": "0e69dc2a-1410-470b-a0d9-abd065d581f5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bda20c43-8e90-4cb0-8a48-8dd7b82e6065",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e0a9e4cb-1ddc-419f-afe1-1766bd6bbd6f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2e02d733-1b1a-4242-b07c-4df3afd260fa",
"_parent_code": "sample string 6",
"sales_organization_id": "0d0f358f-52d2-4f5f-9c49-a3021aff423d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9cb8cbef-86a4-4063-b51f-9926b90fa370",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a9f28ef-79c7-404d-9a61-12147970fc59",
"db_currency_id": "44892dfd-4e36-49f0-8715-f4a4bdb96378",
"db_language_id": "e31fbca4-9b9e-4353-8a16-a162ae3152b6",
"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-10-02T19:42:07.7892746+00:00"
},
"modified_dateutc": "2025-10-02T19:42:07.7892746+00:00"
},
"equipment_model_id": "bfa3d558-0efd-4069-9d48-79b580819dac",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "67d1e81b-7601-4a21-8584-e10d391b68f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7e32cf38-5913-4a22-b96c-a33c6263baa1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1d118387-d16b-421e-934d-ee3d70d969e9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e5172c18-8ce9-4e0b-9687-40c945609eb3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9cb8cbef-86a4-4063-b51f-9926b90fa370",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a9f28ef-79c7-404d-9a61-12147970fc59",
"db_currency_id": "44892dfd-4e36-49f0-8715-f4a4bdb96378",
"db_language_id": "e31fbca4-9b9e-4353-8a16-a162ae3152b6",
"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-10-02T19:42:07.7892746+00:00"
},
"modified_dateutc": "2025-10-02T19:42:07.7892746+00:00"
},
"equipment_family_id": "681edab8-4638-4f68-81f2-5cbfd47d7f10",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e0a9e4cb-1ddc-419f-afe1-1766bd6bbd6f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2e02d733-1b1a-4242-b07c-4df3afd260fa",
"_parent_code": "sample string 6",
"sales_organization_id": "0d0f358f-52d2-4f5f-9c49-a3021aff423d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9cb8cbef-86a4-4063-b51f-9926b90fa370",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a9f28ef-79c7-404d-9a61-12147970fc59",
"db_currency_id": "44892dfd-4e36-49f0-8715-f4a4bdb96378",
"db_language_id": "e31fbca4-9b9e-4353-8a16-a162ae3152b6",
"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-10-02T19:42:07.7892746+00:00"
},
"modified_dateutc": "2025-10-02T19:42:07.7892746+00:00"
},
"date_in_production_since": "2025-10-02T19:42:07.7892746+00:00",
"date_out_of_production_since": "2025-10-02T19:42:07.7892746+00:00",
"date_end_support": "2025-10-02T19:42:07.7892746+00:00",
"sales_organization_id": "926ee0b3-f56c-4314-86fc-82659c40f78f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9cb8cbef-86a4-4063-b51f-9926b90fa370",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a9f28ef-79c7-404d-9a61-12147970fc59",
"db_currency_id": "44892dfd-4e36-49f0-8715-f4a4bdb96378",
"db_language_id": "e31fbca4-9b9e-4353-8a16-a162ae3152b6",
"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-10-02T19:42:07.7892746+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-10-02T19:42:07.7892746+00:00"
},
"project_status_id": "91b26d3d-6ea3-49c1-9edb-f723a86748eb",
"project_status_code": "sample string 10",
"project_status": {
"id": "ee4e3286-ea53-4c71-bf20-2920d4f5eaeb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "81ebcbd0-b96d-4ab1-a1c3-300170b43af3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9cb8cbef-86a4-4063-b51f-9926b90fa370",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a9f28ef-79c7-404d-9a61-12147970fc59",
"db_currency_id": "44892dfd-4e36-49f0-8715-f4a4bdb96378",
"db_language_id": "e31fbca4-9b9e-4353-8a16-a162ae3152b6",
"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-10-02T19:42:07.7892746+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-02T19:42:07.7892746+00:00"
},
"company_id": "aaadb6e3-59a0-4115-9a09-fb815f3fe083",
"company_code": "sample string 12",
"db_address_id": "a931f11a-7f92-4f77-8f4c-c5c5f31f1a49",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7ed59260-50b0-48ff-8468-d80d940d8536",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "33c10a5d-7dab-46f3-a6d7-1ee89ea383a5",
"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-10-02T19:42:07.7892746+00:00",
"date_create": "2025-10-02T19:42:07.7892746+00:00",
"date_update": "2025-10-02T19:42:07.7892746+00:00",
"updated_by_user_id": "fd44eec0-406d-4389-a847-4d317c023e9b",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-02T19:42:07.7892746+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-10-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-02T19:42:07.7892746+00:00",
"date_last_job": "2025-10-02T19:42:07.7892746+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-02T19:42:07.7892746+00:00",
"modified_dateutc": "2025-10-02T19:42:07.7892746+00:00",
"is_mobile_installation": true
},
"job_type_id": "3e2bf24d-0979-42c3-821f-8eed7882dc0f",
"job_type_code": "sample string 7",
"job_type": {
"id": "ef7e8906-a091-43e7-8085-1614f0427623",
"name": "sample string 2",
"sales_organization_id": "c17e5d06-360c-422d-a93c-5c85be5f1da5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-02T19:42:07.7892746+00:00",
"code": "sample string 7"
},
"job_priority_id": "82879ccb-1216-40e8-a5f7-47e4f7c1aed5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cb518c6c-aada-4c3d-bafa-9efeef91c3c0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4bd45721-902e-42a4-bb40-c672976816fe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9cb8cbef-86a4-4063-b51f-9926b90fa370",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a9f28ef-79c7-404d-9a61-12147970fc59",
"db_currency_id": "44892dfd-4e36-49f0-8715-f4a4bdb96378",
"db_language_id": "e31fbca4-9b9e-4353-8a16-a162ae3152b6",
"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-10-02T19:42:07.7892746+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-02T19:42:07.7892746+00:00"
},
"job_status_id": "d07eb061-5c49-4af9-88db-bca9c35ef704",
"job_status_code": "sample string 11",
"db_address_id": "cfc5985a-d7a5-47bf-80de-683812e11722",
"contact_id": "3ef5c3c4-83e4-4c8f-9a64-a6ffea94b48f",
"requested_by_company_id": "f7ca91e2-3f5d-493d-a3b2-d7d2fa18661e",
"requested_by_contact_id": "53e16f46-063e-46ca-aa66-620499e67cd0",
"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-10-02T19:42:07.7892746+00:00",
"due_date": "2025-10-02T19:42:07.7892746+00:00",
"date_create": "2025-10-02T19:42:07.7892746+00:00",
"date_update": "2025-10-02T19:42:07.7892746+00:00",
"date_closed": "2025-10-02T19:42:07.7892746+00:00",
"suggested_user_id": "6f853b43-3bc9-4797-ae9d-3a5487bed675",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "350b6865-e1ff-45d5-959a-5522fa89bb30",
"db_language_id": "89ab548a-59f6-4e2a-9e13-c3926b7c75e5",
"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-10-02T19:42:07.7892746+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f0f57895-047f-4199-9937-c21867715443",
"sales_organization": {
"id": "9cb8cbef-86a4-4063-b51f-9926b90fa370",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a9f28ef-79c7-404d-9a61-12147970fc59",
"db_currency_id": "44892dfd-4e36-49f0-8715-f4a4bdb96378",
"db_language_id": "e31fbca4-9b9e-4353-8a16-a162ae3152b6",
"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-10-02T19:42:07.7892746+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a17d3231-d232-4e9e-8d76-68cae620afa1",
"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": "012e0c94-5cf0-426e-913d-5c0ffd95b2ab",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-02T19:42:07.7892746+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4b6756ad-4a72-4f64-a664-ac8c3f432aa4"
},
"suggested_date_start": "2025-10-02T19:42:07.7892746+00:00",
"skill_id": "cc585abf-ee86-4734-8a0f-1984635fb789",
"skill_code": "sample string 32",
"skill": {
"id": "2a9c8830-ad5e-4c99-b312-f84581b14aec",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b3406adb-b5a5-4dec-8aa2-77d5a5e98953",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9cb8cbef-86a4-4063-b51f-9926b90fa370",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a9f28ef-79c7-404d-9a61-12147970fc59",
"db_currency_id": "44892dfd-4e36-49f0-8715-f4a4bdb96378",
"db_language_id": "e31fbca4-9b9e-4353-8a16-a162ae3152b6",
"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-10-02T19:42:07.7892746+00:00"
},
"modified_dateutc": "2025-10-02T19:42:07.7892746+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "865d7e04-6cdd-4852-8e19-3212a718a149",
"date_reported_by_company": "2025-10-02T19:42:07.7892746+00:00",
"id2": 36,
"company_id": "17ee82dc-8b98-497e-a7e1-521132c27860",
"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": "e7d6e74c-0d93-4097-9fdb-de76efdd8742",
"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-10-02T19:42:07.7892746+00:00"
},
"work_instruction_details_id": "38b53639-a2a3-4dca-a173-ed8c7459ad64",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f089f2c7-e3ce-4272-9dde-fca149ceea5b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b72e3376-f00e-46e6-81ef-2175eb2c2725",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-02T19:42:07.7892746+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": "40e82652-a85e-4fdf-943b-c8d19d6ed0f9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-02T19:42:07.7892746+00:00"
}