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": "b8c238ad-0fa4-4d33-90ef-663529bc9ba7",
"jobs_id": "0c24a731-060c-467b-ad2d-d3f37ce6d79a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "940e6b1a-cbea-4e06-93a6-4b2c870b30b0",
"_parent_id": "7fb65963-e9fc-4c74-95a6-2cd106ac339a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "514074b0-0806-4a48-a2d7-2e0c5d92ba6a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e40e605f-1150-42d2-91e0-36a01e112323",
"_parent_id": "9d2175ce-aeb5-46b1-bfa1-93a2f772870c",
"root_parent_id": "45cb7148-7868-4ed5-8cc4-5ba3197c2e5b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d5f141c8-c2eb-41f4-a49e-2ecc961021ba",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "65074aab-27b4-4917-ba1b-4be8acee1140",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7ae339d8-c1aa-400c-a332-0fd19c33fad9",
"_parent_code": "sample string 6",
"sales_organization_id": "903aec45-28b1-4742-8d3e-e282bacb5ef8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4ca8af1c-2362-409e-892e-012f3d86ee10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f6ce0aa-c7ff-4fc5-99c7-7b8db40a438d",
"db_currency_id": "0e3a573f-d77e-4808-8472-78f016a12b96",
"db_language_id": "32955026-15d1-4861-8250-bb1fb91bb0bd",
"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-04T22:27:15.3715092+00:00"
},
"modified_dateutc": "2026-08-04T22:27:15.3715092+00:00"
},
"equipment_model_id": "9c783430-4669-408d-91c5-93fb87cb6c17",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7ccd3b6e-a7c2-4af3-9afe-2d20fd97748f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4be2b038-51b0-4d10-9bf4-3733b6e21a81",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3e525f0e-1e5f-4e3b-9e57-5ceff426b2cf",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fc952df5-0f88-4e53-b46a-b62e9bf6c13b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4ca8af1c-2362-409e-892e-012f3d86ee10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f6ce0aa-c7ff-4fc5-99c7-7b8db40a438d",
"db_currency_id": "0e3a573f-d77e-4808-8472-78f016a12b96",
"db_language_id": "32955026-15d1-4861-8250-bb1fb91bb0bd",
"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-04T22:27:15.3715092+00:00"
},
"modified_dateutc": "2026-08-04T22:27:15.3715092+00:00"
},
"equipment_family_id": "975cec43-5ca7-407e-bd34-50542517ee81",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "65074aab-27b4-4917-ba1b-4be8acee1140",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7ae339d8-c1aa-400c-a332-0fd19c33fad9",
"_parent_code": "sample string 6",
"sales_organization_id": "903aec45-28b1-4742-8d3e-e282bacb5ef8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4ca8af1c-2362-409e-892e-012f3d86ee10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f6ce0aa-c7ff-4fc5-99c7-7b8db40a438d",
"db_currency_id": "0e3a573f-d77e-4808-8472-78f016a12b96",
"db_language_id": "32955026-15d1-4861-8250-bb1fb91bb0bd",
"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-04T22:27:15.3715092+00:00"
},
"modified_dateutc": "2026-08-04T22:27:15.3715092+00:00"
},
"date_in_production_since": "2026-08-04T22:27:15.3715092+00:00",
"date_out_of_production_since": "2026-08-04T22:27:15.3715092+00:00",
"date_end_support": "2026-08-04T22:27:15.3715092+00:00",
"sales_organization_id": "1a8e5421-dc2e-40f9-8959-b8922e2c72f2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4ca8af1c-2362-409e-892e-012f3d86ee10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f6ce0aa-c7ff-4fc5-99c7-7b8db40a438d",
"db_currency_id": "0e3a573f-d77e-4808-8472-78f016a12b96",
"db_language_id": "32955026-15d1-4861-8250-bb1fb91bb0bd",
"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-04T22:27:15.3715092+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-04T22:27:15.3715092+00:00"
},
"project_status_id": "e9b25e42-b652-41ac-a0e3-283472ff1e5d",
"project_status_code": "sample string 10",
"project_status": {
"id": "c5a87c0d-6627-4b15-9c0e-bb02c414154f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "65355e16-ac44-442c-8013-c41640fe959a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4ca8af1c-2362-409e-892e-012f3d86ee10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f6ce0aa-c7ff-4fc5-99c7-7b8db40a438d",
"db_currency_id": "0e3a573f-d77e-4808-8472-78f016a12b96",
"db_language_id": "32955026-15d1-4861-8250-bb1fb91bb0bd",
"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-04T22:27:15.3715092+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-04T22:27:15.3715092+00:00"
},
"company_id": "e0f6e43d-5ff6-45e2-a796-925f5634c5a9",
"company_code": "sample string 12",
"db_address_id": "8c328056-b697-4285-9099-53949df55aa7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0b7d6406-dc5d-415a-b9cf-6a9056383721",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1278773a-ffe4-436a-ad99-d5084728e5b8",
"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-04T22:27:15.3715092+00:00",
"date_create": "2026-08-04T22:27:15.3715092+00:00",
"date_update": "2026-08-04T22:27:15.3715092+00:00",
"updated_by_user_id": "bb771952-2657-4e26-afb4-a3916e35b2f2",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-04T22:27:15.3715092+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-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-04T22:27:15.3715092+00:00",
"date_last_job": "2026-08-04T22:27:15.3715092+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-04T22:27:15.3715092+00:00",
"modified_dateutc": "2026-08-04T22:27:15.3715092+00:00",
"is_mobile_installation": true
},
"job_type_id": "75b7b16d-b7f8-4fba-8d1a-830d768afae0",
"job_type_code": "sample string 7",
"job_type": {
"id": "b17c4db3-db76-4823-b0c8-d2500bd64315",
"name": "sample string 2",
"sales_organization_id": "53c9290d-f6a7-4a6d-93cd-2557669e4d95",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-04T22:27:15.3715092+00:00",
"code": "sample string 7"
},
"job_priority_id": "59574678-696f-4901-9aa9-ca889c6ba911",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a6a29e82-71ce-4693-993b-e6a9e83cae09",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "decabdc8-4577-44af-b59c-cb80819f92c6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4ca8af1c-2362-409e-892e-012f3d86ee10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f6ce0aa-c7ff-4fc5-99c7-7b8db40a438d",
"db_currency_id": "0e3a573f-d77e-4808-8472-78f016a12b96",
"db_language_id": "32955026-15d1-4861-8250-bb1fb91bb0bd",
"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-04T22:27:15.3715092+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-04T22:27:15.3715092+00:00"
},
"job_status_id": "76bb663c-49d5-4340-ab1c-a4b7abff1cc4",
"job_status_code": "sample string 11",
"db_address_id": "d139e73f-0f1e-4ed9-9e84-f9b331260fa4",
"contact_id": "4295b5af-8fa3-43cd-a672-b3fb68221af9",
"requested_by_company_id": "59bae23a-c8a9-4461-93f5-131aefa9a31b",
"requested_by_contact_id": "c7c65162-b3c8-44c1-a0da-e3ffaba7c259",
"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-04T22:27:15.3715092+00:00",
"due_date": "2026-08-04T22:27:15.3715092+00:00",
"date_create": "2026-08-04T22:27:15.3715092+00:00",
"date_update": "2026-08-04T22:27:15.3715092+00:00",
"date_closed": "2026-08-04T22:27:15.3715092+00:00",
"suggested_user_id": "f45511eb-8b52-4f7a-8794-c6b001245bc0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "72ce2f94-8db8-42d4-ac22-0cf19bfb6df9",
"db_language_id": "1a42aa55-f748-47bf-9145-6bbea6c5ebde",
"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-04T22:27:15.3715092+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9265a4d2-d0b6-4ef3-b72b-82c4a54bdfaa",
"sales_organization": {
"id": "4ca8af1c-2362-409e-892e-012f3d86ee10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f6ce0aa-c7ff-4fc5-99c7-7b8db40a438d",
"db_currency_id": "0e3a573f-d77e-4808-8472-78f016a12b96",
"db_language_id": "32955026-15d1-4861-8250-bb1fb91bb0bd",
"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-04T22:27:15.3715092+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1d545282-c697-46e8-83c0-d2c148927f62",
"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": "aa0e11e2-ea2c-410f-8ea0-e886c272aa45",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-04T22:27:15.3715092+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "93903629-af2c-4be8-9f96-6df83184bc75"
},
"suggested_date_start": "2026-08-04T22:27:15.3715092+00:00",
"skill_id": "fce855bc-89d9-4a9b-bccc-443f124070c1",
"skill_code": "sample string 32",
"skill": {
"id": "0198daab-a9c1-494f-8542-79a52cd63fa4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4ba759d9-b79b-47f3-adfb-4a8adc1e367a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4ca8af1c-2362-409e-892e-012f3d86ee10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f6ce0aa-c7ff-4fc5-99c7-7b8db40a438d",
"db_currency_id": "0e3a573f-d77e-4808-8472-78f016a12b96",
"db_language_id": "32955026-15d1-4861-8250-bb1fb91bb0bd",
"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-04T22:27:15.3715092+00:00"
},
"modified_dateutc": "2026-08-04T22:27:15.3715092+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e816be8f-8c59-401a-9fc5-f31dc5ff71ba",
"date_reported_by_company": "2026-08-04T22:27:15.3715092+00:00",
"id2": 36,
"company_id": "1f4d736e-ccff-4d6a-bf96-5109106e3c29",
"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": "af00081c-1b72-40f5-9232-ef6344a7274c",
"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-04T22:27:15.3715092+00:00"
},
"work_instruction_details_id": "619dfc91-cd96-466b-8f92-e394b2b2f59d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e3c963b2-ba45-48a3-ac3e-2992199b4991",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a9f8a2ba-4d94-4d63-9b76-ad0e5f73268a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-04T22:27:15.3715092+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": "bc9257bc-25c4-4383-bdda-7827c225d9fc",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-04T22:27:15.3715092+00:00"
}