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": "f6c38319-500a-4c1d-9865-8cc51bb0b89a",
"jobs_id": "3bb2491c-66a8-4b49-83be-fd14c72c3a55",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "014410bb-7a2e-4298-bff4-a373d5587dfc",
"_parent_id": "8b312658-5542-47a3-921c-bb98502d0edc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0a877150-88bf-4bfb-8104-54bed9d03106",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6efe5ef8-0f60-4f52-b20e-58544cb0b06e",
"_parent_id": "d91be303-c596-460f-bd9d-500275ea4b0c",
"root_parent_id": "6123c8f9-20a5-4b08-a57f-6ccb4adcbbff",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d45a5252-7cf0-4b44-b2b3-efd96bb0336d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3e07e98c-0e9b-424a-9298-4815d655942d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2d91e033-44f2-4b30-9b04-5bc89124ea82",
"_parent_code": "sample string 6",
"sales_organization_id": "2c515fb7-29cc-4737-8804-c1a7179b48b6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1bfec7c0-aac6-4143-af41-3c8d3d9eca8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f661f7dd-8590-4f9d-8169-9536fd9a9753",
"db_currency_id": "80cdf028-5c0d-43d0-96ee-d9c15b963db7",
"db_language_id": "39c8d26e-7609-46c6-8783-0d26d626623c",
"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-01-17T09:22:22.0644484+00:00"
},
"modified_dateutc": "2026-01-17T09:22:22.0768523+00:00"
},
"equipment_model_id": "692acd27-7a65-4252-bd5f-35a80881ac79",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "21b23511-61f1-4db5-a564-2ac1872de936",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5b18da1a-ff67-4a25-8de1-ac25aafadb6d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5df585db-c419-4fb0-98f7-eaa1a6c4c03f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0a120f4e-6f1a-4d02-8aa3-d69a4c5a634c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1bfec7c0-aac6-4143-af41-3c8d3d9eca8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f661f7dd-8590-4f9d-8169-9536fd9a9753",
"db_currency_id": "80cdf028-5c0d-43d0-96ee-d9c15b963db7",
"db_language_id": "39c8d26e-7609-46c6-8783-0d26d626623c",
"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-01-17T09:22:22.0644484+00:00"
},
"modified_dateutc": "2026-01-17T09:22:22.0768523+00:00"
},
"equipment_family_id": "5c9cbbe0-3999-40e9-8c51-ed8165bbeed6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3e07e98c-0e9b-424a-9298-4815d655942d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2d91e033-44f2-4b30-9b04-5bc89124ea82",
"_parent_code": "sample string 6",
"sales_organization_id": "2c515fb7-29cc-4737-8804-c1a7179b48b6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1bfec7c0-aac6-4143-af41-3c8d3d9eca8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f661f7dd-8590-4f9d-8169-9536fd9a9753",
"db_currency_id": "80cdf028-5c0d-43d0-96ee-d9c15b963db7",
"db_language_id": "39c8d26e-7609-46c6-8783-0d26d626623c",
"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-01-17T09:22:22.0644484+00:00"
},
"modified_dateutc": "2026-01-17T09:22:22.0768523+00:00"
},
"date_in_production_since": "2026-01-17T09:22:22.0768523+00:00",
"date_out_of_production_since": "2026-01-17T09:22:22.0768523+00:00",
"date_end_support": "2026-01-17T09:22:22.0768523+00:00",
"sales_organization_id": "603cc132-0d57-4965-9a6b-9162530b7daa",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1bfec7c0-aac6-4143-af41-3c8d3d9eca8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f661f7dd-8590-4f9d-8169-9536fd9a9753",
"db_currency_id": "80cdf028-5c0d-43d0-96ee-d9c15b963db7",
"db_language_id": "39c8d26e-7609-46c6-8783-0d26d626623c",
"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-01-17T09:22:22.0644484+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-01-17T09:22:22.0768523+00:00"
},
"project_status_id": "ef3d9ae8-8900-46a7-8415-f15d1a740166",
"project_status_code": "sample string 10",
"project_status": {
"id": "08ac799f-4310-4ad5-8e45-fdc43a2ebff6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0ebdf6bb-bd2e-4633-9999-a0f9d02f9bf9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1bfec7c0-aac6-4143-af41-3c8d3d9eca8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f661f7dd-8590-4f9d-8169-9536fd9a9753",
"db_currency_id": "80cdf028-5c0d-43d0-96ee-d9c15b963db7",
"db_language_id": "39c8d26e-7609-46c6-8783-0d26d626623c",
"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-01-17T09:22:22.0644484+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-17T09:22:22.0768523+00:00"
},
"company_id": "13a3e3b1-5734-4849-8046-b128fb8d89b8",
"company_code": "sample string 12",
"db_address_id": "9c7348ec-e3aa-469e-a84b-d361dd8b5d4b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "333c555c-8bb8-47c9-98df-777b6173802f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ea872e3d-389f-4705-9b2d-0ba88bf869b9",
"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-01-17T09:22:22.0768523+00:00",
"date_create": "2026-01-17T09:22:22.0768523+00:00",
"date_update": "2026-01-17T09:22:22.0768523+00:00",
"updated_by_user_id": "7670efae-8104-4232-8192-d830a498da0d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-17T09:22:22.0768523+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-01-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-17T09:22:22.0768523+00:00",
"date_last_job": "2026-01-17T09:22:22.0768523+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-17T09:22:22.0768523+00:00",
"modified_dateutc": "2026-01-17T09:22:22.0768523+00:00",
"is_mobile_installation": true
},
"job_type_id": "b8c7460d-57f5-4e7c-a020-1a87a267a966",
"job_type_code": "sample string 7",
"job_type": {
"id": "002ca0cc-bdc3-45a5-ae2f-09051ab75531",
"name": "sample string 2",
"sales_organization_id": "39320446-3fbf-4a49-be2e-50fbc190ac89",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-17T09:22:22.0768523+00:00",
"code": "sample string 7"
},
"job_priority_id": "3cf1090a-479c-4a1d-ab0e-5d7d6376fea8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a777f160-7c9f-4eab-89b8-c479c1abb99e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "896a4dec-1647-4f25-938b-e72786bd8b64",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1bfec7c0-aac6-4143-af41-3c8d3d9eca8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f661f7dd-8590-4f9d-8169-9536fd9a9753",
"db_currency_id": "80cdf028-5c0d-43d0-96ee-d9c15b963db7",
"db_language_id": "39c8d26e-7609-46c6-8783-0d26d626623c",
"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-01-17T09:22:22.0644484+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-17T09:22:22.0768523+00:00"
},
"job_status_id": "89bf927f-7f21-483d-8b02-c533a6d0922d",
"job_status_code": "sample string 11",
"db_address_id": "7f7ec0ed-cf86-4344-8158-473b8ad048c9",
"contact_id": "56bcebca-f135-4621-9f2a-ab6b473b0537",
"requested_by_company_id": "639f70c1-7f80-4d41-a53b-8dce6420eeb5",
"requested_by_contact_id": "f48d67d1-808c-4f3c-8f3a-fa3c21b41410",
"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-01-17T09:22:22.0768523+00:00",
"due_date": "2026-01-17T09:22:22.0768523+00:00",
"date_create": "2026-01-17T09:22:22.0768523+00:00",
"date_update": "2026-01-17T09:22:22.0768523+00:00",
"date_closed": "2026-01-17T09:22:22.0768523+00:00",
"suggested_user_id": "b38795e0-7879-45c1-808e-3e47911dfbc6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9fac1059-bd3f-4704-b851-e8e56a364a5d",
"db_language_id": "45306f02-5a73-4935-9f11-f1810d93aab3",
"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-01-17T09:22:22.0768523+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5263f759-6f63-4767-ba3d-178b563040c1",
"sales_organization": {
"id": "1bfec7c0-aac6-4143-af41-3c8d3d9eca8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f661f7dd-8590-4f9d-8169-9536fd9a9753",
"db_currency_id": "80cdf028-5c0d-43d0-96ee-d9c15b963db7",
"db_language_id": "39c8d26e-7609-46c6-8783-0d26d626623c",
"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-01-17T09:22:22.0644484+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a1c6ae4a-f6b7-4011-9fd2-889eba471c3f",
"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": "9a038c55-dc9c-4f58-a8a9-6733a906f6b5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-17T09:22:22.0768523+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3638029b-af30-4d27-bc44-beb34c61b195"
},
"suggested_date_start": "2026-01-17T09:22:22.0768523+00:00",
"skill_id": "67728f33-9ef4-4418-ba11-6486fed862e3",
"skill_code": "sample string 32",
"skill": {
"id": "2c01d2cf-dde7-48ad-be7b-4b714a542ca3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4a0ba23d-1f08-4fed-a4c1-efd99d87c854",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1bfec7c0-aac6-4143-af41-3c8d3d9eca8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f661f7dd-8590-4f9d-8169-9536fd9a9753",
"db_currency_id": "80cdf028-5c0d-43d0-96ee-d9c15b963db7",
"db_language_id": "39c8d26e-7609-46c6-8783-0d26d626623c",
"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-01-17T09:22:22.0644484+00:00"
},
"modified_dateutc": "2026-01-17T09:22:22.0768523+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "459b5ef9-6141-48a0-85ca-9bdd727e17bb",
"date_reported_by_company": "2026-01-17T09:22:22.0768523+00:00",
"id2": 36,
"company_id": "81a6dd33-ddfd-4297-92b5-5e6f9a2bef66",
"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": "05a43029-011b-42fc-b583-b7c185c25fb9",
"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-01-17T09:22:22.0768523+00:00"
},
"work_instruction_details_id": "34f95ed8-3a11-4d16-a7dc-2870e6960abe",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2d898ea2-b642-43af-8e3a-e03ff717c8d4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f9c47c31-1b58-419e-aae5-91db61a65aeb",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-17T09:22:22.0768523+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": "3bccd26d-4e6f-4678-a525-f91021ab089c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-17T09:22:22.0768523+00:00"
}