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": "32fc30fb-882b-4016-9730-4c340e28cc54",
"jobs_id": "979cdc68-2cf5-4c74-b158-d41a02a18359",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ff9e0661-78ce-4238-958c-3cc5d673c0c3",
"_parent_id": "77ea2683-dbdf-4824-9c53-c8c9e4f6a2d8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9ba7c425-484c-40e2-835b-5a2950bb7284",
"project_reference_back_office": "sample string 5",
"project": {
"id": "91e12481-0267-4173-b938-f8e9402c8bb5",
"_parent_id": "de0df698-721a-4d56-9f3b-85aa695bb83c",
"root_parent_id": "449d04da-e040-4b45-9d5e-9310d2a967af",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "61c19499-4ed2-479c-90e5-d65e1c7a9c90",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "42953946-d511-4f75-8bd9-d362a30e4b8f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "843d45d0-69dc-45a7-98d5-080b234e30db",
"_parent_code": "sample string 6",
"sales_organization_id": "a311cd1d-9ec2-4fde-b9d6-d7c7d32f047e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d0f356e4-bb25-4b60-9111-ea8596d94779",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0e0a53c-b01c-4c3a-83ba-cdf093e52c1e",
"db_currency_id": "635aecf5-58ef-44aa-9e26-07339e4771f8",
"db_language_id": "3cc1750f-376c-42bb-8c40-71711ca2baca",
"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-20T03:03:43.5730804+00:00"
},
"modified_dateutc": "2026-02-20T03:03:43.5730804+00:00"
},
"equipment_model_id": "f372dc81-b67f-4de1-a449-9c190390f750",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ce457307-9eb3-4da9-b074-34e64ace4e45",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "401ae42d-d303-4834-a49e-7f637f69c061",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5b12445e-2376-4b10-89e1-fa38493d0b27",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bbc2d186-fc3a-4244-842d-0a9f333d9afc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d0f356e4-bb25-4b60-9111-ea8596d94779",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0e0a53c-b01c-4c3a-83ba-cdf093e52c1e",
"db_currency_id": "635aecf5-58ef-44aa-9e26-07339e4771f8",
"db_language_id": "3cc1750f-376c-42bb-8c40-71711ca2baca",
"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-20T03:03:43.5730804+00:00"
},
"modified_dateutc": "2026-02-20T03:03:43.5730804+00:00"
},
"equipment_family_id": "d15e4fba-dc2d-40bb-bcc1-291574b63f90",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "42953946-d511-4f75-8bd9-d362a30e4b8f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "843d45d0-69dc-45a7-98d5-080b234e30db",
"_parent_code": "sample string 6",
"sales_organization_id": "a311cd1d-9ec2-4fde-b9d6-d7c7d32f047e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d0f356e4-bb25-4b60-9111-ea8596d94779",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0e0a53c-b01c-4c3a-83ba-cdf093e52c1e",
"db_currency_id": "635aecf5-58ef-44aa-9e26-07339e4771f8",
"db_language_id": "3cc1750f-376c-42bb-8c40-71711ca2baca",
"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-20T03:03:43.5730804+00:00"
},
"modified_dateutc": "2026-02-20T03:03:43.5730804+00:00"
},
"date_in_production_since": "2026-02-20T03:03:43.5730804+00:00",
"date_out_of_production_since": "2026-02-20T03:03:43.5730804+00:00",
"date_end_support": "2026-02-20T03:03:43.5730804+00:00",
"sales_organization_id": "cd14c435-10b0-48bf-91c1-774380209cd3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d0f356e4-bb25-4b60-9111-ea8596d94779",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0e0a53c-b01c-4c3a-83ba-cdf093e52c1e",
"db_currency_id": "635aecf5-58ef-44aa-9e26-07339e4771f8",
"db_language_id": "3cc1750f-376c-42bb-8c40-71711ca2baca",
"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-20T03:03:43.5730804+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-20T03:03:43.5730804+00:00"
},
"project_status_id": "43a74393-2ba4-4499-ad2e-efce1148883d",
"project_status_code": "sample string 10",
"project_status": {
"id": "66ee511e-18c6-4c4a-8472-c6a0e84fee49",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "07d08326-ee96-46e9-ba91-62f464571dfb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d0f356e4-bb25-4b60-9111-ea8596d94779",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0e0a53c-b01c-4c3a-83ba-cdf093e52c1e",
"db_currency_id": "635aecf5-58ef-44aa-9e26-07339e4771f8",
"db_language_id": "3cc1750f-376c-42bb-8c40-71711ca2baca",
"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-20T03:03:43.5730804+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-20T03:03:43.5730804+00:00"
},
"company_id": "c7d0b989-3f02-4ec9-9f34-2421d964b07e",
"company_code": "sample string 12",
"db_address_id": "65891d69-e905-4162-877d-5fffce4ec97f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4dbcdf74-2da5-40ca-b08b-3342efbbddf4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "160380a5-870a-4318-b112-052c151dac6a",
"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-20T03:03:43.5730804+00:00",
"date_create": "2026-02-20T03:03:43.5730804+00:00",
"date_update": "2026-02-20T03:03:43.5730804+00:00",
"updated_by_user_id": "a35c445f-284b-497c-8f97-4ba30e037532",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-20T03:03:43.5730804+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-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-20T03:03:43.5730804+00:00",
"date_last_job": "2026-02-20T03:03:43.5730804+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-20T03:03:43.5730804+00:00",
"modified_dateutc": "2026-02-20T03:03:43.5730804+00:00",
"is_mobile_installation": true
},
"job_type_id": "77bc0cf7-3dd6-4216-9153-aa60be7f6d91",
"job_type_code": "sample string 7",
"job_type": {
"id": "b14e8df7-3885-45f4-8e48-494e97dd8f21",
"name": "sample string 2",
"sales_organization_id": "e484201f-8292-46d2-8c79-e7ab60c41c68",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-20T03:03:43.5730804+00:00",
"code": "sample string 7"
},
"job_priority_id": "ec615248-d12a-42bb-8a53-5904090487dc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "771a547b-2667-458f-8217-5ba8ff5aa48d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "af037f4d-b888-4489-8891-6f47caefbdcb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d0f356e4-bb25-4b60-9111-ea8596d94779",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0e0a53c-b01c-4c3a-83ba-cdf093e52c1e",
"db_currency_id": "635aecf5-58ef-44aa-9e26-07339e4771f8",
"db_language_id": "3cc1750f-376c-42bb-8c40-71711ca2baca",
"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-20T03:03:43.5730804+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-20T03:03:43.5730804+00:00"
},
"job_status_id": "42739f10-2944-487d-b99f-e9a2df276c29",
"job_status_code": "sample string 11",
"db_address_id": "7e24f78c-2d12-44de-8a71-f28342e12870",
"contact_id": "6193b049-5fe1-4d55-b84f-9283e329302b",
"requested_by_company_id": "ee745e54-6a99-4ee4-b36a-806eb3290458",
"requested_by_contact_id": "0fb6cee7-a4ca-4928-a537-6527e293c053",
"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-20T03:03:43.5730804+00:00",
"due_date": "2026-02-20T03:03:43.5730804+00:00",
"date_create": "2026-02-20T03:03:43.5730804+00:00",
"date_update": "2026-02-20T03:03:43.5730804+00:00",
"date_closed": "2026-02-20T03:03:43.5730804+00:00",
"suggested_user_id": "e18b9399-2836-491f-9d77-3ac745cab8f5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0ce4c954-48aa-4b62-be08-32c480e48285",
"db_language_id": "9ab3c43d-9e21-46c3-9381-673a5e6da7a0",
"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-20T03:03:43.5730804+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "40161784-60a3-47f8-a4fe-a7f3d0c6640c",
"sales_organization": {
"id": "d0f356e4-bb25-4b60-9111-ea8596d94779",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0e0a53c-b01c-4c3a-83ba-cdf093e52c1e",
"db_currency_id": "635aecf5-58ef-44aa-9e26-07339e4771f8",
"db_language_id": "3cc1750f-376c-42bb-8c40-71711ca2baca",
"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-20T03:03:43.5730804+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "508bace8-7987-4049-bed3-ee3e8887258e",
"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": "617e4f2b-a724-4e80-b361-ba78c4cc1875",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-20T03:03:43.5730804+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3b716e51-114f-434d-954d-7b5e2654daa0"
},
"suggested_date_start": "2026-02-20T03:03:43.5730804+00:00",
"skill_id": "047273df-93b9-4117-a8e3-e6e956a72c67",
"skill_code": "sample string 32",
"skill": {
"id": "26a7a2e3-6d32-4ad2-80aa-e02a6e2ae022",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c973f986-d9e6-493d-8641-bc0effbb6b28",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d0f356e4-bb25-4b60-9111-ea8596d94779",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0e0a53c-b01c-4c3a-83ba-cdf093e52c1e",
"db_currency_id": "635aecf5-58ef-44aa-9e26-07339e4771f8",
"db_language_id": "3cc1750f-376c-42bb-8c40-71711ca2baca",
"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-20T03:03:43.5730804+00:00"
},
"modified_dateutc": "2026-02-20T03:03:43.5730804+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e77e271c-50d0-4445-a3a4-cb249c7683f1",
"date_reported_by_company": "2026-02-20T03:03:43.5730804+00:00",
"id2": 36,
"company_id": "7a17c5af-726d-4cd3-94c5-c9bdb8392845",
"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": "65c138a3-1551-4bd0-8c2c-2ca8c92e50b0",
"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-20T03:03:43.5730804+00:00"
},
"work_instruction_details_id": "aba69e9e-ab17-4473-84de-f61ca15c5da3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "be9c06c9-76a3-4c05-aa13-09cd253d8197",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9fea4e98-23d1-44e1-a7a3-8ac8448f514a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-20T03:03:43.5730804+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": "d25d92f7-cf42-4df7-993b-ed98186b45cf",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-20T03:03:43.5730804+00:00"
}