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": "d93ff92c-d4cf-44bc-94f2-63119b0a3124",
"jobs_id": "29537cf4-270d-4f27-a3d2-343353134600",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5129ad02-8272-4aa9-b4cd-0e35d769d075",
"_parent_id": "d2fbee48-a911-4678-bef5-e5f52780093b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "68108e9f-d1a4-47ec-bca9-9f7e9f7e5032",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7b1c6855-76c0-4f26-a7bd-3902dd077418",
"_parent_id": "5f21dce4-ee8b-489e-8044-3aa6ff6bb157",
"root_parent_id": "340bdac7-a0ea-4a01-8d63-1b6fb1dbd5fb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "42f328bc-db0f-42e1-a11d-049104b4dbc1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "da7d842e-a767-4672-ab1b-0ac4a77c2545",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f9a03651-2f34-4346-9a6e-4c107788fa52",
"_parent_code": "sample string 6",
"sales_organization_id": "d6381479-0140-46e4-9ea3-85a68724ccba",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7d84d3ea-fed1-4b57-901c-d783efb86159",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "65d87823-1f62-41d5-9af6-6cfefbf3e463",
"db_currency_id": "5a799ca1-cfa5-462c-b225-6c81c214b5df",
"db_language_id": "f5242e9c-7016-4a0b-a665-ef0327f6ead3",
"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-06-03T16:18:23.2202988+00:00"
},
"modified_dateutc": "2026-06-03T16:18:23.2202988+00:00"
},
"equipment_model_id": "83e03a19-5128-4a65-be6a-297c0c99b508",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7742e21d-0b2d-476b-b877-e2fdbc0bba7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "40732f8e-dcd7-4bd4-beab-73d07bb19fd7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "901b1159-8cc1-4d02-92e6-11f94b3c7f41",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bc339729-227a-41b3-9c82-244f53b3dd9f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7d84d3ea-fed1-4b57-901c-d783efb86159",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "65d87823-1f62-41d5-9af6-6cfefbf3e463",
"db_currency_id": "5a799ca1-cfa5-462c-b225-6c81c214b5df",
"db_language_id": "f5242e9c-7016-4a0b-a665-ef0327f6ead3",
"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-06-03T16:18:23.2202988+00:00"
},
"modified_dateutc": "2026-06-03T16:18:23.2202988+00:00"
},
"equipment_family_id": "7d0385af-6a8a-40de-837f-d8ad047c3b5a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "da7d842e-a767-4672-ab1b-0ac4a77c2545",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f9a03651-2f34-4346-9a6e-4c107788fa52",
"_parent_code": "sample string 6",
"sales_organization_id": "d6381479-0140-46e4-9ea3-85a68724ccba",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7d84d3ea-fed1-4b57-901c-d783efb86159",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "65d87823-1f62-41d5-9af6-6cfefbf3e463",
"db_currency_id": "5a799ca1-cfa5-462c-b225-6c81c214b5df",
"db_language_id": "f5242e9c-7016-4a0b-a665-ef0327f6ead3",
"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-06-03T16:18:23.2202988+00:00"
},
"modified_dateutc": "2026-06-03T16:18:23.2202988+00:00"
},
"date_in_production_since": "2026-06-03T16:18:23.2202988+00:00",
"date_out_of_production_since": "2026-06-03T16:18:23.2202988+00:00",
"date_end_support": "2026-06-03T16:18:23.2202988+00:00",
"sales_organization_id": "51f86d94-b75f-4f68-b914-2c08f5e95c73",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7d84d3ea-fed1-4b57-901c-d783efb86159",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "65d87823-1f62-41d5-9af6-6cfefbf3e463",
"db_currency_id": "5a799ca1-cfa5-462c-b225-6c81c214b5df",
"db_language_id": "f5242e9c-7016-4a0b-a665-ef0327f6ead3",
"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-06-03T16:18:23.2202988+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-06-03T16:18:23.2202988+00:00"
},
"project_status_id": "3400f4a3-567a-4c7a-ae4a-b1759a357a7a",
"project_status_code": "sample string 10",
"project_status": {
"id": "8b94a712-a6c0-43cb-a08d-228859434bc8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "70ce14c8-9d70-4e12-a5f8-8e36c6d3e568",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7d84d3ea-fed1-4b57-901c-d783efb86159",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "65d87823-1f62-41d5-9af6-6cfefbf3e463",
"db_currency_id": "5a799ca1-cfa5-462c-b225-6c81c214b5df",
"db_language_id": "f5242e9c-7016-4a0b-a665-ef0327f6ead3",
"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-06-03T16:18:23.2202988+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-03T16:18:23.2202988+00:00"
},
"company_id": "5aeebcc9-4c87-4ebb-a720-e2617366695a",
"company_code": "sample string 12",
"db_address_id": "e3d33f9a-2982-417f-bec2-9a1ee988db48",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c9f834ba-1522-47b7-bce2-0d53f1018adc",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4cfbc577-7056-4daa-a9d3-0705ef22fd3d",
"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-06-03T16:18:23.2202988+00:00",
"date_create": "2026-06-03T16:18:23.2202988+00:00",
"date_update": "2026-06-03T16:18:23.2202988+00:00",
"updated_by_user_id": "633bac3d-75b1-4cab-89d5-7c96ced3f73f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-03T16:18:23.2202988+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-06-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-03T16:18:23.2202988+00:00",
"date_last_job": "2026-06-03T16:18:23.2202988+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-03T16:18:23.2202988+00:00",
"modified_dateutc": "2026-06-03T16:18:23.2202988+00:00",
"is_mobile_installation": true
},
"job_type_id": "0f1eb594-93b2-4c1c-bfa4-a24ca9e35c8d",
"job_type_code": "sample string 7",
"job_type": {
"id": "982aba9b-defc-4f99-b99b-4dec6006dad0",
"name": "sample string 2",
"sales_organization_id": "43eeb8fc-1851-4bc6-82da-fd76b2288bf5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-03T16:18:23.2202988+00:00",
"code": "sample string 7"
},
"job_priority_id": "0c0fc90e-86d8-4cb1-b1f3-1d351d0b3e39",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "44d3c8cc-651c-4527-ae05-782d91eb3980",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e72ae158-71d9-44b9-a17c-db3642958fd9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7d84d3ea-fed1-4b57-901c-d783efb86159",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "65d87823-1f62-41d5-9af6-6cfefbf3e463",
"db_currency_id": "5a799ca1-cfa5-462c-b225-6c81c214b5df",
"db_language_id": "f5242e9c-7016-4a0b-a665-ef0327f6ead3",
"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-06-03T16:18:23.2202988+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-03T16:18:23.2202988+00:00"
},
"job_status_id": "9639785b-1fc7-4b59-909d-b94ffd0e916f",
"job_status_code": "sample string 11",
"db_address_id": "4e551849-0e0d-4e8c-97a0-377e58b1ad82",
"contact_id": "e1150165-f775-4133-8200-0b501b82580b",
"requested_by_company_id": "4932689d-ce75-4260-8eb7-adb645597506",
"requested_by_contact_id": "31a1fd86-c7fa-4d15-bf84-854b09803545",
"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-06-03T16:18:23.2202988+00:00",
"due_date": "2026-06-03T16:18:23.2202988+00:00",
"date_create": "2026-06-03T16:18:23.2202988+00:00",
"date_update": "2026-06-03T16:18:23.2202988+00:00",
"date_closed": "2026-06-03T16:18:23.2202988+00:00",
"suggested_user_id": "cead40a2-3178-4e0f-a8be-02ac063167ca",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e6c04639-1d7c-46c4-8334-9da90b103be6",
"db_language_id": "c7147469-3c79-4cff-aecd-f4087367c13b",
"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-06-03T16:18:23.2202988+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f2f5ddd4-c2bb-4137-a2e5-72ed155109be",
"sales_organization": {
"id": "7d84d3ea-fed1-4b57-901c-d783efb86159",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "65d87823-1f62-41d5-9af6-6cfefbf3e463",
"db_currency_id": "5a799ca1-cfa5-462c-b225-6c81c214b5df",
"db_language_id": "f5242e9c-7016-4a0b-a665-ef0327f6ead3",
"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-06-03T16:18:23.2202988+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a1cefefc-abdd-4198-a970-8491db9cd9c6",
"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": "e8b24f6d-ba15-4d5d-bf25-7eabebec272d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-03T16:18:23.2202988+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c498c6cc-09e0-450c-8e67-9fc434c67c3b"
},
"suggested_date_start": "2026-06-03T16:18:23.2202988+00:00",
"skill_id": "d241dc3b-2454-46c5-a6c6-63ca23c11716",
"skill_code": "sample string 32",
"skill": {
"id": "4fbf90d1-92e1-4770-b50b-5d68b986d07a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c9895843-efbc-4be0-8540-eb1d8cf812f4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7d84d3ea-fed1-4b57-901c-d783efb86159",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "65d87823-1f62-41d5-9af6-6cfefbf3e463",
"db_currency_id": "5a799ca1-cfa5-462c-b225-6c81c214b5df",
"db_language_id": "f5242e9c-7016-4a0b-a665-ef0327f6ead3",
"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-06-03T16:18:23.2202988+00:00"
},
"modified_dateutc": "2026-06-03T16:18:23.2202988+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "aab1c003-d0ae-4017-83c6-d675dbf44d0a",
"date_reported_by_company": "2026-06-03T16:18:23.2202988+00:00",
"id2": 36,
"company_id": "8f69901a-118e-409d-a972-e2d91384073c",
"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": "970ef36c-b59a-406b-ba97-149d6eb7449d",
"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-06-03T16:18:23.2202988+00:00"
},
"work_instruction_details_id": "a58d1229-59a4-4da9-8bf4-d57835d6b854",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a23586ec-0670-4007-967c-e2c26bb5d252",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "030e2601-6773-4736-bed4-6085151a0240",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-03T16:18:23.2202988+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": "83c6a718-d94d-45b0-b778-cebaeb7cc9bf",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-03T16:18:23.2202988+00:00"
}