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": "67356799-fed9-4498-aac2-d275c9572741",
"jobs_id": "e3a133e9-76c2-4389-b297-785c35a064af",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "211dca58-6478-4c46-8e4d-94ec3707e764",
"_parent_id": "235340cc-7260-41c1-a7ee-b95e556f5fbc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b99c8d8f-3af8-4fde-9e47-e152284566a3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7eace380-4a99-4946-9680-6c30d22665b3",
"_parent_id": "1bedb990-3a99-4432-8f15-6306218a76f4",
"root_parent_id": "6a5f7021-49f2-4199-8d5c-f9fcd1b40b1f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c6d2fcbd-720e-451e-bab6-cd2c58bf57bf",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "83abcda0-73aa-4993-866e-627bad898b0d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "94202a77-cf3d-4730-95dd-1ae6a264ef3e",
"_parent_code": "sample string 6",
"sales_organization_id": "fb031adb-82f5-42cc-b108-a520d98f95b8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c3e5b85d-c364-41c4-ab0a-107bc4170464",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08d7a361-9e2c-4b01-8c4b-4a9c9195db28",
"db_currency_id": "c31dcc56-0b0f-4208-bb29-e588d2fb0531",
"db_language_id": "a7a4845a-fffe-43d6-865a-fa7ba21067be",
"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-12T19:48:14.2073136+00:00"
},
"modified_dateutc": "2026-01-12T19:48:14.2073136+00:00"
},
"equipment_model_id": "db612840-da7c-4cc2-bf88-525248ef4ee4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fbd8e891-4e2f-4e8c-bb0d-7b7deb5e2633",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1f48c616-2dd0-43dd-9aa9-23a4687f87d0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "878fdd2a-352a-47cc-9475-45fda982b0c6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0466243d-2dee-489e-a113-6b2d7fe3556e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c3e5b85d-c364-41c4-ab0a-107bc4170464",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08d7a361-9e2c-4b01-8c4b-4a9c9195db28",
"db_currency_id": "c31dcc56-0b0f-4208-bb29-e588d2fb0531",
"db_language_id": "a7a4845a-fffe-43d6-865a-fa7ba21067be",
"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-12T19:48:14.2073136+00:00"
},
"modified_dateutc": "2026-01-12T19:48:14.2073136+00:00"
},
"equipment_family_id": "8447df5a-4edb-4be4-8686-faaf562b0a2d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "83abcda0-73aa-4993-866e-627bad898b0d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "94202a77-cf3d-4730-95dd-1ae6a264ef3e",
"_parent_code": "sample string 6",
"sales_organization_id": "fb031adb-82f5-42cc-b108-a520d98f95b8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c3e5b85d-c364-41c4-ab0a-107bc4170464",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08d7a361-9e2c-4b01-8c4b-4a9c9195db28",
"db_currency_id": "c31dcc56-0b0f-4208-bb29-e588d2fb0531",
"db_language_id": "a7a4845a-fffe-43d6-865a-fa7ba21067be",
"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-12T19:48:14.2073136+00:00"
},
"modified_dateutc": "2026-01-12T19:48:14.2073136+00:00"
},
"date_in_production_since": "2026-01-12T19:48:14.2073136+00:00",
"date_out_of_production_since": "2026-01-12T19:48:14.2073136+00:00",
"date_end_support": "2026-01-12T19:48:14.2073136+00:00",
"sales_organization_id": "23eb1624-0ea0-4743-9676-9aaa5ba777b1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c3e5b85d-c364-41c4-ab0a-107bc4170464",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08d7a361-9e2c-4b01-8c4b-4a9c9195db28",
"db_currency_id": "c31dcc56-0b0f-4208-bb29-e588d2fb0531",
"db_language_id": "a7a4845a-fffe-43d6-865a-fa7ba21067be",
"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-12T19:48:14.2073136+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-12T19:48:14.2229468+00:00"
},
"project_status_id": "5bc08940-d112-495f-ba5d-a6f355150b47",
"project_status_code": "sample string 10",
"project_status": {
"id": "7a764c44-2188-4e17-bac7-40c7147326df",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9cc34828-8597-47cb-b336-156a49eed110",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c3e5b85d-c364-41c4-ab0a-107bc4170464",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08d7a361-9e2c-4b01-8c4b-4a9c9195db28",
"db_currency_id": "c31dcc56-0b0f-4208-bb29-e588d2fb0531",
"db_language_id": "a7a4845a-fffe-43d6-865a-fa7ba21067be",
"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-12T19:48:14.2073136+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-12T19:48:14.2229468+00:00"
},
"company_id": "1f4c00fb-ddb2-492f-8534-8a6daf02c91e",
"company_code": "sample string 12",
"db_address_id": "c5627e36-f534-4a44-8878-983791cc45c5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5382ec9a-fb0e-4ba6-8e4c-99e642407bff",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c64019ee-5d8d-4644-9744-a4805936d646",
"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-12T19:48:14.2229468+00:00",
"date_create": "2026-01-12T19:48:14.2229468+00:00",
"date_update": "2026-01-12T19:48:14.2229468+00:00",
"updated_by_user_id": "15f8c855-b08f-4ce8-8f84-c11ea54a7b1e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-12T19:48:14.2229468+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-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-12T19:48:14.2229468+00:00",
"date_last_job": "2026-01-12T19:48:14.2229468+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-12T19:48:14.2229468+00:00",
"modified_dateutc": "2026-01-12T19:48:14.2229468+00:00",
"is_mobile_installation": true
},
"job_type_id": "330da64c-0fda-41ee-9d89-16c8c65bcabe",
"job_type_code": "sample string 7",
"job_type": {
"id": "1184aef4-8319-4201-8e1d-fcb5002a780d",
"name": "sample string 2",
"sales_organization_id": "e06482b9-7aa9-4782-bdf9-b1c33b1fb6c3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-12T19:48:14.2229468+00:00",
"code": "sample string 7"
},
"job_priority_id": "df876640-e156-4efe-88cd-83c6d11bdb16",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6b7369bf-1c93-4751-9e5e-522f50be7c2a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6d0b820b-93ef-47d1-8d59-90df1d1ad9db",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c3e5b85d-c364-41c4-ab0a-107bc4170464",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08d7a361-9e2c-4b01-8c4b-4a9c9195db28",
"db_currency_id": "c31dcc56-0b0f-4208-bb29-e588d2fb0531",
"db_language_id": "a7a4845a-fffe-43d6-865a-fa7ba21067be",
"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-12T19:48:14.2073136+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-12T19:48:14.2229468+00:00"
},
"job_status_id": "28792c26-1afe-4457-9e34-5873f6fcdd7b",
"job_status_code": "sample string 11",
"db_address_id": "9bf468b6-f476-432b-998a-a3abfe116708",
"contact_id": "3e5d5869-f46d-4b9f-84b8-2e8796ab148f",
"requested_by_company_id": "6fd3b57d-50ea-4d7d-86ab-d69019745bfb",
"requested_by_contact_id": "70b9d688-46b7-4058-94ce-05989797a03d",
"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-12T19:48:14.2229468+00:00",
"due_date": "2026-01-12T19:48:14.2229468+00:00",
"date_create": "2026-01-12T19:48:14.2229468+00:00",
"date_update": "2026-01-12T19:48:14.2229468+00:00",
"date_closed": "2026-01-12T19:48:14.2229468+00:00",
"suggested_user_id": "07fc19cc-bbb5-4195-afde-f783cf0bf691",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "991d862e-28e2-4976-a29f-f19096d1504e",
"db_language_id": "a42e7154-0d2a-4fa4-a7c0-2a7c5d79609c",
"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-12T19:48:14.2229468+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "41f30cad-5961-49d0-92e9-4008aaac89ce",
"sales_organization": {
"id": "c3e5b85d-c364-41c4-ab0a-107bc4170464",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08d7a361-9e2c-4b01-8c4b-4a9c9195db28",
"db_currency_id": "c31dcc56-0b0f-4208-bb29-e588d2fb0531",
"db_language_id": "a7a4845a-fffe-43d6-865a-fa7ba21067be",
"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-12T19:48:14.2073136+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e2344d5e-0d27-4864-a7a7-16618caff8da",
"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": "abc228a9-a877-484b-8c10-6038e5e734b7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-12T19:48:14.2229468+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "76848678-7697-42af-9555-22e785c8eb17"
},
"suggested_date_start": "2026-01-12T19:48:14.2229468+00:00",
"skill_id": "6c7bcffb-2c9e-4a67-bd3b-fd6e02569304",
"skill_code": "sample string 32",
"skill": {
"id": "81cd4dec-a581-405f-83f5-b84fc76b5abd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "741e0fd0-767a-45d9-b7bd-9e028be431a2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c3e5b85d-c364-41c4-ab0a-107bc4170464",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08d7a361-9e2c-4b01-8c4b-4a9c9195db28",
"db_currency_id": "c31dcc56-0b0f-4208-bb29-e588d2fb0531",
"db_language_id": "a7a4845a-fffe-43d6-865a-fa7ba21067be",
"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-12T19:48:14.2073136+00:00"
},
"modified_dateutc": "2026-01-12T19:48:14.2229468+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2a62febe-0f15-4c5f-8499-f48a8037e3e9",
"date_reported_by_company": "2026-01-12T19:48:14.2229468+00:00",
"id2": 36,
"company_id": "13380617-b46b-448b-91f3-0776b7587e0a",
"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": "f14ba5c7-4ee8-48ce-a54c-58c5a01d7664",
"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-12T19:48:14.2229468+00:00"
},
"work_instruction_details_id": "4c5a4a2c-fada-4011-b67f-3e261e920dfb",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ffd13988-8756-4123-9146-38f39f97e90f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "be490ef6-3125-4922-9f43-30a2e4de6eff",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-12T19:48:14.2229468+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": "7dd70342-fd30-447c-9dab-faac04d6ba37",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-12T19:48:14.2229468+00:00"
}