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": "1b50222a-620e-486c-abe5-cc6c082c140e",
"jobs_id": "25e7833b-51b4-45d1-9653-9e763a9d54f7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3738255e-3870-4c4a-ba6c-9dcbe6ef32a9",
"_parent_id": "66c1220f-3c66-4c3e-a9af-9289e596d21f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3e95911b-dbb3-445f-ac47-374c07dcb43e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "56247696-1dca-4c08-9527-52cae9879b10",
"_parent_id": "61cbd406-ac10-494d-a150-0cdd82648216",
"root_parent_id": "77786af7-6829-4abf-975f-9b61ff63e8a3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c4c5dbd1-c0d0-4d90-8f1d-225f42363cf1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cfb78ddf-e03c-4f5a-a062-0e0b544e73df",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b07832d4-4e37-4770-afdc-c068a73accc7",
"_parent_code": "sample string 6",
"sales_organization_id": "b4dc8f64-cdcf-4983-ae04-fec085bb6d9b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4d73acf4-1b49-48f3-870a-f2e1cb19fe64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57cae4d4-c790-47d7-9fe8-85f316acbd80",
"db_currency_id": "c273a395-0501-4b75-b474-12e427fb996f",
"db_language_id": "31c85f09-79a2-4f12-baa9-1ea3abb72a61",
"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-02-04T21:11:39.381184+00:00"
},
"modified_dateutc": "2026-02-04T21:11:39.381184+00:00"
},
"equipment_model_id": "77e02864-3dc5-4d90-8f28-d12428ac15d1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f0177382-4b06-4ac5-ab7c-8c89a716dfbd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7759b70f-88cb-4229-8f72-a5e56e6089f2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "783ee955-495c-4481-839a-1623c3a97b4d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "499fea77-fe68-4665-9b2a-ae607dbf6e53",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4d73acf4-1b49-48f3-870a-f2e1cb19fe64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57cae4d4-c790-47d7-9fe8-85f316acbd80",
"db_currency_id": "c273a395-0501-4b75-b474-12e427fb996f",
"db_language_id": "31c85f09-79a2-4f12-baa9-1ea3abb72a61",
"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-02-04T21:11:39.381184+00:00"
},
"modified_dateutc": "2026-02-04T21:11:39.381184+00:00"
},
"equipment_family_id": "043cc9ee-ce6a-43ff-8a68-1433f8a6cef8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cfb78ddf-e03c-4f5a-a062-0e0b544e73df",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b07832d4-4e37-4770-afdc-c068a73accc7",
"_parent_code": "sample string 6",
"sales_organization_id": "b4dc8f64-cdcf-4983-ae04-fec085bb6d9b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4d73acf4-1b49-48f3-870a-f2e1cb19fe64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57cae4d4-c790-47d7-9fe8-85f316acbd80",
"db_currency_id": "c273a395-0501-4b75-b474-12e427fb996f",
"db_language_id": "31c85f09-79a2-4f12-baa9-1ea3abb72a61",
"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-02-04T21:11:39.381184+00:00"
},
"modified_dateutc": "2026-02-04T21:11:39.381184+00:00"
},
"date_in_production_since": "2026-02-04T21:11:39.381184+00:00",
"date_out_of_production_since": "2026-02-04T21:11:39.381184+00:00",
"date_end_support": "2026-02-04T21:11:39.381184+00:00",
"sales_organization_id": "be201025-87bb-4d1f-ab56-889c2cfa1437",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4d73acf4-1b49-48f3-870a-f2e1cb19fe64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57cae4d4-c790-47d7-9fe8-85f316acbd80",
"db_currency_id": "c273a395-0501-4b75-b474-12e427fb996f",
"db_language_id": "31c85f09-79a2-4f12-baa9-1ea3abb72a61",
"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-02-04T21:11:39.381184+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-02-04T21:11:39.381184+00:00"
},
"project_status_id": "d835db39-811b-4b8c-a410-e893081d36ce",
"project_status_code": "sample string 10",
"project_status": {
"id": "acc68976-c69e-4f79-8e7f-cbf31b1b7ea6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d60c67ee-bf3b-463f-86f5-b2a48e84df0d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4d73acf4-1b49-48f3-870a-f2e1cb19fe64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57cae4d4-c790-47d7-9fe8-85f316acbd80",
"db_currency_id": "c273a395-0501-4b75-b474-12e427fb996f",
"db_language_id": "31c85f09-79a2-4f12-baa9-1ea3abb72a61",
"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-02-04T21:11:39.381184+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-04T21:11:39.381184+00:00"
},
"company_id": "e9fb7a14-2647-4d2f-8dff-e8c3a03d80af",
"company_code": "sample string 12",
"db_address_id": "ba07850c-6c5b-4676-bdff-dedd341ccff5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8654d2c4-8dab-49a8-8f71-f9124faebd99",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d2745ef2-c7d8-481d-9299-ad45e71ce3e7",
"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-02-04T21:11:39.381184+00:00",
"date_create": "2026-02-04T21:11:39.381184+00:00",
"date_update": "2026-02-04T21:11:39.381184+00:00",
"updated_by_user_id": "c0ed15e2-c100-4e95-8217-3049c1f8325a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-04T21:11:39.381184+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-02-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-04T21:11:39.381184+00:00",
"date_last_job": "2026-02-04T21:11:39.381184+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-04T21:11:39.381184+00:00",
"modified_dateutc": "2026-02-04T21:11:39.381184+00:00",
"is_mobile_installation": true
},
"job_type_id": "2b860138-85c9-42d8-b3be-e2168a9130f0",
"job_type_code": "sample string 7",
"job_type": {
"id": "fb59316c-87d5-4faa-8f15-6e377db48cd5",
"name": "sample string 2",
"sales_organization_id": "9d872024-46fc-4c53-af17-32508b820ac3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-04T21:11:39.381184+00:00",
"code": "sample string 7"
},
"job_priority_id": "e10f6fca-de3c-43ec-a15b-8e9aabbe789e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fde5da08-eb99-47e3-b8f5-8cb30d9822cd",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e209ca72-1586-458d-9e56-c0017726621a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4d73acf4-1b49-48f3-870a-f2e1cb19fe64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57cae4d4-c790-47d7-9fe8-85f316acbd80",
"db_currency_id": "c273a395-0501-4b75-b474-12e427fb996f",
"db_language_id": "31c85f09-79a2-4f12-baa9-1ea3abb72a61",
"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-02-04T21:11:39.381184+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-04T21:11:39.381184+00:00"
},
"job_status_id": "27c600aa-3857-4412-99e9-78c5feaef743",
"job_status_code": "sample string 11",
"db_address_id": "d336e336-fb67-41e4-ad41-db043b21d050",
"contact_id": "9b8ebe0d-f8cb-4d6d-a3ee-dd1afbe8c09c",
"requested_by_company_id": "dac8cc33-6154-4660-9126-4f4bf0589516",
"requested_by_contact_id": "93a5efe1-ff18-411e-af8c-0eafd1fccc9e",
"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-02-04T21:11:39.381184+00:00",
"due_date": "2026-02-04T21:11:39.381184+00:00",
"date_create": "2026-02-04T21:11:39.381184+00:00",
"date_update": "2026-02-04T21:11:39.381184+00:00",
"date_closed": "2026-02-04T21:11:39.381184+00:00",
"suggested_user_id": "8215386e-8dea-49ad-9901-ed09222967b8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "be0ef48c-7bbb-49af-a567-2b2d65d32ed7",
"db_language_id": "811a9171-73c2-4452-8c5d-128afdb1af5b",
"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-02-04T21:11:39.381184+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "149e60ea-5d94-464a-9a9a-390b84faee90",
"sales_organization": {
"id": "4d73acf4-1b49-48f3-870a-f2e1cb19fe64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57cae4d4-c790-47d7-9fe8-85f316acbd80",
"db_currency_id": "c273a395-0501-4b75-b474-12e427fb996f",
"db_language_id": "31c85f09-79a2-4f12-baa9-1ea3abb72a61",
"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-02-04T21:11:39.381184+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a8b2b9c3-f0ab-495d-b9e1-fb8e71e04fd9",
"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": "0a868caa-6ffa-4c50-8824-60078473b52b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-04T21:11:39.381184+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a14eca72-f1b0-4de4-a4c5-1323a04b86c5"
},
"suggested_date_start": "2026-02-04T21:11:39.381184+00:00",
"skill_id": "28f8a011-046b-462a-a06c-8da6d4b9d3ce",
"skill_code": "sample string 32",
"skill": {
"id": "ff7069f3-94de-4e43-8d9a-461bb24e7e3b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8c8b9670-59e2-488e-80f2-25749224fd62",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4d73acf4-1b49-48f3-870a-f2e1cb19fe64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57cae4d4-c790-47d7-9fe8-85f316acbd80",
"db_currency_id": "c273a395-0501-4b75-b474-12e427fb996f",
"db_language_id": "31c85f09-79a2-4f12-baa9-1ea3abb72a61",
"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-02-04T21:11:39.381184+00:00"
},
"modified_dateutc": "2026-02-04T21:11:39.381184+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a00c2704-0b66-4966-aa33-39d767e99a12",
"date_reported_by_company": "2026-02-04T21:11:39.381184+00:00",
"id2": 36,
"company_id": "9ee3856f-8ba9-4fab-afd4-7e2d0cccd74a",
"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": "e74d5248-6417-4b4e-8704-715740b53134",
"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-02-04T21:11:39.381184+00:00"
},
"work_instruction_details_id": "2d6a1ec1-107c-4839-985a-af994af1a9ce",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "49b8e5bc-ad5e-4909-95fa-6d75b77716c8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fc0b6821-6dca-439b-af9d-098aaaedebd8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-04T21:11:39.381184+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": "d45df91c-99f5-4986-90eb-01575194c2b5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-04T21:11:39.3967756+00:00"
}