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": "eb7fb484-383d-4ca2-9490-9305acd1360b",
"jobs_id": "072de171-c4cf-42d7-b042-3d7ea36f3355",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d2c277ef-6c88-49b4-8e8f-c650ea2b205b",
"_parent_id": "e2d91711-51f8-4bc0-bc4d-1af6bde991db",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0c0a2174-805e-4e3b-9ecb-d544d2c0495d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "93790878-d655-4c41-9017-9eb2842865af",
"_parent_id": "3c580262-8206-4e80-92ea-b96c91430d8d",
"root_parent_id": "f0efb343-39c8-407d-afa3-7a111790d36f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ebbf479f-8ff2-44d2-ae1b-79c1f852699e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "138f8637-c95b-42f9-bf96-f875e0c6afb7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f1fba143-39dd-48ca-ad27-aed6760cfc3b",
"_parent_code": "sample string 6",
"sales_organization_id": "189353a1-73ee-4aa0-83e3-b0de9d9a1c02",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4ef99bae-3af9-4450-9340-e6e339f2f821",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f6389e1-cac1-4d0b-8c26-61cd34800b18",
"db_currency_id": "3d743073-2083-4347-b70e-2eeffe93ef87",
"db_language_id": "b2e76487-e30c-4073-9ffd-bd6126bace3d",
"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-05-20T12:44:23.2266051+00:00"
},
"modified_dateutc": "2026-05-20T12:44:23.2266051+00:00"
},
"equipment_model_id": "74220992-582f-47fd-bb59-44e084b9490d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8bc78a7e-6eef-4fb4-925c-8ed647f7515a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "219b0a30-b80b-44d0-9433-f1bba0926c34",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d8799553-4596-407f-a1bb-3803e54009a7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d0dc27ad-1572-43d3-9657-d04ed19d468b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4ef99bae-3af9-4450-9340-e6e339f2f821",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f6389e1-cac1-4d0b-8c26-61cd34800b18",
"db_currency_id": "3d743073-2083-4347-b70e-2eeffe93ef87",
"db_language_id": "b2e76487-e30c-4073-9ffd-bd6126bace3d",
"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-05-20T12:44:23.2266051+00:00"
},
"modified_dateutc": "2026-05-20T12:44:23.2266051+00:00"
},
"equipment_family_id": "e3c6089e-89ae-4d55-bc5d-3e7b65d501c4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "138f8637-c95b-42f9-bf96-f875e0c6afb7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f1fba143-39dd-48ca-ad27-aed6760cfc3b",
"_parent_code": "sample string 6",
"sales_organization_id": "189353a1-73ee-4aa0-83e3-b0de9d9a1c02",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4ef99bae-3af9-4450-9340-e6e339f2f821",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f6389e1-cac1-4d0b-8c26-61cd34800b18",
"db_currency_id": "3d743073-2083-4347-b70e-2eeffe93ef87",
"db_language_id": "b2e76487-e30c-4073-9ffd-bd6126bace3d",
"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-05-20T12:44:23.2266051+00:00"
},
"modified_dateutc": "2026-05-20T12:44:23.2266051+00:00"
},
"date_in_production_since": "2026-05-20T12:44:23.2266051+00:00",
"date_out_of_production_since": "2026-05-20T12:44:23.2266051+00:00",
"date_end_support": "2026-05-20T12:44:23.2266051+00:00",
"sales_organization_id": "1efb2819-3eb7-45af-81a1-96d9eba0e6fe",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4ef99bae-3af9-4450-9340-e6e339f2f821",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f6389e1-cac1-4d0b-8c26-61cd34800b18",
"db_currency_id": "3d743073-2083-4347-b70e-2eeffe93ef87",
"db_language_id": "b2e76487-e30c-4073-9ffd-bd6126bace3d",
"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-05-20T12:44:23.2266051+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-05-20T12:44:23.2266051+00:00"
},
"project_status_id": "f74f3172-26c9-4037-b65b-d10223e01522",
"project_status_code": "sample string 10",
"project_status": {
"id": "605ddcae-6fc1-4fbb-905d-b9773a41f5a8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c8dc9fff-f2e2-426c-bf37-2645f684d817",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4ef99bae-3af9-4450-9340-e6e339f2f821",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f6389e1-cac1-4d0b-8c26-61cd34800b18",
"db_currency_id": "3d743073-2083-4347-b70e-2eeffe93ef87",
"db_language_id": "b2e76487-e30c-4073-9ffd-bd6126bace3d",
"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-05-20T12:44:23.2266051+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-20T12:44:23.2266051+00:00"
},
"company_id": "5e3540dc-ba66-4ddd-992e-d7a36c28d2a9",
"company_code": "sample string 12",
"db_address_id": "976429aa-b827-44b8-89ea-576f503af688",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "618c819b-55e4-4128-a017-48d95b045d11",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "21296807-4dda-4c18-9b42-d1b7a965499e",
"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-05-20T12:44:23.2266051+00:00",
"date_create": "2026-05-20T12:44:23.2266051+00:00",
"date_update": "2026-05-20T12:44:23.2266051+00:00",
"updated_by_user_id": "fe27fe36-f8fe-46f7-ba1d-fde51b011aa7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-20T12:44:23.2266051+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-05-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-20T12:44:23.2266051+00:00",
"date_last_job": "2026-05-20T12:44:23.2266051+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-20T12:44:23.2266051+00:00",
"modified_dateutc": "2026-05-20T12:44:23.2266051+00:00",
"is_mobile_installation": true
},
"job_type_id": "0dd2ec64-eda0-4993-9d14-093092e204d0",
"job_type_code": "sample string 7",
"job_type": {
"id": "f0fbfeef-d09a-41fa-9664-b12a8204fee9",
"name": "sample string 2",
"sales_organization_id": "a926577d-2a2e-443d-8e75-65a956f0fc37",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-20T12:44:23.2266051+00:00",
"code": "sample string 7"
},
"job_priority_id": "1867c429-8949-43ea-9720-142cc6f7e48b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a890b880-b3e9-4753-b5a3-08475ab60d5c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "29b6029b-d39e-43ec-8fe3-7836b22db348",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4ef99bae-3af9-4450-9340-e6e339f2f821",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f6389e1-cac1-4d0b-8c26-61cd34800b18",
"db_currency_id": "3d743073-2083-4347-b70e-2eeffe93ef87",
"db_language_id": "b2e76487-e30c-4073-9ffd-bd6126bace3d",
"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-05-20T12:44:23.2266051+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-20T12:44:23.2266051+00:00"
},
"job_status_id": "8481be60-93c0-4794-bab9-44f203917858",
"job_status_code": "sample string 11",
"db_address_id": "c0524a5f-8b4b-4ad3-a3d2-da079e2cb3b6",
"contact_id": "31b9401c-ee18-463f-88d6-c8d6e84848b1",
"requested_by_company_id": "15eed3cf-e6e8-4591-8ac9-fc9f62c44a24",
"requested_by_contact_id": "dea274e8-27b8-4d9b-a961-f5029fd4f9fe",
"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-05-20T12:44:23.2266051+00:00",
"due_date": "2026-05-20T12:44:23.2266051+00:00",
"date_create": "2026-05-20T12:44:23.2266051+00:00",
"date_update": "2026-05-20T12:44:23.2266051+00:00",
"date_closed": "2026-05-20T12:44:23.2266051+00:00",
"suggested_user_id": "7272fdc4-0d7b-4267-b676-54c7e2752943",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "45989479-8f52-4646-8529-b3a6a3460d32",
"db_language_id": "fd10f14d-f4e9-4bb7-8d88-dad77d267eac",
"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-05-20T12:44:23.2266051+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1190e700-3bc1-47bd-af5c-43ae64d95143",
"sales_organization": {
"id": "4ef99bae-3af9-4450-9340-e6e339f2f821",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f6389e1-cac1-4d0b-8c26-61cd34800b18",
"db_currency_id": "3d743073-2083-4347-b70e-2eeffe93ef87",
"db_language_id": "b2e76487-e30c-4073-9ffd-bd6126bace3d",
"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-05-20T12:44:23.2266051+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1cdee83a-2e1f-4544-8770-72481c71cfd6",
"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": "e0b62c25-8b8e-4e50-a5db-19e7218df6fa",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-20T12:44:23.2266051+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e4f93486-3176-43ae-b380-b6a32b9a50ce"
},
"suggested_date_start": "2026-05-20T12:44:23.2266051+00:00",
"skill_id": "ad84d672-da68-4e98-abc0-05fb89c718db",
"skill_code": "sample string 32",
"skill": {
"id": "0be5fd92-b84b-49d3-99e9-46bad83fa630",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b23d80be-07b4-4721-a81f-ad5b0f144311",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4ef99bae-3af9-4450-9340-e6e339f2f821",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f6389e1-cac1-4d0b-8c26-61cd34800b18",
"db_currency_id": "3d743073-2083-4347-b70e-2eeffe93ef87",
"db_language_id": "b2e76487-e30c-4073-9ffd-bd6126bace3d",
"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-05-20T12:44:23.2266051+00:00"
},
"modified_dateutc": "2026-05-20T12:44:23.2266051+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0f765a02-60bd-44f3-a484-19fcd595e92b",
"date_reported_by_company": "2026-05-20T12:44:23.2266051+00:00",
"id2": 36,
"company_id": "5da6854d-ad91-4716-997b-99aca3406cf0",
"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": "a3186e73-2dde-460d-a458-c131a99cb68e",
"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-05-20T12:44:23.2266051+00:00"
},
"work_instruction_details_id": "528f7bff-e5c8-4e83-8ae8-311dbf72e66e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "30353734-8f28-45e4-bdf0-969501e66a38",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "29908688-c37b-4090-91fa-f5747ba799af",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-20T12:44:23.2266051+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": "a419fc50-3e28-430c-9a07-6bd444a02c2a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-20T12:44:23.2422329+00:00"
}