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": "719c575e-55d3-4209-b828-b764a7141a95",
"jobs_id": "0893e6fd-7d1e-43c1-91d0-8a78ee0faf3a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "61c2d683-f71a-430c-a781-02c3931a9af0",
"_parent_id": "b0dd6278-cfc1-4c65-acba-dc04d9f70b4b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "497e1052-7fdb-4032-816d-5c1da973cb24",
"project_reference_back_office": "sample string 5",
"project": {
"id": "94d9bec0-02a0-4942-aa5d-ce30979f1f28",
"_parent_id": "ec85c4b7-670b-4e80-99cb-5566443452fb",
"root_parent_id": "23142fa7-5a97-467e-9dc4-722468adb9ac",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "14f795e8-1cb8-41d8-8f57-64ade9e7730f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8a236ad3-f6ac-4f7e-bad8-32cb65746f13",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0307911e-5938-4530-adf1-6a9886e70ba1",
"_parent_code": "sample string 6",
"sales_organization_id": "04970d31-13b4-4692-8ffc-1cd6d7929f86",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2437c52a-7d2b-4b73-8cf2-c8678a7997a9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45a209af-ef95-4cf8-b310-01cf12656a8b",
"db_currency_id": "5596379b-b080-40a8-8e81-4384662e36de",
"db_language_id": "e477f867-7f3a-42f6-9e9a-3a1b320ee31e",
"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-11-28T13:03:01.1392604+00:00"
},
"modified_dateutc": "2025-11-28T13:03:01.1392604+00:00"
},
"equipment_model_id": "b629ea02-0d12-465e-834b-a4f95d9e9e46",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b14e2da3-435d-4706-9bd3-33fc559748da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "baecb714-7acd-459c-8044-40389f9c5c59",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a62d63dd-9b67-4c0b-88f9-0f1b3602b4e7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f6d1e944-0e33-43b2-ac98-e1a6210bc0cd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2437c52a-7d2b-4b73-8cf2-c8678a7997a9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45a209af-ef95-4cf8-b310-01cf12656a8b",
"db_currency_id": "5596379b-b080-40a8-8e81-4384662e36de",
"db_language_id": "e477f867-7f3a-42f6-9e9a-3a1b320ee31e",
"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-11-28T13:03:01.1392604+00:00"
},
"modified_dateutc": "2025-11-28T13:03:01.1392604+00:00"
},
"equipment_family_id": "fc6b3374-ca8c-4de6-b0cb-9dd476f5f562",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8a236ad3-f6ac-4f7e-bad8-32cb65746f13",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0307911e-5938-4530-adf1-6a9886e70ba1",
"_parent_code": "sample string 6",
"sales_organization_id": "04970d31-13b4-4692-8ffc-1cd6d7929f86",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2437c52a-7d2b-4b73-8cf2-c8678a7997a9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45a209af-ef95-4cf8-b310-01cf12656a8b",
"db_currency_id": "5596379b-b080-40a8-8e81-4384662e36de",
"db_language_id": "e477f867-7f3a-42f6-9e9a-3a1b320ee31e",
"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-11-28T13:03:01.1392604+00:00"
},
"modified_dateutc": "2025-11-28T13:03:01.1392604+00:00"
},
"date_in_production_since": "2025-11-28T13:03:01.1392604+00:00",
"date_out_of_production_since": "2025-11-28T13:03:01.1392604+00:00",
"date_end_support": "2025-11-28T13:03:01.1392604+00:00",
"sales_organization_id": "006eca81-6573-4396-847e-db1a152d9a70",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2437c52a-7d2b-4b73-8cf2-c8678a7997a9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45a209af-ef95-4cf8-b310-01cf12656a8b",
"db_currency_id": "5596379b-b080-40a8-8e81-4384662e36de",
"db_language_id": "e477f867-7f3a-42f6-9e9a-3a1b320ee31e",
"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-11-28T13:03:01.1392604+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-11-28T13:03:01.1392604+00:00"
},
"project_status_id": "e3846df8-6c86-4cb5-be60-cba65dacade6",
"project_status_code": "sample string 10",
"project_status": {
"id": "797993d5-951c-481f-a9ac-3e85903ffbba",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "09024f04-5f76-4fbf-a60f-25f008e3343c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2437c52a-7d2b-4b73-8cf2-c8678a7997a9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45a209af-ef95-4cf8-b310-01cf12656a8b",
"db_currency_id": "5596379b-b080-40a8-8e81-4384662e36de",
"db_language_id": "e477f867-7f3a-42f6-9e9a-3a1b320ee31e",
"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-11-28T13:03:01.1392604+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-28T13:03:01.1392604+00:00"
},
"company_id": "b998242a-5256-4f47-b6d0-320c6428c32f",
"company_code": "sample string 12",
"db_address_id": "2ae1d04b-8a87-49ae-b252-e68d032650e3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8017527d-4bd2-4348-ae46-a38116779e4c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6aa9e104-5187-4e28-9598-565cb37727a4",
"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-11-28T13:03:01.1392604+00:00",
"date_create": "2025-11-28T13:03:01.1392604+00:00",
"date_update": "2025-11-28T13:03:01.1392604+00:00",
"updated_by_user_id": "8a02aa5e-b27f-4a3f-88ef-0c0819c20726",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-28T13:03:01.1392604+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-11-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-28T13:03:01.1392604+00:00",
"date_last_job": "2025-11-28T13:03:01.1392604+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-28T13:03:01.1392604+00:00",
"modified_dateutc": "2025-11-28T13:03:01.1392604+00:00",
"is_mobile_installation": true
},
"job_type_id": "835d02b7-670b-4923-9952-50396201570f",
"job_type_code": "sample string 7",
"job_type": {
"id": "7a936b54-83ca-4024-a15b-9421655a5851",
"name": "sample string 2",
"sales_organization_id": "dc56bc84-5df3-4355-85d2-1788a6028d7e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-28T13:03:01.1392604+00:00",
"code": "sample string 7"
},
"job_priority_id": "ae8caf80-66f2-462c-b44b-acca32c199a2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7b8a8ff5-5347-4cf3-97ee-519da0a1560d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "85cff666-e80f-42eb-9cbb-5354f8c66e83",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2437c52a-7d2b-4b73-8cf2-c8678a7997a9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45a209af-ef95-4cf8-b310-01cf12656a8b",
"db_currency_id": "5596379b-b080-40a8-8e81-4384662e36de",
"db_language_id": "e477f867-7f3a-42f6-9e9a-3a1b320ee31e",
"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-11-28T13:03:01.1392604+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-28T13:03:01.1392604+00:00"
},
"job_status_id": "da1418f0-5a8c-4811-b249-f5013d51be16",
"job_status_code": "sample string 11",
"db_address_id": "e1343e57-9779-451d-abd2-96749ffdfb57",
"contact_id": "d6f928b2-9e25-4e37-be35-82c466947949",
"requested_by_company_id": "0afffd38-9df5-47df-be44-bc1ec9e888bd",
"requested_by_contact_id": "29820217-ed04-4d9d-9dda-022c8fef9308",
"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-11-28T13:03:01.1392604+00:00",
"due_date": "2025-11-28T13:03:01.1392604+00:00",
"date_create": "2025-11-28T13:03:01.1392604+00:00",
"date_update": "2025-11-28T13:03:01.1392604+00:00",
"date_closed": "2025-11-28T13:03:01.1392604+00:00",
"suggested_user_id": "ef23ff75-dad2-4995-822e-7d3d901a0ed6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9f02c0a3-5e3d-4628-a56b-1a5a47ec2b32",
"db_language_id": "46bdbbb6-89d0-4b23-a746-4e4f9e88f57a",
"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-11-28T13:03:01.1392604+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a8aa59c5-2b7f-46e1-b645-dfc161b57932",
"sales_organization": {
"id": "2437c52a-7d2b-4b73-8cf2-c8678a7997a9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45a209af-ef95-4cf8-b310-01cf12656a8b",
"db_currency_id": "5596379b-b080-40a8-8e81-4384662e36de",
"db_language_id": "e477f867-7f3a-42f6-9e9a-3a1b320ee31e",
"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-11-28T13:03:01.1392604+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "28b7d0ad-b750-4364-ade3-e8d787a4bb77",
"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": "37360059-ffed-42c9-80cb-94189056de2c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-28T13:03:01.1392604+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5c9b15b5-4647-4bfa-8d02-3277f84f2901"
},
"suggested_date_start": "2025-11-28T13:03:01.1392604+00:00",
"skill_id": "bee73639-a6f8-468d-91eb-c4793a2f0e9a",
"skill_code": "sample string 32",
"skill": {
"id": "376cbc5a-f946-4431-ae6d-6476ae9fc804",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a79cb8aa-a707-439a-bfa0-3a5286990d52",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2437c52a-7d2b-4b73-8cf2-c8678a7997a9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45a209af-ef95-4cf8-b310-01cf12656a8b",
"db_currency_id": "5596379b-b080-40a8-8e81-4384662e36de",
"db_language_id": "e477f867-7f3a-42f6-9e9a-3a1b320ee31e",
"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-11-28T13:03:01.1392604+00:00"
},
"modified_dateutc": "2025-11-28T13:03:01.1392604+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1cc8cd85-0039-49e4-84eb-43c06942bd16",
"date_reported_by_company": "2025-11-28T13:03:01.1392604+00:00",
"id2": 36,
"company_id": "0051e2e2-6a65-45c3-a858-7002ea11bbb8",
"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": "23fa6974-f554-4c2c-88d7-8c487dbdbf49",
"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-11-28T13:03:01.1392604+00:00"
},
"work_instruction_details_id": "8dca589e-9f6b-44b7-8f9e-9d0aa4c481cd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "30211207-b7ec-44e9-bafb-fe2ac78eb85e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fc09d0e5-a587-49c8-bfa7-a457588ad295",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-28T13:03:01.1392604+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": "5693f235-4e1d-43f8-a600-e6dedfa91837",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-28T13:03:01.1392604+00:00"
}