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": "a208f20a-2c17-45de-ba6d-082638e77dca",
"jobs_id": "9c360c13-4991-4cf6-87db-06a4542c599f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "82f7cdad-13a1-434f-b45b-7b5b7ec8831d",
"_parent_id": "007f8150-bd5c-43c4-83f8-d79ebade939b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0024c8b3-a92d-487f-b04f-a9ece0818a2f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "bcf55463-e367-4aeb-a14e-031ddcef1d1e",
"_parent_id": "0c2ba526-2d84-443f-bb48-d008c07cbcbb",
"root_parent_id": "22e5007e-197d-4666-b670-390ca5bddbed",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c440eac0-351f-4240-b1de-e3d22e735026",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fa156e09-b6e5-4034-b5d9-3713727523c7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "198901c0-463e-4d05-ad85-b6e484f8cead",
"_parent_code": "sample string 6",
"sales_organization_id": "9ae84767-afb6-48a5-bb08-030865f31f3d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "65cc64b8-16f9-4f64-a9c4-8dd57601c816",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24b2b7ca-af22-44cf-a3aa-2fda91504c0b",
"db_currency_id": "1ecf8b6a-ee0a-4df7-b3bb-9c8f5ba10c26",
"db_language_id": "8631a775-42dd-4226-a4b8-6c57b93ea593",
"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-01-15T06:44:51.5999789+00:00"
},
"modified_dateutc": "2026-01-15T06:44:51.5999789+00:00"
},
"equipment_model_id": "4d180ed1-492d-4f7b-a2eb-a4226aa24e94",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4862f7de-42dc-4a4b-a0b0-5c0b3c54b214",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "dc131ebf-8629-4d47-9ff3-8384d2cfafcd",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3859fcb1-c07c-41d2-b751-e28e18a4286c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c6e99cf8-cb53-4697-befc-326803501813",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "65cc64b8-16f9-4f64-a9c4-8dd57601c816",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24b2b7ca-af22-44cf-a3aa-2fda91504c0b",
"db_currency_id": "1ecf8b6a-ee0a-4df7-b3bb-9c8f5ba10c26",
"db_language_id": "8631a775-42dd-4226-a4b8-6c57b93ea593",
"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-01-15T06:44:51.5999789+00:00"
},
"modified_dateutc": "2026-01-15T06:44:51.5999789+00:00"
},
"equipment_family_id": "b0003ee8-38f3-41bc-b90a-69745d66877f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fa156e09-b6e5-4034-b5d9-3713727523c7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "198901c0-463e-4d05-ad85-b6e484f8cead",
"_parent_code": "sample string 6",
"sales_organization_id": "9ae84767-afb6-48a5-bb08-030865f31f3d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "65cc64b8-16f9-4f64-a9c4-8dd57601c816",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24b2b7ca-af22-44cf-a3aa-2fda91504c0b",
"db_currency_id": "1ecf8b6a-ee0a-4df7-b3bb-9c8f5ba10c26",
"db_language_id": "8631a775-42dd-4226-a4b8-6c57b93ea593",
"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-01-15T06:44:51.5999789+00:00"
},
"modified_dateutc": "2026-01-15T06:44:51.5999789+00:00"
},
"date_in_production_since": "2026-01-15T06:44:51.5999789+00:00",
"date_out_of_production_since": "2026-01-15T06:44:51.5999789+00:00",
"date_end_support": "2026-01-15T06:44:51.5999789+00:00",
"sales_organization_id": "98e6f50b-f82d-45b5-b85a-f456c8f37a7b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "65cc64b8-16f9-4f64-a9c4-8dd57601c816",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24b2b7ca-af22-44cf-a3aa-2fda91504c0b",
"db_currency_id": "1ecf8b6a-ee0a-4df7-b3bb-9c8f5ba10c26",
"db_language_id": "8631a775-42dd-4226-a4b8-6c57b93ea593",
"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-01-15T06:44:51.5999789+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-01-15T06:44:51.5999789+00:00"
},
"project_status_id": "110f956f-fa86-446b-bf38-3d36ce6b8feb",
"project_status_code": "sample string 10",
"project_status": {
"id": "0e134bc1-d03e-4e8a-9ec5-0bf7d5468176",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6b2d976a-bbee-4877-abc0-b2fbe419e9f2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "65cc64b8-16f9-4f64-a9c4-8dd57601c816",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24b2b7ca-af22-44cf-a3aa-2fda91504c0b",
"db_currency_id": "1ecf8b6a-ee0a-4df7-b3bb-9c8f5ba10c26",
"db_language_id": "8631a775-42dd-4226-a4b8-6c57b93ea593",
"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-01-15T06:44:51.5999789+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-15T06:44:51.5999789+00:00"
},
"company_id": "103fdc89-5767-4b39-93d7-4676c614b786",
"company_code": "sample string 12",
"db_address_id": "077ad15a-6016-4f35-bfb1-dc58eca0aa46",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "93f4cf82-ed0a-4df2-baf0-3d6c3787b7b1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "112f4f26-8326-4cff-90f5-1f76a94b6e3d",
"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-01-15T06:44:51.5999789+00:00",
"date_create": "2026-01-15T06:44:51.5999789+00:00",
"date_update": "2026-01-15T06:44:51.5999789+00:00",
"updated_by_user_id": "4c9ad383-7102-4d56-b6ee-1f5d973abd51",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-15T06:44:51.5999789+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-01-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-15T06:44:51.5999789+00:00",
"date_last_job": "2026-01-15T06:44:51.5999789+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-15T06:44:51.5999789+00:00",
"modified_dateutc": "2026-01-15T06:44:51.5999789+00:00",
"is_mobile_installation": true
},
"job_type_id": "02cd631b-8adc-4480-a397-d7f92eccc431",
"job_type_code": "sample string 7",
"job_type": {
"id": "1add1380-6e91-46e7-984a-90544dda1c27",
"name": "sample string 2",
"sales_organization_id": "7729fb7b-dd89-4c0b-95ff-46cba415a927",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-15T06:44:51.5999789+00:00",
"code": "sample string 7"
},
"job_priority_id": "093f44bd-8506-4dd6-8b5a-adada052ba63",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0e087587-09a9-4e10-af11-4edc8f248a8b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "bf54cbbf-175c-4001-8709-a712b4155d35",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "65cc64b8-16f9-4f64-a9c4-8dd57601c816",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24b2b7ca-af22-44cf-a3aa-2fda91504c0b",
"db_currency_id": "1ecf8b6a-ee0a-4df7-b3bb-9c8f5ba10c26",
"db_language_id": "8631a775-42dd-4226-a4b8-6c57b93ea593",
"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-01-15T06:44:51.5999789+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-15T06:44:51.5999789+00:00"
},
"job_status_id": "95dce41f-fcf6-49d5-9704-99fe11da4be1",
"job_status_code": "sample string 11",
"db_address_id": "8f8306c4-3824-4028-8586-74c9a6d8d04b",
"contact_id": "bbbc4f38-76b0-4c2a-a6a9-283f77fb9e7c",
"requested_by_company_id": "fc7c67db-6767-445f-9c70-8c90d9e410de",
"requested_by_contact_id": "9f8a3976-4215-4feb-a541-e4401f818a4f",
"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-01-15T06:44:51.5999789+00:00",
"due_date": "2026-01-15T06:44:51.5999789+00:00",
"date_create": "2026-01-15T06:44:51.5999789+00:00",
"date_update": "2026-01-15T06:44:51.5999789+00:00",
"date_closed": "2026-01-15T06:44:51.5999789+00:00",
"suggested_user_id": "1548ce06-0f72-4834-89f3-5225b1f5aa17",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c1466e52-39ed-4626-b6d9-f43e68a9c0f1",
"db_language_id": "e3f22081-9ee0-4152-927f-ab61f9e3fda0",
"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-01-15T06:44:51.5999789+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a36e059c-69b1-426a-a504-dca33c0676cc",
"sales_organization": {
"id": "65cc64b8-16f9-4f64-a9c4-8dd57601c816",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24b2b7ca-af22-44cf-a3aa-2fda91504c0b",
"db_currency_id": "1ecf8b6a-ee0a-4df7-b3bb-9c8f5ba10c26",
"db_language_id": "8631a775-42dd-4226-a4b8-6c57b93ea593",
"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-01-15T06:44:51.5999789+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4c6f27ef-1109-404b-b8f3-ec8295393eed",
"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": "dbeeb57d-4438-451d-8001-aad63885ef31",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-15T06:44:51.5999789+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7b6527f3-93ec-401f-b405-091bfa45d52a"
},
"suggested_date_start": "2026-01-15T06:44:51.5999789+00:00",
"skill_id": "0b68564c-f0c5-4abf-bbd3-2bc9691c5a67",
"skill_code": "sample string 32",
"skill": {
"id": "f16b1a0e-e268-4d9c-8ee7-73620af10e70",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "075bd13c-8b85-4851-b964-6dbbd7a0741c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "65cc64b8-16f9-4f64-a9c4-8dd57601c816",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24b2b7ca-af22-44cf-a3aa-2fda91504c0b",
"db_currency_id": "1ecf8b6a-ee0a-4df7-b3bb-9c8f5ba10c26",
"db_language_id": "8631a775-42dd-4226-a4b8-6c57b93ea593",
"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-01-15T06:44:51.5999789+00:00"
},
"modified_dateutc": "2026-01-15T06:44:51.5999789+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c00b320f-fbfa-4172-bc51-eccc429ccad8",
"date_reported_by_company": "2026-01-15T06:44:51.5999789+00:00",
"id2": 36,
"company_id": "c47797ca-82e6-4781-bef4-de375d96e85e",
"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": "1ec75cba-2a9c-45bd-b84d-9e928c857954",
"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-01-15T06:44:51.5999789+00:00"
},
"work_instruction_details_id": "88237ebf-5ba0-42ac-8536-031eaad2b556",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "06a789a8-ac08-4804-abd7-2bf073a4a850",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "277bd030-f5f0-4b5d-8555-76a3e856ae8e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-15T06:44:51.5999789+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": "2355b875-91a2-4641-aa97-4b615df1eb56",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-15T06:44:51.5999789+00:00"
}