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": "aa5f1f8f-5f36-4538-b1e8-f65716b6e56e",
"jobs_id": "11888ecb-969c-4952-b031-2ffcf3cb6908",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bac84896-328e-4aa0-8ea3-c2b680ba0e40",
"_parent_id": "1f9321c3-b43f-419e-8388-d333e70cad97",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e4c13c23-4f21-4fb8-80cc-6ca217be78db",
"project_reference_back_office": "sample string 5",
"project": {
"id": "05ae0966-0cc1-40e7-a513-5382455798f1",
"_parent_id": "98a86868-b635-44a9-9d70-ef56ac16d4ab",
"root_parent_id": "14aad2e0-f3ab-4a6c-b1a3-99c4ac8c17ae",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9424d9ce-1c0a-4a02-9428-7cad3cd8217a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "546fbf0e-0c2f-4f97-ac8e-efe7b7daff7d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "98b8262d-09a8-4b19-9c78-630f536a0eae",
"_parent_code": "sample string 6",
"sales_organization_id": "512bfc8a-6211-4995-b5e9-7d9a28520f09",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1a2e4a90-e573-4396-9128-dee6230d6b1f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f2282dc-7e8f-41ea-b962-89a18f4fdee7",
"db_currency_id": "050eec90-a71f-4638-b141-2461ad06b4c5",
"db_language_id": "e08ada45-a2e2-4129-8b63-0c1f4f2cb775",
"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-08-29T04:35:29.2674408+00:00"
},
"modified_dateutc": "2026-08-29T04:35:29.2674408+00:00"
},
"equipment_model_id": "08aa11a5-f885-4f44-be13-a3161f5044e6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "64b435f3-27bf-4c35-a2f5-55bffd4e4370",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "13c68c0a-5559-4644-92e4-4b22a958e8fa",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "56da0d2a-c986-4939-b0b1-535195e04b21",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "920edca1-93e8-4513-b6c0-c30d03c6bb50",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1a2e4a90-e573-4396-9128-dee6230d6b1f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f2282dc-7e8f-41ea-b962-89a18f4fdee7",
"db_currency_id": "050eec90-a71f-4638-b141-2461ad06b4c5",
"db_language_id": "e08ada45-a2e2-4129-8b63-0c1f4f2cb775",
"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-08-29T04:35:29.2674408+00:00"
},
"modified_dateutc": "2026-08-29T04:35:29.283067+00:00"
},
"equipment_family_id": "8c25ccb9-c0b3-4d87-8ace-ed6052672b8e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "546fbf0e-0c2f-4f97-ac8e-efe7b7daff7d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "98b8262d-09a8-4b19-9c78-630f536a0eae",
"_parent_code": "sample string 6",
"sales_organization_id": "512bfc8a-6211-4995-b5e9-7d9a28520f09",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1a2e4a90-e573-4396-9128-dee6230d6b1f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f2282dc-7e8f-41ea-b962-89a18f4fdee7",
"db_currency_id": "050eec90-a71f-4638-b141-2461ad06b4c5",
"db_language_id": "e08ada45-a2e2-4129-8b63-0c1f4f2cb775",
"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-08-29T04:35:29.2674408+00:00"
},
"modified_dateutc": "2026-08-29T04:35:29.2674408+00:00"
},
"date_in_production_since": "2026-08-29T04:35:29.283067+00:00",
"date_out_of_production_since": "2026-08-29T04:35:29.283067+00:00",
"date_end_support": "2026-08-29T04:35:29.283067+00:00",
"sales_organization_id": "eea1b0bc-7059-4fd4-b1ae-7b77d23c6c0f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1a2e4a90-e573-4396-9128-dee6230d6b1f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f2282dc-7e8f-41ea-b962-89a18f4fdee7",
"db_currency_id": "050eec90-a71f-4638-b141-2461ad06b4c5",
"db_language_id": "e08ada45-a2e2-4129-8b63-0c1f4f2cb775",
"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-08-29T04:35:29.2674408+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-08-29T04:35:29.283067+00:00"
},
"project_status_id": "50a98619-3cb9-4004-9732-aceac9e76ef9",
"project_status_code": "sample string 10",
"project_status": {
"id": "15bd258f-4d40-41c3-93f9-4d19c76554d9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "682f9d3e-dc0f-46bd-a9f5-aa14b05defdf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a2e4a90-e573-4396-9128-dee6230d6b1f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f2282dc-7e8f-41ea-b962-89a18f4fdee7",
"db_currency_id": "050eec90-a71f-4638-b141-2461ad06b4c5",
"db_language_id": "e08ada45-a2e2-4129-8b63-0c1f4f2cb775",
"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-08-29T04:35:29.2674408+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-29T04:35:29.283067+00:00"
},
"company_id": "afa9a216-0783-4642-9b79-8d27d7d1fe55",
"company_code": "sample string 12",
"db_address_id": "0a47880c-2d92-43d8-b777-59e1d94157bf",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b19ce129-df87-45ee-bc6b-a31bc893daa2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "76f95b3b-cc57-4413-a4dc-e91b7c1f40fe",
"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-08-29T04:35:29.283067+00:00",
"date_create": "2026-08-29T04:35:29.283067+00:00",
"date_update": "2026-08-29T04:35:29.283067+00:00",
"updated_by_user_id": "7c5a2d91-b4ec-4675-979f-7c05327d7257",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-29T04:35:29.283067+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-08-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-29T04:35:29.283067+00:00",
"date_last_job": "2026-08-29T04:35:29.283067+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-29T04:35:29.283067+00:00",
"modified_dateutc": "2026-08-29T04:35:29.283067+00:00",
"is_mobile_installation": true
},
"job_type_id": "cf5ef5ed-2b8f-4387-85d1-f27e4f706087",
"job_type_code": "sample string 7",
"job_type": {
"id": "daa98d29-5c3f-48b4-a3b3-01c1239eed74",
"name": "sample string 2",
"sales_organization_id": "0ebf4078-97af-4ea5-ba23-74ad59823279",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-29T04:35:29.283067+00:00",
"code": "sample string 7"
},
"job_priority_id": "f37da47c-8be8-4da0-bac6-279a0f3cc294",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bc0b441f-4d4c-4bff-8eed-207bbcaf6205",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "25ae910c-dc2f-42c1-b82f-c2d31cec7b23",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a2e4a90-e573-4396-9128-dee6230d6b1f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f2282dc-7e8f-41ea-b962-89a18f4fdee7",
"db_currency_id": "050eec90-a71f-4638-b141-2461ad06b4c5",
"db_language_id": "e08ada45-a2e2-4129-8b63-0c1f4f2cb775",
"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-08-29T04:35:29.2674408+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-29T04:35:29.283067+00:00"
},
"job_status_id": "bc7655fd-a8ab-4a75-9b74-26b2b4fbb9d9",
"job_status_code": "sample string 11",
"db_address_id": "eeb82712-bbd1-47f9-ad1d-562c68dbe67d",
"contact_id": "c1e45d9e-bda4-4eb5-a736-ffeb601ecb48",
"requested_by_company_id": "b9b9ac92-17b8-44ab-88a7-4bbc03a77f6e",
"requested_by_contact_id": "6adb0bd0-fef2-4b9f-a069-82e9ef6e5204",
"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-08-29T04:35:29.283067+00:00",
"due_date": "2026-08-29T04:35:29.283067+00:00",
"date_create": "2026-08-29T04:35:29.283067+00:00",
"date_update": "2026-08-29T04:35:29.283067+00:00",
"date_closed": "2026-08-29T04:35:29.283067+00:00",
"suggested_user_id": "e0236350-8dbc-425f-9eeb-e7caea378e94",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d1a23a92-ed39-4c09-b530-d8943c378969",
"db_language_id": "425f003e-b322-436c-9e0a-1e38eb68d749",
"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-08-29T04:35:29.283067+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f1257926-61f7-4db6-b3c0-133d399a8075",
"sales_organization": {
"id": "1a2e4a90-e573-4396-9128-dee6230d6b1f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f2282dc-7e8f-41ea-b962-89a18f4fdee7",
"db_currency_id": "050eec90-a71f-4638-b141-2461ad06b4c5",
"db_language_id": "e08ada45-a2e2-4129-8b63-0c1f4f2cb775",
"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-08-29T04:35:29.2674408+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "57b60aae-e4de-4134-b5ba-a92e2f40edb1",
"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": "c2afe94e-1789-48b0-898d-977d30a7740a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-29T04:35:29.283067+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "751e9bd2-3bec-49ef-b3c4-9a02ad4ec853"
},
"suggested_date_start": "2026-08-29T04:35:29.283067+00:00",
"skill_id": "5fbb0a3f-663a-4d2d-98dc-f8ea95078b39",
"skill_code": "sample string 32",
"skill": {
"id": "55d1bb06-31e2-4134-927f-14d82b8f91c2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2a538379-7461-4436-b0ff-b669f43c5b70",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a2e4a90-e573-4396-9128-dee6230d6b1f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f2282dc-7e8f-41ea-b962-89a18f4fdee7",
"db_currency_id": "050eec90-a71f-4638-b141-2461ad06b4c5",
"db_language_id": "e08ada45-a2e2-4129-8b63-0c1f4f2cb775",
"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-08-29T04:35:29.2674408+00:00"
},
"modified_dateutc": "2026-08-29T04:35:29.283067+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4a9c7341-4b19-48bb-9f37-4c9a8c78e0b1",
"date_reported_by_company": "2026-08-29T04:35:29.283067+00:00",
"id2": 36,
"company_id": "57cd3f44-49b7-4bd9-bade-143f6d07ee4b",
"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": "6448ed85-f9f4-4e85-8627-8b585ab9ccd1",
"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-08-29T04:35:29.283067+00:00"
},
"work_instruction_details_id": "dde1bd80-8190-4c29-a907-bc496e0b9c9d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9b1abb32-f66e-4871-b481-86b6ccef5344",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4f6c5276-38e2-46f8-ac3b-d5a07114c807",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-29T04:35:29.283067+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": "6de75cdc-b076-4d9a-8bac-4363e1f7cc9b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-29T04:35:29.283067+00:00"
}