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": "c1165f66-65d1-4fce-9b81-d2cbdca8a6d9",
"jobs_id": "e439ed0e-b157-4957-a31a-f38a5d34ee71",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b76fd409-af6c-4a27-b86a-0e5143c6b69d",
"_parent_id": "60f16994-9650-4bd1-9899-8ae7328e3dd0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b8d10fcc-7ecf-4a7f-b37a-fc2a67c882e9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3df1fad5-aeb2-4052-90e2-e73e75dcec9d",
"_parent_id": "c6ffc3d7-21f2-4ad1-b1a6-bd1f5baf860d",
"root_parent_id": "233a55fa-5dcc-4cfb-8f44-1dc4401ad103",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c96912ef-7bf4-48df-b8b5-b580f84bfcc2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "588fa91a-8d37-41c0-8cba-fa0b0b4c929c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7bccb9e5-ec17-4104-8ba7-c1b57eeff3c5",
"_parent_code": "sample string 6",
"sales_organization_id": "59e6af70-e723-4440-a0bf-c84a7c855e26",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a913f043-11f4-424c-afcd-8e08b3684488",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28336cc2-2bd6-4386-9287-c95bb9b1877d",
"db_currency_id": "a79b4f4a-a1de-433f-8029-4704d160fbff",
"db_language_id": "49052b91-2cfa-41f0-ac8c-85c838fb47ff",
"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-02-20T17:00:21.795706+00:00"
},
"modified_dateutc": "2026-02-20T17:00:21.811331+00:00"
},
"equipment_model_id": "58e28288-f686-42e8-a89e-03a7f57ad64d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c947260b-c1e6-40e3-b6f2-eced4386f2a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "12d55b84-f0bc-43d2-8766-2510eb9afb51",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0eca361b-ed36-42f9-9a75-14140f5144a4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fb047aec-69af-44b0-908a-fc1084b4c8ab",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a913f043-11f4-424c-afcd-8e08b3684488",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28336cc2-2bd6-4386-9287-c95bb9b1877d",
"db_currency_id": "a79b4f4a-a1de-433f-8029-4704d160fbff",
"db_language_id": "49052b91-2cfa-41f0-ac8c-85c838fb47ff",
"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-02-20T17:00:21.795706+00:00"
},
"modified_dateutc": "2026-02-20T17:00:21.811331+00:00"
},
"equipment_family_id": "c9cafa83-928a-43c4-b2e6-1f8af447e737",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "588fa91a-8d37-41c0-8cba-fa0b0b4c929c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7bccb9e5-ec17-4104-8ba7-c1b57eeff3c5",
"_parent_code": "sample string 6",
"sales_organization_id": "59e6af70-e723-4440-a0bf-c84a7c855e26",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a913f043-11f4-424c-afcd-8e08b3684488",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28336cc2-2bd6-4386-9287-c95bb9b1877d",
"db_currency_id": "a79b4f4a-a1de-433f-8029-4704d160fbff",
"db_language_id": "49052b91-2cfa-41f0-ac8c-85c838fb47ff",
"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-02-20T17:00:21.795706+00:00"
},
"modified_dateutc": "2026-02-20T17:00:21.811331+00:00"
},
"date_in_production_since": "2026-02-20T17:00:21.811331+00:00",
"date_out_of_production_since": "2026-02-20T17:00:21.811331+00:00",
"date_end_support": "2026-02-20T17:00:21.811331+00:00",
"sales_organization_id": "ab07a958-7622-4c1c-977d-dc3303b67208",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a913f043-11f4-424c-afcd-8e08b3684488",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28336cc2-2bd6-4386-9287-c95bb9b1877d",
"db_currency_id": "a79b4f4a-a1de-433f-8029-4704d160fbff",
"db_language_id": "49052b91-2cfa-41f0-ac8c-85c838fb47ff",
"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-02-20T17:00:21.795706+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-02-20T17:00:21.811331+00:00"
},
"project_status_id": "c0dba025-1ee1-457e-a111-6f8388191b21",
"project_status_code": "sample string 10",
"project_status": {
"id": "0f3a5903-4695-43f3-9f5f-80072abd3d30",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "531de869-93b6-4a04-a713-65c3e79b6b3d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a913f043-11f4-424c-afcd-8e08b3684488",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28336cc2-2bd6-4386-9287-c95bb9b1877d",
"db_currency_id": "a79b4f4a-a1de-433f-8029-4704d160fbff",
"db_language_id": "49052b91-2cfa-41f0-ac8c-85c838fb47ff",
"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-02-20T17:00:21.795706+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-20T17:00:21.811331+00:00"
},
"company_id": "2430d0f7-de61-4f63-b6ca-0164465f24f1",
"company_code": "sample string 12",
"db_address_id": "e9851ab2-a0e7-4172-abcb-f0aa4625742e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3b54bb31-72cc-44b9-97dd-5d17c87df0e8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f6339fd9-d8f6-4da4-9a82-b41530b6daff",
"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-02-20T17:00:21.811331+00:00",
"date_create": "2026-02-20T17:00:21.811331+00:00",
"date_update": "2026-02-20T17:00:21.811331+00:00",
"updated_by_user_id": "c566de19-2a78-457e-a21d-c63fff7ccf89",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-20T17:00:21.811331+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-02-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-20T17:00:21.811331+00:00",
"date_last_job": "2026-02-20T17:00:21.811331+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-20T17:00:21.811331+00:00",
"modified_dateutc": "2026-02-20T17:00:21.811331+00:00",
"is_mobile_installation": true
},
"job_type_id": "9d154164-d043-4143-b7ae-f72e4962a593",
"job_type_code": "sample string 7",
"job_type": {
"id": "df62010f-4ecf-49a9-b0ae-406cb5f47525",
"name": "sample string 2",
"sales_organization_id": "845b80e0-9b67-4c3d-bf52-425a12413a73",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-20T17:00:21.811331+00:00",
"code": "sample string 7"
},
"job_priority_id": "7e353599-20ea-4d76-ae26-890cd41a0266",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "69bd681a-b514-4656-83c9-0843a2f4f851",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fc6b7ffb-18fe-4a2a-8d8d-425b01afad71",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a913f043-11f4-424c-afcd-8e08b3684488",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28336cc2-2bd6-4386-9287-c95bb9b1877d",
"db_currency_id": "a79b4f4a-a1de-433f-8029-4704d160fbff",
"db_language_id": "49052b91-2cfa-41f0-ac8c-85c838fb47ff",
"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-02-20T17:00:21.795706+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-20T17:00:21.811331+00:00"
},
"job_status_id": "13aa0069-e400-4ffa-b7e2-8c5af3332b71",
"job_status_code": "sample string 11",
"db_address_id": "ecbe0cd1-db63-43d6-ad6a-41cc4331942c",
"contact_id": "ceda7f97-06fa-4f26-8b52-3dffb93faf6a",
"requested_by_company_id": "d5ee9e51-cd89-44a7-8f79-8003099ba48d",
"requested_by_contact_id": "94a7adec-1d0e-4479-9e1b-a6ace35b18e7",
"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-02-20T17:00:21.811331+00:00",
"due_date": "2026-02-20T17:00:21.811331+00:00",
"date_create": "2026-02-20T17:00:21.811331+00:00",
"date_update": "2026-02-20T17:00:21.811331+00:00",
"date_closed": "2026-02-20T17:00:21.811331+00:00",
"suggested_user_id": "9db3f05c-070d-4726-9ec3-1a5be92a0fa3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "eacb21da-e4e4-4a81-b3d7-b02bc90108a8",
"db_language_id": "6d2d4a62-5b55-4a24-9e2d-afcce77e36fa",
"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-02-20T17:00:21.811331+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4086e603-b77f-4a22-aeb6-332268d1532d",
"sales_organization": {
"id": "a913f043-11f4-424c-afcd-8e08b3684488",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28336cc2-2bd6-4386-9287-c95bb9b1877d",
"db_currency_id": "a79b4f4a-a1de-433f-8029-4704d160fbff",
"db_language_id": "49052b91-2cfa-41f0-ac8c-85c838fb47ff",
"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-02-20T17:00:21.795706+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "738ef7c0-b2b2-40d8-abef-225f857d4e5d",
"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": "a1999f97-94e1-4ca2-88fe-fd54d53469d5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-20T17:00:21.811331+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4edc8ad5-c7ed-42a0-92e1-742fd407a7ef"
},
"suggested_date_start": "2026-02-20T17:00:21.811331+00:00",
"skill_id": "28a22620-2aa0-475f-9afd-949318aacc8a",
"skill_code": "sample string 32",
"skill": {
"id": "4e113d76-243e-43fe-8d57-99b3df015531",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cab13010-ddb2-481e-9221-f9f3c7b35a4f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a913f043-11f4-424c-afcd-8e08b3684488",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28336cc2-2bd6-4386-9287-c95bb9b1877d",
"db_currency_id": "a79b4f4a-a1de-433f-8029-4704d160fbff",
"db_language_id": "49052b91-2cfa-41f0-ac8c-85c838fb47ff",
"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-02-20T17:00:21.795706+00:00"
},
"modified_dateutc": "2026-02-20T17:00:21.811331+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "270c8988-879d-40da-8557-22061ff1b774",
"date_reported_by_company": "2026-02-20T17:00:21.811331+00:00",
"id2": 36,
"company_id": "6a5eecbf-7966-450b-9bb6-a7db37e8295e",
"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": "b846ca29-fa48-4e3c-8979-e7dc84f4a803",
"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-02-20T17:00:21.811331+00:00"
},
"work_instruction_details_id": "f872c1e8-68d8-43c4-9cb2-d8dbe26a10f0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "042bf4e7-3747-48a4-8676-b2c503f84c40",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1f7b32b6-350b-4059-a5ef-f07674d8b8d7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-20T17:00:21.811331+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": "e8514b9b-de64-484b-964f-cafa76b38411",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-20T17:00:21.811331+00:00"
}