Retrieves all the job work instruction list.
Request Information
URI Parameters :
None.
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": "2ccac0d4-5f13-4474-99b6-13bc439adf66",
"jobs_id": "ce3b331b-fd46-4b93-85b6-c780b5a80637",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4d46b1a9-28bf-4697-9d1e-8bd44b3e7433",
"_parent_id": "0c68db53-74db-43b1-9e29-80c02a380c94",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9af008d5-36ae-46f1-af09-800ebd44554f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "950324cf-74fe-414b-a97c-64ec84ad7bc9",
"_parent_id": "22a2e719-326f-41e8-966e-2d4285072602",
"root_parent_id": "af323706-c428-45ac-a195-ac9c3c8e18db",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "36d67876-1426-4456-a72b-d241d11fdbd0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7ebde7d2-7d6a-4d70-8481-a1e02c364beb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "641868c9-3dcb-4cd0-bd95-38f3bcc6526c",
"_parent_code": "sample string 6",
"sales_organization_id": "865a8bb1-962a-41fa-a2b5-ee1647f84bf1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a2a50d4c-110c-4df8-a9cc-4a25ac1d52a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c51ad7d-3f10-4dcd-b98b-ec38417c647c",
"db_currency_id": "b7705112-f34d-4ed0-8a87-86b0e549de4e",
"db_language_id": "2bf2ff48-a0aa-4ca0-a64c-dec91d142962",
"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-12-21T12:04:28.4122021+00:00"
},
"modified_dateutc": "2025-12-21T12:04:28.4122021+00:00"
},
"equipment_model_id": "b0257526-4d90-46ee-90bb-b28c9cb76675",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3bb1bc44-ae38-4a15-b50d-c3ec9e4079b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3f27ae94-4159-4c72-9569-a8f63a554e8d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "13d3f186-67fd-4f80-adaa-273a808fa3f2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4d83bb2c-adff-4e95-be42-5d45e321493b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a2a50d4c-110c-4df8-a9cc-4a25ac1d52a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c51ad7d-3f10-4dcd-b98b-ec38417c647c",
"db_currency_id": "b7705112-f34d-4ed0-8a87-86b0e549de4e",
"db_language_id": "2bf2ff48-a0aa-4ca0-a64c-dec91d142962",
"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-12-21T12:04:28.4122021+00:00"
},
"modified_dateutc": "2025-12-21T12:04:28.4122021+00:00"
},
"equipment_family_id": "1fe09a7a-1494-4a0c-a87c-ac50a251e8f3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7ebde7d2-7d6a-4d70-8481-a1e02c364beb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "641868c9-3dcb-4cd0-bd95-38f3bcc6526c",
"_parent_code": "sample string 6",
"sales_organization_id": "865a8bb1-962a-41fa-a2b5-ee1647f84bf1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a2a50d4c-110c-4df8-a9cc-4a25ac1d52a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c51ad7d-3f10-4dcd-b98b-ec38417c647c",
"db_currency_id": "b7705112-f34d-4ed0-8a87-86b0e549de4e",
"db_language_id": "2bf2ff48-a0aa-4ca0-a64c-dec91d142962",
"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-12-21T12:04:28.4122021+00:00"
},
"modified_dateutc": "2025-12-21T12:04:28.4122021+00:00"
},
"date_in_production_since": "2025-12-21T12:04:28.4122021+00:00",
"date_out_of_production_since": "2025-12-21T12:04:28.4122021+00:00",
"date_end_support": "2025-12-21T12:04:28.4122021+00:00",
"sales_organization_id": "5a013cb5-8bed-451b-9195-ddd41a651d16",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a2a50d4c-110c-4df8-a9cc-4a25ac1d52a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c51ad7d-3f10-4dcd-b98b-ec38417c647c",
"db_currency_id": "b7705112-f34d-4ed0-8a87-86b0e549de4e",
"db_language_id": "2bf2ff48-a0aa-4ca0-a64c-dec91d142962",
"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-12-21T12:04:28.4122021+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-12-21T12:04:28.4122021+00:00"
},
"project_status_id": "186c3565-4a9a-4284-8c28-4b98455c6e8e",
"project_status_code": "sample string 10",
"project_status": {
"id": "00441970-f79c-4e58-8ba1-2da3c9349f3c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bb926785-fe83-4352-8e47-449e36307fae",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2a50d4c-110c-4df8-a9cc-4a25ac1d52a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c51ad7d-3f10-4dcd-b98b-ec38417c647c",
"db_currency_id": "b7705112-f34d-4ed0-8a87-86b0e549de4e",
"db_language_id": "2bf2ff48-a0aa-4ca0-a64c-dec91d142962",
"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-12-21T12:04:28.4122021+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-21T12:04:28.4278237+00:00"
},
"company_id": "d22580f4-22ac-4d5f-96c9-b3d899293dc8",
"company_code": "sample string 12",
"db_address_id": "e017efff-daab-4915-809c-8033d8189993",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c381987c-4b7d-4145-bd28-b34c41c45c94",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2b255a99-f979-45fa-8252-6a56a3022315",
"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-12-21T12:04:28.4278237+00:00",
"date_create": "2025-12-21T12:04:28.4278237+00:00",
"date_update": "2025-12-21T12:04:28.4278237+00:00",
"updated_by_user_id": "1962f809-3465-4ac2-a22e-fc1e9232e8d2",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-21T12:04:28.4278237+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-12-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-21T12:04:28.4278237+00:00",
"date_last_job": "2025-12-21T12:04:28.4278237+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-21T12:04:28.4278237+00:00",
"modified_dateutc": "2025-12-21T12:04:28.4278237+00:00",
"is_mobile_installation": true
},
"job_type_id": "522af657-44a6-48ee-9dcb-1b4c835c1ed1",
"job_type_code": "sample string 7",
"job_type": {
"id": "040e5c38-0b4b-49ee-a8a5-f094a527e83f",
"name": "sample string 2",
"sales_organization_id": "8c87d56c-4143-49bd-a85d-1165bd358915",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-21T12:04:28.4278237+00:00",
"code": "sample string 7"
},
"job_priority_id": "1f320d18-2ff2-4585-a271-f32e3fbc16f5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8796f6db-b5ac-46d0-bea4-54df35de4f87",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2fb13774-2da5-40a3-abb8-db2e610cb135",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2a50d4c-110c-4df8-a9cc-4a25ac1d52a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c51ad7d-3f10-4dcd-b98b-ec38417c647c",
"db_currency_id": "b7705112-f34d-4ed0-8a87-86b0e549de4e",
"db_language_id": "2bf2ff48-a0aa-4ca0-a64c-dec91d142962",
"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-12-21T12:04:28.4122021+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-21T12:04:28.4278237+00:00"
},
"job_status_id": "1363d46a-ec7d-4518-a11e-6c2a702c0069",
"job_status_code": "sample string 11",
"db_address_id": "569d933c-1c51-44d8-ae77-de818e55c062",
"contact_id": "a7598a64-1854-4bfb-87ea-5b4bbe9b39b2",
"requested_by_company_id": "ddfd251a-caaf-4e7e-96fd-b9c6a79237ca",
"requested_by_contact_id": "aea73590-09bd-42e9-a4e2-7555a4f816b5",
"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-12-21T12:04:28.4278237+00:00",
"due_date": "2025-12-21T12:04:28.4278237+00:00",
"date_create": "2025-12-21T12:04:28.4278237+00:00",
"date_update": "2025-12-21T12:04:28.4278237+00:00",
"date_closed": "2025-12-21T12:04:28.4278237+00:00",
"suggested_user_id": "c613b9fc-e34b-4702-aa94-5d40df15175c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "06b1c697-26cf-40b8-b560-d8a2ac149b2b",
"db_language_id": "302774d0-1c39-4b23-88cd-ec7eea2a3164",
"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-12-21T12:04:28.4278237+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "22d52b28-8347-4be6-bee3-3db7a155f5b3",
"sales_organization": {
"id": "a2a50d4c-110c-4df8-a9cc-4a25ac1d52a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c51ad7d-3f10-4dcd-b98b-ec38417c647c",
"db_currency_id": "b7705112-f34d-4ed0-8a87-86b0e549de4e",
"db_language_id": "2bf2ff48-a0aa-4ca0-a64c-dec91d142962",
"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-12-21T12:04:28.4122021+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "be3c29e7-ff5d-41a7-b39e-8e1f96c33024",
"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": "a50450f7-23ba-4428-9233-c1400cbc3ab0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-21T12:04:28.4278237+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3db0084b-81f9-4a1b-8b34-59bb1e663f26"
},
"suggested_date_start": "2025-12-21T12:04:28.4278237+00:00",
"skill_id": "66f305ed-902e-4470-9f2d-e74a47a64d8f",
"skill_code": "sample string 32",
"skill": {
"id": "453958a9-dd1f-4805-9539-4dde11478ca7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a2a510d3-decd-485b-b683-febd0b4dcc99",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2a50d4c-110c-4df8-a9cc-4a25ac1d52a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c51ad7d-3f10-4dcd-b98b-ec38417c647c",
"db_currency_id": "b7705112-f34d-4ed0-8a87-86b0e549de4e",
"db_language_id": "2bf2ff48-a0aa-4ca0-a64c-dec91d142962",
"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-12-21T12:04:28.4122021+00:00"
},
"modified_dateutc": "2025-12-21T12:04:28.4278237+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c4ac85ce-da0c-429c-9ecb-a6532c0bcfe6",
"date_reported_by_company": "2025-12-21T12:04:28.4278237+00:00",
"id2": 36,
"company_id": "90e97257-f8ae-4d0b-8f99-68ec496007bf",
"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": "f89b2590-c647-4cff-80fa-ca43c3b671c7",
"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-12-21T12:04:28.4278237+00:00"
},
"work_instruction_details_id": "d4c2a198-b914-4492-9fbf-26d841360f19",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e976bab0-4754-47f2-b272-3a645d09c502",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7623dc89-ba58-4d5c-b321-b2f10b00a4fb",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-21T12:04:28.4278237+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": "e5a9d429-9fbb-4c02-b7aa-81849531a20c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-21T12:04:28.4278237+00:00"
}