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": "4a50bff4-2172-4132-ba9e-d9385f9524b7",
"jobs_id": "dd89a198-b85c-4047-b609-74cf7abb85b6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "61d74d09-54f4-4f08-85aa-713c47941c3d",
"_parent_id": "6cd51830-9b97-46e9-bffd-8e7e8572f630",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c71e53b7-6188-475d-9d78-70c446c06209",
"project_reference_back_office": "sample string 5",
"project": {
"id": "756b146d-8388-4a35-8a4d-688a3786c7de",
"_parent_id": "fe8b89ec-cc51-42dd-81ff-a0560b060684",
"root_parent_id": "3a1c32d9-922d-474d-a934-0e1f41725d1c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c23cc888-8b04-4d0d-b125-94b2bebb6384",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e8726511-15e6-4b61-9c55-2f4c3a09eb1a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "295b5662-7984-488d-9725-8554008c2a46",
"_parent_code": "sample string 6",
"sales_organization_id": "eede90d7-0e21-4a06-9a40-a384643c7b63",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b4d738ea-88e3-4655-ac9a-b58c9401c877",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71fe5250-aee4-45d6-ba36-ff0deb74a6a4",
"db_currency_id": "2f22ea6c-2233-42b4-a67b-ad3cb63d520f",
"db_language_id": "61484edc-a963-415c-b139-043da9b849a3",
"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": "2025-10-10T04:50:26.2076919+00:00"
},
"modified_dateutc": "2025-10-10T04:50:26.2076919+00:00"
},
"equipment_model_id": "41bd2886-74ba-4d3b-b388-6f30d7d4b488",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "133e0d2b-7154-4d25-98f9-21e52aa58ad2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ade71a25-89e5-4f98-aa29-5fbb58e1ec53",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c479d46c-9a81-4a81-ab2f-1ad84680f661",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bf4a9094-2e6b-4575-9552-74e001c9d7c8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b4d738ea-88e3-4655-ac9a-b58c9401c877",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71fe5250-aee4-45d6-ba36-ff0deb74a6a4",
"db_currency_id": "2f22ea6c-2233-42b4-a67b-ad3cb63d520f",
"db_language_id": "61484edc-a963-415c-b139-043da9b849a3",
"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": "2025-10-10T04:50:26.2076919+00:00"
},
"modified_dateutc": "2025-10-10T04:50:26.2076919+00:00"
},
"equipment_family_id": "19e5e6db-0302-49c2-86ca-6b09a50be708",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e8726511-15e6-4b61-9c55-2f4c3a09eb1a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "295b5662-7984-488d-9725-8554008c2a46",
"_parent_code": "sample string 6",
"sales_organization_id": "eede90d7-0e21-4a06-9a40-a384643c7b63",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b4d738ea-88e3-4655-ac9a-b58c9401c877",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71fe5250-aee4-45d6-ba36-ff0deb74a6a4",
"db_currency_id": "2f22ea6c-2233-42b4-a67b-ad3cb63d520f",
"db_language_id": "61484edc-a963-415c-b139-043da9b849a3",
"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": "2025-10-10T04:50:26.2076919+00:00"
},
"modified_dateutc": "2025-10-10T04:50:26.2076919+00:00"
},
"date_in_production_since": "2025-10-10T04:50:26.2076919+00:00",
"date_out_of_production_since": "2025-10-10T04:50:26.2076919+00:00",
"date_end_support": "2025-10-10T04:50:26.2076919+00:00",
"sales_organization_id": "24997587-f85b-423b-8663-ef4a345f3084",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b4d738ea-88e3-4655-ac9a-b58c9401c877",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71fe5250-aee4-45d6-ba36-ff0deb74a6a4",
"db_currency_id": "2f22ea6c-2233-42b4-a67b-ad3cb63d520f",
"db_language_id": "61484edc-a963-415c-b139-043da9b849a3",
"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": "2025-10-10T04:50:26.2076919+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": "2025-10-10T04:50:26.2076919+00:00"
},
"project_status_id": "789710fc-322e-4c2d-9365-573261c56dd1",
"project_status_code": "sample string 10",
"project_status": {
"id": "ef0b708f-1416-49f5-9885-b9fa1aa0d52d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4acaed24-d6c9-429a-9b57-d809f03a669d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b4d738ea-88e3-4655-ac9a-b58c9401c877",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71fe5250-aee4-45d6-ba36-ff0deb74a6a4",
"db_currency_id": "2f22ea6c-2233-42b4-a67b-ad3cb63d520f",
"db_language_id": "61484edc-a963-415c-b139-043da9b849a3",
"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": "2025-10-10T04:50:26.2076919+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-10T04:50:26.2076919+00:00"
},
"company_id": "bbab3555-458a-450f-a7c8-7ebf010e294c",
"company_code": "sample string 12",
"db_address_id": "89223d54-fae3-4bdd-955a-e622e126885f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8eedf769-cf83-4374-8df7-adffa1df8acd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c9df226e-1e50-47fd-9f93-2b5bcfe50e9c",
"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": "2025-10-10T04:50:26.2076919+00:00",
"date_create": "2025-10-10T04:50:26.2076919+00:00",
"date_update": "2025-10-10T04:50:26.2076919+00:00",
"updated_by_user_id": "706b067d-e5f7-4af1-894e-8c8889916b62",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-10T04:50:26.2076919+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": "2025-10-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-10T04:50:26.2076919+00:00",
"date_last_job": "2025-10-10T04:50:26.2076919+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-10T04:50:26.2076919+00:00",
"modified_dateutc": "2025-10-10T04:50:26.2233204+00:00",
"is_mobile_installation": true
},
"job_type_id": "7fc78799-4681-4e0a-a44b-a5df879f286e",
"job_type_code": "sample string 7",
"job_type": {
"id": "3714c3a6-ccf6-43e2-bd5b-60d5dee67e3b",
"name": "sample string 2",
"sales_organization_id": "b6ffd144-f431-4f0f-8cf4-498925d03b22",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-10T04:50:26.2233204+00:00",
"code": "sample string 7"
},
"job_priority_id": "889633f0-1b98-4b90-972b-fb6be7e8d7bf",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "69ba3caa-1b35-41b6-8c55-ed7bbfee9094",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "06653f24-2515-4ca4-acdc-db538e8513ce",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b4d738ea-88e3-4655-ac9a-b58c9401c877",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71fe5250-aee4-45d6-ba36-ff0deb74a6a4",
"db_currency_id": "2f22ea6c-2233-42b4-a67b-ad3cb63d520f",
"db_language_id": "61484edc-a963-415c-b139-043da9b849a3",
"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": "2025-10-10T04:50:26.2076919+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-10T04:50:26.2233204+00:00"
},
"job_status_id": "0289dea6-bf5c-4fd5-82da-4b5213e9a6c9",
"job_status_code": "sample string 11",
"db_address_id": "fd3110c6-103c-4e33-993b-cb236b479a88",
"contact_id": "cc07e1a1-29f4-4057-951a-50292d08ba72",
"requested_by_company_id": "d3449bf8-27d5-4836-8625-9f0cbb6a0aa8",
"requested_by_contact_id": "4171f1ba-a9d7-43a6-867f-c25958f3bf84",
"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": "2025-10-10T04:50:26.2233204+00:00",
"due_date": "2025-10-10T04:50:26.2233204+00:00",
"date_create": "2025-10-10T04:50:26.2233204+00:00",
"date_update": "2025-10-10T04:50:26.2233204+00:00",
"date_closed": "2025-10-10T04:50:26.2233204+00:00",
"suggested_user_id": "3d2c1d80-d888-46c4-9931-f33c9b963c1e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ac9cf330-da30-4cc0-89e3-aa8b8f9fcd2b",
"db_language_id": "f8492c3f-e095-46ac-9070-5876d0d7b0f2",
"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": "2025-10-10T04:50:26.2233204+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c07f15f2-19c7-4757-87cf-057da995d31f",
"sales_organization": {
"id": "b4d738ea-88e3-4655-ac9a-b58c9401c877",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71fe5250-aee4-45d6-ba36-ff0deb74a6a4",
"db_currency_id": "2f22ea6c-2233-42b4-a67b-ad3cb63d520f",
"db_language_id": "61484edc-a963-415c-b139-043da9b849a3",
"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": "2025-10-10T04:50:26.2076919+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e95e0b37-4925-4579-879c-bbc551555a9a",
"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": "90bc3af8-272d-4ad6-89d0-fba1c819f4ce",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-10T04:50:26.2233204+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "33986499-fb15-4529-a252-50d36466c66b"
},
"suggested_date_start": "2025-10-10T04:50:26.2233204+00:00",
"skill_id": "6f7e8b77-8e9d-4b9f-b9df-84a56ffc4206",
"skill_code": "sample string 32",
"skill": {
"id": "19ef16ae-7c88-46a7-880a-c303257e81bd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "03eeb5d8-567a-4aa5-b8b8-c1831b8426f7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b4d738ea-88e3-4655-ac9a-b58c9401c877",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71fe5250-aee4-45d6-ba36-ff0deb74a6a4",
"db_currency_id": "2f22ea6c-2233-42b4-a67b-ad3cb63d520f",
"db_language_id": "61484edc-a963-415c-b139-043da9b849a3",
"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": "2025-10-10T04:50:26.2076919+00:00"
},
"modified_dateutc": "2025-10-10T04:50:26.2233204+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1169c16e-650e-44b3-a705-b1aa8b36470e",
"date_reported_by_company": "2025-10-10T04:50:26.2233204+00:00",
"id2": 36,
"company_id": "ad5206d3-b690-4076-b84a-5e8013f1057f",
"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": "e1662fae-1ded-4b47-ae10-b5b87be3f559",
"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": "2025-10-10T04:50:26.2233204+00:00"
},
"work_instruction_details_id": "e6a332aa-f849-4f1b-8704-b2d15fe0cd8a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ff2dcff9-bd08-4c82-9969-560e81058a03",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "86f64da6-14e4-4460-8860-e2eb40aca190",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-10T04:50:26.2233204+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": "efa957fb-8834-4eed-9dda-4d4565b61fa8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-10T04:50:26.2233204+00:00"
}