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": "6823e92e-eab2-4497-805c-1c40ad41a480",
"jobs_id": "2b5aea4d-fc5e-4702-8517-ffd6d988c68d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4e84a84d-2459-4725-b2ad-2fd81af00cec",
"_parent_id": "b8647fba-f3b3-460b-b302-04605317baae",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "458d0fc5-096d-49af-91bc-4ed20e75f5ac",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d9f20dcd-62ca-494c-afe8-e14e62508724",
"_parent_id": "c3245627-c03e-4faf-9928-5b3d82a8cf23",
"root_parent_id": "c2e59698-0ec8-4642-baa9-d3cf1476e99e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5f0b66a0-f37a-44bf-adfd-8a2cd0fdb19f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ed5f4792-479a-4a24-b0da-12815cde67be",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8c8f2c87-26cd-4a8d-ad62-63be8a55d816",
"_parent_code": "sample string 6",
"sales_organization_id": "c21820fe-070c-4b17-93e9-16b6cc0fe9bf",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "03757745-08cd-49e7-bee3-85c424cb720e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6550a4c6-fc6f-447b-b4c2-4a18a2095ac0",
"db_currency_id": "0cfedcde-dbcb-49e7-9c6c-ef4321c19883",
"db_language_id": "ed5f89f7-06cf-4f5c-a80d-8477ed20a176",
"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-11-05T07:37:35.0957626+00:00"
},
"modified_dateutc": "2026-11-05T07:37:35.0957626+00:00"
},
"equipment_model_id": "dcf49a98-d15d-49f8-ab59-be120fa1018a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8fdbb243-8a3c-43d1-bc69-417565d97037",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bb352bf7-fd56-4181-9a80-0a9ea60a4e6e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2c368a1c-60aa-41d5-ba5a-db114408979a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ab279bd0-0eca-4dc0-a8b0-e13fe6585529",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "03757745-08cd-49e7-bee3-85c424cb720e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6550a4c6-fc6f-447b-b4c2-4a18a2095ac0",
"db_currency_id": "0cfedcde-dbcb-49e7-9c6c-ef4321c19883",
"db_language_id": "ed5f89f7-06cf-4f5c-a80d-8477ed20a176",
"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-11-05T07:37:35.0957626+00:00"
},
"modified_dateutc": "2026-11-05T07:37:35.0957626+00:00"
},
"equipment_family_id": "238a9629-b6a6-4cf8-a1ef-e8caa64aafb6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ed5f4792-479a-4a24-b0da-12815cde67be",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8c8f2c87-26cd-4a8d-ad62-63be8a55d816",
"_parent_code": "sample string 6",
"sales_organization_id": "c21820fe-070c-4b17-93e9-16b6cc0fe9bf",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "03757745-08cd-49e7-bee3-85c424cb720e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6550a4c6-fc6f-447b-b4c2-4a18a2095ac0",
"db_currency_id": "0cfedcde-dbcb-49e7-9c6c-ef4321c19883",
"db_language_id": "ed5f89f7-06cf-4f5c-a80d-8477ed20a176",
"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-11-05T07:37:35.0957626+00:00"
},
"modified_dateutc": "2026-11-05T07:37:35.0957626+00:00"
},
"date_in_production_since": "2026-11-05T07:37:35.0957626+00:00",
"date_out_of_production_since": "2026-11-05T07:37:35.0957626+00:00",
"date_end_support": "2026-11-05T07:37:35.0957626+00:00",
"sales_organization_id": "46571139-3d79-411b-8a0d-96c1e109e4a9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "03757745-08cd-49e7-bee3-85c424cb720e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6550a4c6-fc6f-447b-b4c2-4a18a2095ac0",
"db_currency_id": "0cfedcde-dbcb-49e7-9c6c-ef4321c19883",
"db_language_id": "ed5f89f7-06cf-4f5c-a80d-8477ed20a176",
"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-11-05T07:37:35.0957626+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-11-05T07:37:35.1071998+00:00"
},
"project_status_id": "14fa799a-a474-4222-8f7e-6ca10891be96",
"project_status_code": "sample string 10",
"project_status": {
"id": "e0a2a49e-916b-4a32-ba44-dc3417bf2583",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "af62d03f-e3af-4d28-aa4c-be260219b273",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "03757745-08cd-49e7-bee3-85c424cb720e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6550a4c6-fc6f-447b-b4c2-4a18a2095ac0",
"db_currency_id": "0cfedcde-dbcb-49e7-9c6c-ef4321c19883",
"db_language_id": "ed5f89f7-06cf-4f5c-a80d-8477ed20a176",
"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-11-05T07:37:35.0957626+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-05T07:37:35.1071998+00:00"
},
"company_id": "ee476901-2c24-4615-a6e9-1bd698ac8171",
"company_code": "sample string 12",
"db_address_id": "bbb953f8-4197-4c5d-9105-a95acfca358f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "bd4542f8-e0d0-4cf1-b573-e62f3b827119",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d141ca7a-0c50-4a84-b79f-c602e3253112",
"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-11-05T07:37:35.1071998+00:00",
"date_create": "2026-11-05T07:37:35.1071998+00:00",
"date_update": "2026-11-05T07:37:35.1071998+00:00",
"updated_by_user_id": "cf23f912-d10c-4219-b4cc-e4b2ccc0f634",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-05T07:37:35.1071998+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-11-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-05T07:37:35.1071998+00:00",
"date_last_job": "2026-11-05T07:37:35.1071998+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-05T07:37:35.1071998+00:00",
"modified_dateutc": "2026-11-05T07:37:35.1071998+00:00",
"is_mobile_installation": true
},
"job_type_id": "9ce9b1f7-0853-43e0-b16c-762689522b46",
"job_type_code": "sample string 7",
"job_type": {
"id": "3c2a4a63-10c4-46b6-94ad-4549e4e358ab",
"name": "sample string 2",
"sales_organization_id": "e4b85566-1e6a-4746-aa64-197e83064d89",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-05T07:37:35.1071998+00:00",
"code": "sample string 7"
},
"job_priority_id": "e0600ce0-82bb-46d6-ad06-7d52eb123b76",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3125a44a-0673-4570-937f-1da3e815258c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1e50c1fc-4de2-4d8c-ae2f-ce1e8859acca",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "03757745-08cd-49e7-bee3-85c424cb720e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6550a4c6-fc6f-447b-b4c2-4a18a2095ac0",
"db_currency_id": "0cfedcde-dbcb-49e7-9c6c-ef4321c19883",
"db_language_id": "ed5f89f7-06cf-4f5c-a80d-8477ed20a176",
"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-11-05T07:37:35.0957626+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-05T07:37:35.1071998+00:00"
},
"job_status_id": "f5354874-41a4-4cdb-a2b8-e2f96ea66c0d",
"job_status_code": "sample string 11",
"db_address_id": "c73383b1-bca3-4a76-9504-4c5aa8045a8d",
"contact_id": "bb755122-c56c-4343-8ed8-3c3a64eb1095",
"requested_by_company_id": "1379e940-7dcc-4062-9386-e00a25a681b3",
"requested_by_contact_id": "1ded7335-8948-4ee1-84a1-da8caee2a58b",
"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-11-05T07:37:35.1236865+00:00",
"due_date": "2026-11-05T07:37:35.1236865+00:00",
"date_create": "2026-11-05T07:37:35.1236865+00:00",
"date_update": "2026-11-05T07:37:35.1236865+00:00",
"date_closed": "2026-11-05T07:37:35.1236865+00:00",
"suggested_user_id": "5547b2ca-6fe4-4861-ab69-37b90cf226c0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "31c3c2db-6ef4-4d74-b033-9c7a99a85995",
"db_language_id": "0dbaf9c0-b6bb-49ff-b3f3-8be1b0dce4bf",
"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-11-05T07:37:35.1236865+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2cbd6224-5fd0-43c2-b420-a8ee77d59001",
"sales_organization": {
"id": "03757745-08cd-49e7-bee3-85c424cb720e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6550a4c6-fc6f-447b-b4c2-4a18a2095ac0",
"db_currency_id": "0cfedcde-dbcb-49e7-9c6c-ef4321c19883",
"db_language_id": "ed5f89f7-06cf-4f5c-a80d-8477ed20a176",
"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-11-05T07:37:35.0957626+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3278e48e-f36c-48f1-ae45-5642bd62efdb",
"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": "e7cfd7c4-fb9b-433d-b727-5b170cc48f40",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-05T07:37:35.1236865+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9a337d02-6f91-40ba-96cb-8e1a9f7bf3b4"
},
"suggested_date_start": "2026-11-05T07:37:35.1236865+00:00",
"skill_id": "a9ef4fdf-d676-4443-be6a-5f26a3375ef6",
"skill_code": "sample string 32",
"skill": {
"id": "ca2d7665-2ad6-4cb1-9470-f0f28635d2b9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f86d1367-a631-4c9f-b3ae-558a0da1158d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "03757745-08cd-49e7-bee3-85c424cb720e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6550a4c6-fc6f-447b-b4c2-4a18a2095ac0",
"db_currency_id": "0cfedcde-dbcb-49e7-9c6c-ef4321c19883",
"db_language_id": "ed5f89f7-06cf-4f5c-a80d-8477ed20a176",
"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-11-05T07:37:35.0957626+00:00"
},
"modified_dateutc": "2026-11-05T07:37:35.1236865+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4ea84d24-fdcd-43ba-a634-134907dfe71a",
"date_reported_by_company": "2026-11-05T07:37:35.1236865+00:00",
"id2": 36,
"company_id": "2430e0d5-2550-4a4c-b88c-39454382133e",
"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": "aba275c8-bc08-4fbd-8dad-bb8510f0cd98",
"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-11-05T07:37:35.1236865+00:00"
},
"work_instruction_details_id": "15fdf493-f4f8-4c17-beea-6a775ee0cd8e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c8c5e870-bced-4b0d-8bd6-546948c59af2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "00c67841-2adf-44e7-84a4-620d29adbc8f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-05T07:37:35.1236865+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": "5d0dabbb-3a9a-44f4-a1ee-f2349c370143",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-05T07:37:35.1236865+00:00"
}