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": "61bcec12-689e-4086-ad54-156a827edf7c",
"jobs_id": "e296a182-08d6-4cce-9032-651a456b88d8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9e153aae-a5f3-45ca-9af2-5d0097153ab8",
"_parent_id": "c332b445-f810-480e-b60b-6bca0a8ced2f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "275d32ea-c77c-42d6-a275-3a624cbd2f49",
"project_reference_back_office": "sample string 5",
"project": {
"id": "99019f1d-d96c-4c57-9b48-2a1b098f9b35",
"_parent_id": "559db7c1-4db5-47f7-a579-a22fa6d197ae",
"root_parent_id": "fbbd1f59-92ff-4080-bbb0-2e403dc076c8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b10f6a32-4b04-49d5-9e59-9ac93e5355cf",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f5cf7b74-c1d0-483f-a68a-dca3f5cb0919",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5d403bc6-c448-4f53-8414-c79fd6db67cf",
"_parent_code": "sample string 6",
"sales_organization_id": "f044ed64-ab53-445e-a2c6-813a001279b2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d5e06601-3c36-4027-9d1d-f055d5442377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "344fc6d0-5111-4457-bb15-9f46e0452782",
"db_currency_id": "42f87659-9a3e-40bd-8c31-69bfc6f39a72",
"db_language_id": "1b491123-79ad-49ea-b82b-57b5d726e3e6",
"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-08-07T06:54:30.390743+00:00"
},
"modified_dateutc": "2026-08-07T06:54:30.390743+00:00"
},
"equipment_model_id": "490cb065-b717-4b1b-8ba6-b9a7b4e9dc7f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "465c795f-a76a-4de7-b9b3-57b692d7701b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6763a239-9c6a-48b9-8d52-79525c3e8541",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "04dea0d8-a36e-411b-890e-9897b9c7408b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8633b579-792b-407b-9fef-fe3e9ecb9006",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d5e06601-3c36-4027-9d1d-f055d5442377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "344fc6d0-5111-4457-bb15-9f46e0452782",
"db_currency_id": "42f87659-9a3e-40bd-8c31-69bfc6f39a72",
"db_language_id": "1b491123-79ad-49ea-b82b-57b5d726e3e6",
"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-08-07T06:54:30.390743+00:00"
},
"modified_dateutc": "2026-08-07T06:54:30.390743+00:00"
},
"equipment_family_id": "9695e94e-ca4c-43c1-a76b-cd5eb6fc7c53",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f5cf7b74-c1d0-483f-a68a-dca3f5cb0919",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5d403bc6-c448-4f53-8414-c79fd6db67cf",
"_parent_code": "sample string 6",
"sales_organization_id": "f044ed64-ab53-445e-a2c6-813a001279b2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d5e06601-3c36-4027-9d1d-f055d5442377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "344fc6d0-5111-4457-bb15-9f46e0452782",
"db_currency_id": "42f87659-9a3e-40bd-8c31-69bfc6f39a72",
"db_language_id": "1b491123-79ad-49ea-b82b-57b5d726e3e6",
"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-08-07T06:54:30.390743+00:00"
},
"modified_dateutc": "2026-08-07T06:54:30.390743+00:00"
},
"date_in_production_since": "2026-08-07T06:54:30.390743+00:00",
"date_out_of_production_since": "2026-08-07T06:54:30.390743+00:00",
"date_end_support": "2026-08-07T06:54:30.390743+00:00",
"sales_organization_id": "899cfef0-4752-441a-bb95-ad259948f91f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d5e06601-3c36-4027-9d1d-f055d5442377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "344fc6d0-5111-4457-bb15-9f46e0452782",
"db_currency_id": "42f87659-9a3e-40bd-8c31-69bfc6f39a72",
"db_language_id": "1b491123-79ad-49ea-b82b-57b5d726e3e6",
"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-08-07T06:54:30.390743+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-08-07T06:54:30.390743+00:00"
},
"project_status_id": "17894942-5ccd-4502-9de5-7db9c3c4a983",
"project_status_code": "sample string 10",
"project_status": {
"id": "26ec5c5f-0ff0-4f32-82e3-ae1443aeaa4d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e827638a-add5-403b-a768-2ff30b891dd8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d5e06601-3c36-4027-9d1d-f055d5442377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "344fc6d0-5111-4457-bb15-9f46e0452782",
"db_currency_id": "42f87659-9a3e-40bd-8c31-69bfc6f39a72",
"db_language_id": "1b491123-79ad-49ea-b82b-57b5d726e3e6",
"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-08-07T06:54:30.390743+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-07T06:54:30.390743+00:00"
},
"company_id": "8e2f65fb-a7a6-48f4-b3cd-974168d9fdd1",
"company_code": "sample string 12",
"db_address_id": "04e49a44-b2e9-4c25-99f6-0b6801fa9f59",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "eaee5e98-7585-40cb-b301-33d18fc3d8a5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4d00d102-b6db-448a-ab9e-248027e8028d",
"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-08-07T06:54:30.390743+00:00",
"date_create": "2026-08-07T06:54:30.390743+00:00",
"date_update": "2026-08-07T06:54:30.390743+00:00",
"updated_by_user_id": "48fd5ccf-8e70-40bb-8f5d-e33f42adf425",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-07T06:54:30.390743+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-08-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-07T06:54:30.390743+00:00",
"date_last_job": "2026-08-07T06:54:30.390743+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-07T06:54:30.390743+00:00",
"modified_dateutc": "2026-08-07T06:54:30.390743+00:00",
"is_mobile_installation": true
},
"job_type_id": "50b32f08-e9cd-446e-a6b8-292ad68580f6",
"job_type_code": "sample string 7",
"job_type": {
"id": "bec745be-d4fb-41b0-94a2-5eb70852324f",
"name": "sample string 2",
"sales_organization_id": "acf573b4-917b-4337-ab1b-ba7df4aa42d9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-07T06:54:30.390743+00:00",
"code": "sample string 7"
},
"job_priority_id": "c0d93db0-ba73-4be2-8396-728db4369008",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7c46f03f-431a-4fe9-a122-835a6a28d782",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1580b0f0-7c2c-4ef5-a2a6-2d87d46b6480",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d5e06601-3c36-4027-9d1d-f055d5442377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "344fc6d0-5111-4457-bb15-9f46e0452782",
"db_currency_id": "42f87659-9a3e-40bd-8c31-69bfc6f39a72",
"db_language_id": "1b491123-79ad-49ea-b82b-57b5d726e3e6",
"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-08-07T06:54:30.390743+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-07T06:54:30.390743+00:00"
},
"job_status_id": "2f285dde-18bd-4292-8b92-4a0b92a4c404",
"job_status_code": "sample string 11",
"db_address_id": "231f653e-a2ba-4a97-b659-dfd233de5624",
"contact_id": "617ca42a-7050-4071-a548-456e3a5172b0",
"requested_by_company_id": "4a6429df-a827-4435-a861-df5f0fc68299",
"requested_by_contact_id": "766e7c59-104c-4985-a2f1-13536302732c",
"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-08-07T06:54:30.390743+00:00",
"due_date": "2026-08-07T06:54:30.390743+00:00",
"date_create": "2026-08-07T06:54:30.390743+00:00",
"date_update": "2026-08-07T06:54:30.390743+00:00",
"date_closed": "2026-08-07T06:54:30.390743+00:00",
"suggested_user_id": "3c74fc66-c830-4f37-80fe-7b7393940506",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9daf388b-0da5-414c-b7ee-f767e9a5f811",
"db_language_id": "a11ad5c1-8adf-49ad-beeb-c0a77a027e34",
"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-08-07T06:54:30.390743+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b9e889dc-337c-47de-80d6-5abb07ffe2d7",
"sales_organization": {
"id": "d5e06601-3c36-4027-9d1d-f055d5442377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "344fc6d0-5111-4457-bb15-9f46e0452782",
"db_currency_id": "42f87659-9a3e-40bd-8c31-69bfc6f39a72",
"db_language_id": "1b491123-79ad-49ea-b82b-57b5d726e3e6",
"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-08-07T06:54:30.390743+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "92fee963-dbfb-4443-864b-21df6040ede8",
"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": "a69b27ec-ee0f-4a57-b3bb-828f9fa2ecb8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-07T06:54:30.390743+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ddf33fa6-8d84-48ff-9d70-b8751ea4498b"
},
"suggested_date_start": "2026-08-07T06:54:30.390743+00:00",
"skill_id": "05628f64-abac-4b5e-aec7-ab394e99273d",
"skill_code": "sample string 32",
"skill": {
"id": "2162b3d3-24e6-4f57-ae41-383c9382749f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ec1b0fd1-9821-4454-b8c0-c6dd2a34923d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d5e06601-3c36-4027-9d1d-f055d5442377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "344fc6d0-5111-4457-bb15-9f46e0452782",
"db_currency_id": "42f87659-9a3e-40bd-8c31-69bfc6f39a72",
"db_language_id": "1b491123-79ad-49ea-b82b-57b5d726e3e6",
"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-08-07T06:54:30.390743+00:00"
},
"modified_dateutc": "2026-08-07T06:54:30.390743+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "077c1051-5da6-450d-848a-55698d9aaea9",
"date_reported_by_company": "2026-08-07T06:54:30.390743+00:00",
"id2": 36,
"company_id": "750b5b96-7be7-415a-a446-11c1e91a0c00",
"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": "98dc6714-248d-4853-aba9-0bff0e451de1",
"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-08-07T06:54:30.390743+00:00"
},
"work_instruction_details_id": "b5951431-f7fa-467f-85f9-3432e9089116",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bb5a5761-c396-48f0-a039-f13cc40568e4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "92b8eed7-2afb-4ddb-911f-af502ae52664",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-07T06:54:30.390743+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": "9277186a-7c0b-4fff-9790-8e67dbfc0fad",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-07T06:54:30.390743+00:00"
}