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": "0afda79d-6595-4806-8632-9cb05d2436ee",
"jobs_id": "115d8db7-7565-4a35-a4e6-3aa385a6ef96",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b137829c-c22d-48fc-9991-76fdc08ba6f0",
"_parent_id": "e00e13c6-6a98-4c5f-934e-3c5529fc0e44",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "80da6c07-2bcb-476a-b418-506a9d86d716",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8586e394-075d-42a9-857c-3e1f47405ae5",
"_parent_id": "c831fa0f-39fa-4a9a-bc72-457a0a02e914",
"root_parent_id": "afe8eeec-9f2c-40c7-ac52-c827bb295e45",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "488d8d70-d607-481b-aaec-4ff66d8bb7f6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "63287693-e81e-446d-b95e-5b34629e6dd1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "216a5930-e1cf-4f05-8bf2-df4d5af3ac6d",
"_parent_code": "sample string 6",
"sales_organization_id": "5ac5f88d-92da-427c-88ff-206de467283f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9851b041-63a3-47fb-8d0e-512282879689",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7e9647c5-f4c6-4814-89f3-eff886df23b9",
"db_currency_id": "e1b0ba27-20ca-4584-9219-95ee005f8402",
"db_language_id": "63f987c4-8f55-4743-9a69-34987f55cca4",
"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-07-22T04:23:37.0021022+00:00"
},
"modified_dateutc": "2026-07-22T04:23:37.0021022+00:00"
},
"equipment_model_id": "10e307bb-6362-4fd9-a3f9-07c4787532a8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "eead9afb-ec0f-4a98-92e5-322bbb7c6f67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "553424b1-4c43-44d8-b89a-a807e9f5b69d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fd6a7aeb-d143-4d7e-a7b2-bffe2d638f22",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b5c25ac1-7062-4bca-875b-0fd0e9ff4e50",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9851b041-63a3-47fb-8d0e-512282879689",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7e9647c5-f4c6-4814-89f3-eff886df23b9",
"db_currency_id": "e1b0ba27-20ca-4584-9219-95ee005f8402",
"db_language_id": "63f987c4-8f55-4743-9a69-34987f55cca4",
"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-07-22T04:23:37.0021022+00:00"
},
"modified_dateutc": "2026-07-22T04:23:37.0021022+00:00"
},
"equipment_family_id": "f20d4ada-70bb-44a6-9945-98462befc3e3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "63287693-e81e-446d-b95e-5b34629e6dd1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "216a5930-e1cf-4f05-8bf2-df4d5af3ac6d",
"_parent_code": "sample string 6",
"sales_organization_id": "5ac5f88d-92da-427c-88ff-206de467283f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9851b041-63a3-47fb-8d0e-512282879689",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7e9647c5-f4c6-4814-89f3-eff886df23b9",
"db_currency_id": "e1b0ba27-20ca-4584-9219-95ee005f8402",
"db_language_id": "63f987c4-8f55-4743-9a69-34987f55cca4",
"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-07-22T04:23:37.0021022+00:00"
},
"modified_dateutc": "2026-07-22T04:23:37.0021022+00:00"
},
"date_in_production_since": "2026-07-22T04:23:37.0021022+00:00",
"date_out_of_production_since": "2026-07-22T04:23:37.0021022+00:00",
"date_end_support": "2026-07-22T04:23:37.0021022+00:00",
"sales_organization_id": "1f972853-4b77-4f41-b92f-6def8be97898",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9851b041-63a3-47fb-8d0e-512282879689",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7e9647c5-f4c6-4814-89f3-eff886df23b9",
"db_currency_id": "e1b0ba27-20ca-4584-9219-95ee005f8402",
"db_language_id": "63f987c4-8f55-4743-9a69-34987f55cca4",
"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-07-22T04:23:37.0021022+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-07-22T04:23:37.0021022+00:00"
},
"project_status_id": "d5cf65ff-510a-4928-a2bd-32b66ce8b166",
"project_status_code": "sample string 10",
"project_status": {
"id": "9d32cb11-9acd-4017-880e-5411e7ee6de9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "51127cb5-02e8-47d6-ae18-12285112f665",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9851b041-63a3-47fb-8d0e-512282879689",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7e9647c5-f4c6-4814-89f3-eff886df23b9",
"db_currency_id": "e1b0ba27-20ca-4584-9219-95ee005f8402",
"db_language_id": "63f987c4-8f55-4743-9a69-34987f55cca4",
"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-07-22T04:23:37.0021022+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-22T04:23:37.0021022+00:00"
},
"company_id": "b974f8a0-2bf3-4270-a282-c0604e5b37ad",
"company_code": "sample string 12",
"db_address_id": "444245b8-281b-42ae-83b3-052f22fc52fc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a6e84ebb-c712-48a5-bb71-149d43dd8058",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a0de7c6c-625d-44a7-8379-23f8f8537251",
"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-07-22T04:23:37.0021022+00:00",
"date_create": "2026-07-22T04:23:37.0021022+00:00",
"date_update": "2026-07-22T04:23:37.0021022+00:00",
"updated_by_user_id": "e201b131-e2f5-491f-935f-b4b1cf8f4695",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-22T04:23:37.0021022+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-07-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-22T04:23:37.0021022+00:00",
"date_last_job": "2026-07-22T04:23:37.0021022+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-22T04:23:37.0021022+00:00",
"modified_dateutc": "2026-07-22T04:23:37.0021022+00:00",
"is_mobile_installation": true
},
"job_type_id": "7f36bedc-4460-45c0-b7c0-c18cf7c780b9",
"job_type_code": "sample string 7",
"job_type": {
"id": "f2ce09af-8e66-41c6-b8c2-5367671a83e0",
"name": "sample string 2",
"sales_organization_id": "4bed58c4-0a1c-442f-a10c-366f8255051e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-22T04:23:37.0021022+00:00",
"code": "sample string 7"
},
"job_priority_id": "f926a8ad-32ce-4bb4-baec-fc8a98bdc920",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9f83f7f9-839c-4615-8078-cb0e59c792a4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "dd370634-f9be-4aa6-bf18-f695529d1aba",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9851b041-63a3-47fb-8d0e-512282879689",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7e9647c5-f4c6-4814-89f3-eff886df23b9",
"db_currency_id": "e1b0ba27-20ca-4584-9219-95ee005f8402",
"db_language_id": "63f987c4-8f55-4743-9a69-34987f55cca4",
"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-07-22T04:23:37.0021022+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-22T04:23:37.0021022+00:00"
},
"job_status_id": "7c12ecc5-65fc-41a7-a342-a9eecf4f6ff8",
"job_status_code": "sample string 11",
"db_address_id": "0caddc53-5494-4a8c-b0e4-aa3b44b5fc39",
"contact_id": "88f50c5e-2f03-4e71-b4cb-2d5a428e632c",
"requested_by_company_id": "42d46208-423c-4fdd-b214-6665826f7689",
"requested_by_contact_id": "415818b8-267d-49ac-8891-db00b3a98228",
"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-07-22T04:23:37.0021022+00:00",
"due_date": "2026-07-22T04:23:37.0021022+00:00",
"date_create": "2026-07-22T04:23:37.0021022+00:00",
"date_update": "2026-07-22T04:23:37.0021022+00:00",
"date_closed": "2026-07-22T04:23:37.0021022+00:00",
"suggested_user_id": "e92422a5-1fca-43fa-ac31-40b6a5a3d2f8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ca7c8d41-1d5d-4dd6-b934-1539db77fcf2",
"db_language_id": "a5122819-4cea-4084-bfa1-3f971042cfa6",
"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-07-22T04:23:37.0021022+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "49f2b3dc-2933-467a-b5ef-a6602eda73f5",
"sales_organization": {
"id": "9851b041-63a3-47fb-8d0e-512282879689",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7e9647c5-f4c6-4814-89f3-eff886df23b9",
"db_currency_id": "e1b0ba27-20ca-4584-9219-95ee005f8402",
"db_language_id": "63f987c4-8f55-4743-9a69-34987f55cca4",
"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-07-22T04:23:37.0021022+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b7ac8777-3c86-4591-a0ed-f923ef8af09e",
"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": "cef08a67-dec6-4683-b6b7-4828be6d6ddc",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-22T04:23:37.0021022+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "72b250c4-1511-4331-8936-bcc1acd8658e"
},
"suggested_date_start": "2026-07-22T04:23:37.0021022+00:00",
"skill_id": "aa0482d1-d5bb-4696-83f6-ec995d3f9308",
"skill_code": "sample string 32",
"skill": {
"id": "a4fb4b74-ec74-44fb-b899-4dc08f34a327",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "208d2b01-4971-4695-a984-a3c2972e91de",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9851b041-63a3-47fb-8d0e-512282879689",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7e9647c5-f4c6-4814-89f3-eff886df23b9",
"db_currency_id": "e1b0ba27-20ca-4584-9219-95ee005f8402",
"db_language_id": "63f987c4-8f55-4743-9a69-34987f55cca4",
"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-07-22T04:23:37.0021022+00:00"
},
"modified_dateutc": "2026-07-22T04:23:37.0021022+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fcf084c3-f528-4f36-beec-47e5d64586cd",
"date_reported_by_company": "2026-07-22T04:23:37.0021022+00:00",
"id2": 36,
"company_id": "33dc2f87-e04d-4c34-b09f-57e46fe2a8c5",
"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": "51552257-0104-4b23-a2e8-ca227a2d3158",
"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-07-22T04:23:37.0021022+00:00"
},
"work_instruction_details_id": "0d4530c7-7ccb-447d-bc6c-0cddf871a4e4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2f65d9f9-89ab-4794-afde-706b4a523988",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bb21ea5c-8c70-4d14-8f6f-19f42842415d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-22T04:23:37.0021022+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": "fd844fe2-332b-4b6e-bff8-9ac9adbec770",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-22T04:23:37.0021022+00:00"
}