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": "b8507afb-7998-4d30-8fa4-1059a06d876e",
"jobs_id": "b42d5b70-9017-4bea-b0fa-22854125c5b0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "80bb59f3-1a7f-4302-9acd-3a2dfe95b3d4",
"_parent_id": "335f38f4-1825-41d8-a705-4fe8a5f6b568",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "237d8a29-78ad-4aef-a4ec-c5a0619d588c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0577bab7-a34b-4ecf-ad4f-9eb13043d727",
"_parent_id": "85038ad6-066a-475c-84c1-2965a0e27970",
"root_parent_id": "c67eda9d-7bdf-4c1b-975e-5000b54dc17d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "752fc38c-3b7b-43e2-b228-1e04f577b17d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3ddd0b0a-4aa7-40e0-b69d-2987cb35c66c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4c68f85b-f3a5-4328-b732-adc97c293a69",
"_parent_code": "sample string 6",
"sales_organization_id": "3a019491-f6a2-44fa-8ebc-b4211e0295a0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "03bd753b-6d3e-473a-a9b6-ccf2819826a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2fff8ee7-3607-48b8-b22c-1a75822ef25d",
"db_currency_id": "f4f04ac7-ae62-4e59-93fb-9cbe43d2b182",
"db_language_id": "31fac811-62fc-4e67-a49c-513ee418b778",
"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-09-10T09:10:20.8199332+00:00"
},
"modified_dateutc": "2026-09-10T09:10:20.8199332+00:00"
},
"equipment_model_id": "c600de23-7acf-4d3d-b6af-9be39ee20ab6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bd0c933b-1c9d-41de-88d2-5c69a525cbe6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a4f3c4d7-702a-4fcb-a13b-5d7bfb511a04",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a3131473-582b-4054-968d-df204a946713",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0910d7b4-d6e3-424f-a065-fab4048b70bb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "03bd753b-6d3e-473a-a9b6-ccf2819826a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2fff8ee7-3607-48b8-b22c-1a75822ef25d",
"db_currency_id": "f4f04ac7-ae62-4e59-93fb-9cbe43d2b182",
"db_language_id": "31fac811-62fc-4e67-a49c-513ee418b778",
"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-09-10T09:10:20.8199332+00:00"
},
"modified_dateutc": "2026-09-10T09:10:20.8199332+00:00"
},
"equipment_family_id": "704b2d17-b472-4ec5-9a68-20910ed3fcb2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3ddd0b0a-4aa7-40e0-b69d-2987cb35c66c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4c68f85b-f3a5-4328-b732-adc97c293a69",
"_parent_code": "sample string 6",
"sales_organization_id": "3a019491-f6a2-44fa-8ebc-b4211e0295a0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "03bd753b-6d3e-473a-a9b6-ccf2819826a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2fff8ee7-3607-48b8-b22c-1a75822ef25d",
"db_currency_id": "f4f04ac7-ae62-4e59-93fb-9cbe43d2b182",
"db_language_id": "31fac811-62fc-4e67-a49c-513ee418b778",
"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-09-10T09:10:20.8199332+00:00"
},
"modified_dateutc": "2026-09-10T09:10:20.8199332+00:00"
},
"date_in_production_since": "2026-09-10T09:10:20.8199332+00:00",
"date_out_of_production_since": "2026-09-10T09:10:20.8199332+00:00",
"date_end_support": "2026-09-10T09:10:20.8199332+00:00",
"sales_organization_id": "074c1926-d5d7-4cae-bbec-26e2612f5f4e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "03bd753b-6d3e-473a-a9b6-ccf2819826a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2fff8ee7-3607-48b8-b22c-1a75822ef25d",
"db_currency_id": "f4f04ac7-ae62-4e59-93fb-9cbe43d2b182",
"db_language_id": "31fac811-62fc-4e67-a49c-513ee418b778",
"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-09-10T09:10:20.8199332+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-09-10T09:10:20.8199332+00:00"
},
"project_status_id": "5dfe372c-3c92-4b05-b22d-ac1239fed8ff",
"project_status_code": "sample string 10",
"project_status": {
"id": "085e8eb8-2bd7-4cbb-96e1-62bf300cc6a0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "89801ed5-a095-43da-b69e-2bb477d8706f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "03bd753b-6d3e-473a-a9b6-ccf2819826a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2fff8ee7-3607-48b8-b22c-1a75822ef25d",
"db_currency_id": "f4f04ac7-ae62-4e59-93fb-9cbe43d2b182",
"db_language_id": "31fac811-62fc-4e67-a49c-513ee418b778",
"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-09-10T09:10:20.8199332+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-10T09:10:20.8199332+00:00"
},
"company_id": "48331ce7-3586-4bea-aa26-5e03971d4163",
"company_code": "sample string 12",
"db_address_id": "29ef89a6-565f-4497-aa17-d3cc81df5d94",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "18ba0615-fa94-4101-b214-f9b4025cf4d3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d9891767-f727-412f-bff1-df7b9fdad300",
"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-09-10T09:10:20.8199332+00:00",
"date_create": "2026-09-10T09:10:20.8199332+00:00",
"date_update": "2026-09-10T09:10:20.8199332+00:00",
"updated_by_user_id": "00863461-2502-41e3-96c9-4025aa6e61a5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-10T09:10:20.8199332+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-09-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-10T09:10:20.8199332+00:00",
"date_last_job": "2026-09-10T09:10:20.8199332+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-10T09:10:20.8199332+00:00",
"modified_dateutc": "2026-09-10T09:10:20.8199332+00:00",
"is_mobile_installation": true
},
"job_type_id": "3005fc9c-e45d-4fd0-908c-23c37d8f3003",
"job_type_code": "sample string 7",
"job_type": {
"id": "115206fc-44c4-4f6b-8851-80bea3539db9",
"name": "sample string 2",
"sales_organization_id": "79150d7d-e375-4c12-8c02-ef0be12f983c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-10T09:10:20.8199332+00:00",
"code": "sample string 7"
},
"job_priority_id": "85e6393c-65ba-4fcd-a071-511165f4140c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "31ac33f7-c95a-48fd-b6da-75b500d0c7c2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "dc4101ca-afb2-4dee-9f47-0b21d7a60749",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "03bd753b-6d3e-473a-a9b6-ccf2819826a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2fff8ee7-3607-48b8-b22c-1a75822ef25d",
"db_currency_id": "f4f04ac7-ae62-4e59-93fb-9cbe43d2b182",
"db_language_id": "31fac811-62fc-4e67-a49c-513ee418b778",
"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-09-10T09:10:20.8199332+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-10T09:10:20.8199332+00:00"
},
"job_status_id": "f417af8f-54ac-4701-b958-8bf60656aec8",
"job_status_code": "sample string 11",
"db_address_id": "91771cc3-3637-471e-8670-af46eac9ed36",
"contact_id": "e829e541-b534-4c57-9511-867302cb8e6b",
"requested_by_company_id": "a8ca73e6-9a14-4b47-b0e2-fecf0a6b33d6",
"requested_by_contact_id": "c994c50f-d7bb-4443-afa1-edb5b690d322",
"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-09-10T09:10:20.8199332+00:00",
"due_date": "2026-09-10T09:10:20.8199332+00:00",
"date_create": "2026-09-10T09:10:20.8199332+00:00",
"date_update": "2026-09-10T09:10:20.8199332+00:00",
"date_closed": "2026-09-10T09:10:20.8199332+00:00",
"suggested_user_id": "4aa0546b-ca39-40b4-8bab-ddb187a401cd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ec813a78-30db-4f2b-8745-6fd1957a8046",
"db_language_id": "947d28cb-4e74-4ff2-9202-ee99a4135578",
"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-09-10T09:10:20.8199332+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4880046f-f7ce-4166-ba7b-c7c0d79164b0",
"sales_organization": {
"id": "03bd753b-6d3e-473a-a9b6-ccf2819826a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2fff8ee7-3607-48b8-b22c-1a75822ef25d",
"db_currency_id": "f4f04ac7-ae62-4e59-93fb-9cbe43d2b182",
"db_language_id": "31fac811-62fc-4e67-a49c-513ee418b778",
"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-09-10T09:10:20.8199332+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d2e1e373-b9f1-4963-a26f-7ba591ee5b64",
"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": "81036576-bc74-43e5-87b7-c7da4f64f3c6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-10T09:10:20.8199332+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f0968f16-cdbb-4321-8b35-55ea993c9835"
},
"suggested_date_start": "2026-09-10T09:10:20.8199332+00:00",
"skill_id": "768f6505-16f4-440b-8f7d-5147e09b660c",
"skill_code": "sample string 32",
"skill": {
"id": "e8cd6b49-4944-418c-9902-4996fed2a004",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f502c5d0-5ebc-4e1f-a812-7fc3ae9d64cc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "03bd753b-6d3e-473a-a9b6-ccf2819826a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2fff8ee7-3607-48b8-b22c-1a75822ef25d",
"db_currency_id": "f4f04ac7-ae62-4e59-93fb-9cbe43d2b182",
"db_language_id": "31fac811-62fc-4e67-a49c-513ee418b778",
"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-09-10T09:10:20.8199332+00:00"
},
"modified_dateutc": "2026-09-10T09:10:20.8199332+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "574db73e-b4b7-464e-b7c7-25eb7ca06850",
"date_reported_by_company": "2026-09-10T09:10:20.8199332+00:00",
"id2": 36,
"company_id": "bf5adf98-6a1a-46af-afec-91fb394a6d91",
"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": "37cf0366-f2b1-4d63-9d43-399a89ac5a91",
"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-09-10T09:10:20.8199332+00:00"
},
"work_instruction_details_id": "62c6b542-aebe-4ac3-beb0-d5355b2ae6ec",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "76e7c0d6-fe63-4630-a8df-0bf45169cd92",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "01384fc9-0b2b-458d-ab31-4ce1db177f67",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-10T09:10:20.8199332+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": "65f0ba88-8144-4eaf-86f8-2d64563516e1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-10T09:10:20.8199332+00:00"
}