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": "dcb257aa-4fc2-4b64-ae88-5258e4897dda",
"jobs_id": "6ff3dac6-1021-4057-81e9-633c28864070",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ade5ed65-405e-4ee0-8c31-3a9aa6f42977",
"_parent_id": "c68ef139-b243-407a-9a13-d03a7d6245eb",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "12486de8-1bbf-4fc8-afca-d7d713b7b778",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a0a513b1-3c10-480d-b290-d51cc29dddd5",
"_parent_id": "8305fca1-6ab3-4456-9dcf-517dd51d0e8d",
"root_parent_id": "50070bf9-42bc-45cd-b4f3-ec8c6d00f040",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "59db6a7b-a261-43ad-8f4e-5a7c75c814d1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "95671e9a-5932-4c2e-8a58-6374c84c3046",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4e18cfa1-386d-4370-9f05-774c6fe21dc6",
"_parent_code": "sample string 6",
"sales_organization_id": "08c8fbac-37d2-4436-abdb-c36c5ef7a0fd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "81756b30-57ec-45ac-9ba0-2d26362e6526",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1c31aff-3599-44b8-ba78-916a15c1b18d",
"db_currency_id": "1e2cdfb7-ac66-4483-bfad-39ce47a8b221",
"db_language_id": "dc6a6ce6-707b-463c-81ee-4495dc77c635",
"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-11-06T15:47:37.5470422+00:00"
},
"modified_dateutc": "2025-11-06T15:47:37.5470422+00:00"
},
"equipment_model_id": "cf7614d5-1650-4f2f-a305-94f2b2d80069",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e9da7a9f-81fb-4001-9eaa-4970ba9f463b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d2b0eeab-effd-4c04-8ba8-1eb1c101dd80",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0f80b275-44a2-4a49-a136-a152cf06e6d5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7df038c7-a5ce-4050-9b9b-8df6d5d0a035",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "81756b30-57ec-45ac-9ba0-2d26362e6526",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1c31aff-3599-44b8-ba78-916a15c1b18d",
"db_currency_id": "1e2cdfb7-ac66-4483-bfad-39ce47a8b221",
"db_language_id": "dc6a6ce6-707b-463c-81ee-4495dc77c635",
"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-11-06T15:47:37.5470422+00:00"
},
"modified_dateutc": "2025-11-06T15:47:37.5470422+00:00"
},
"equipment_family_id": "4eab97ea-09dd-466c-a1b7-bc0aba876995",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "95671e9a-5932-4c2e-8a58-6374c84c3046",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4e18cfa1-386d-4370-9f05-774c6fe21dc6",
"_parent_code": "sample string 6",
"sales_organization_id": "08c8fbac-37d2-4436-abdb-c36c5ef7a0fd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "81756b30-57ec-45ac-9ba0-2d26362e6526",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1c31aff-3599-44b8-ba78-916a15c1b18d",
"db_currency_id": "1e2cdfb7-ac66-4483-bfad-39ce47a8b221",
"db_language_id": "dc6a6ce6-707b-463c-81ee-4495dc77c635",
"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-11-06T15:47:37.5470422+00:00"
},
"modified_dateutc": "2025-11-06T15:47:37.5470422+00:00"
},
"date_in_production_since": "2025-11-06T15:47:37.5470422+00:00",
"date_out_of_production_since": "2025-11-06T15:47:37.5470422+00:00",
"date_end_support": "2025-11-06T15:47:37.5470422+00:00",
"sales_organization_id": "81633a72-f849-4dc2-930d-dc3b96951385",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "81756b30-57ec-45ac-9ba0-2d26362e6526",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1c31aff-3599-44b8-ba78-916a15c1b18d",
"db_currency_id": "1e2cdfb7-ac66-4483-bfad-39ce47a8b221",
"db_language_id": "dc6a6ce6-707b-463c-81ee-4495dc77c635",
"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-11-06T15:47:37.5470422+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-11-06T15:47:37.5626622+00:00"
},
"project_status_id": "fcaa4c5f-924d-453e-b427-d254066c422e",
"project_status_code": "sample string 10",
"project_status": {
"id": "c40cfb3e-5c97-49b3-863d-7ccf4785c7b8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "109b9958-a852-4597-8b48-49d449d54eb1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "81756b30-57ec-45ac-9ba0-2d26362e6526",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1c31aff-3599-44b8-ba78-916a15c1b18d",
"db_currency_id": "1e2cdfb7-ac66-4483-bfad-39ce47a8b221",
"db_language_id": "dc6a6ce6-707b-463c-81ee-4495dc77c635",
"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-11-06T15:47:37.5470422+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-06T15:47:37.5626622+00:00"
},
"company_id": "b13a5bc3-1c4a-41b8-9ed3-c7504c9b0a2a",
"company_code": "sample string 12",
"db_address_id": "99bce340-c691-4b11-9b61-ffaf3d8cf0f1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c5eb5bb7-8f5f-4105-a229-0b621f85f104",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c24c36b3-6c0b-41b3-b499-8280f3f1804d",
"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-11-06T15:47:37.5626622+00:00",
"date_create": "2025-11-06T15:47:37.5626622+00:00",
"date_update": "2025-11-06T15:47:37.5626622+00:00",
"updated_by_user_id": "75829478-633e-40f6-a7bd-3ece80c6aa3c",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-06T15:47:37.5626622+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-11-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-06T15:47:37.5626622+00:00",
"date_last_job": "2025-11-06T15:47:37.5626622+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-06T15:47:37.5626622+00:00",
"modified_dateutc": "2025-11-06T15:47:37.5626622+00:00",
"is_mobile_installation": true
},
"job_type_id": "db9aa3d1-839c-4d78-9007-2fb593907e48",
"job_type_code": "sample string 7",
"job_type": {
"id": "3877e960-5a60-4623-badd-5287d5380cfa",
"name": "sample string 2",
"sales_organization_id": "9759af13-7859-4aa7-ab88-002174227cc7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-06T15:47:37.5626622+00:00",
"code": "sample string 7"
},
"job_priority_id": "620ed931-b315-48f9-bccb-3887a5bff17a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2a94b8a0-e379-4051-b6f7-a1b1e2afc4d7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f24e6464-917e-4dc7-a075-bc7aafee9986",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "81756b30-57ec-45ac-9ba0-2d26362e6526",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1c31aff-3599-44b8-ba78-916a15c1b18d",
"db_currency_id": "1e2cdfb7-ac66-4483-bfad-39ce47a8b221",
"db_language_id": "dc6a6ce6-707b-463c-81ee-4495dc77c635",
"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-11-06T15:47:37.5470422+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-06T15:47:37.5626622+00:00"
},
"job_status_id": "d52c22cb-fca1-4f43-8065-210df10578df",
"job_status_code": "sample string 11",
"db_address_id": "175c4659-c663-44ee-82fb-62b1d086f33c",
"contact_id": "66ae83ef-a28c-4b20-8347-ab1b42ceab50",
"requested_by_company_id": "9967668c-0e73-418f-a252-3cdbcecc771d",
"requested_by_contact_id": "407b8ec1-9ec8-4e26-a7cc-571867af0533",
"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-11-06T15:47:37.5626622+00:00",
"due_date": "2025-11-06T15:47:37.5626622+00:00",
"date_create": "2025-11-06T15:47:37.5626622+00:00",
"date_update": "2025-11-06T15:47:37.5626622+00:00",
"date_closed": "2025-11-06T15:47:37.5626622+00:00",
"suggested_user_id": "27a59472-a7ca-4366-9650-b4d2fc31de77",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "89cce3cc-1141-4f13-8423-9692be914efa",
"db_language_id": "d0053403-ef43-42f8-9fd1-40f65b92e582",
"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-11-06T15:47:37.5626622+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9b55ba72-dde7-490f-8187-67cbf5f03172",
"sales_organization": {
"id": "81756b30-57ec-45ac-9ba0-2d26362e6526",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1c31aff-3599-44b8-ba78-916a15c1b18d",
"db_currency_id": "1e2cdfb7-ac66-4483-bfad-39ce47a8b221",
"db_language_id": "dc6a6ce6-707b-463c-81ee-4495dc77c635",
"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-11-06T15:47:37.5470422+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2e22d4ac-dfdf-463e-af73-7dd80dd84497",
"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": "b5a42ce9-4d6f-4d4a-8aae-15994dfdedbc",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-06T15:47:37.5626622+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6ff46a31-8382-43b0-86d4-c4ad3cafcee5"
},
"suggested_date_start": "2025-11-06T15:47:37.5626622+00:00",
"skill_id": "8559d434-ab9d-4cbb-8f9c-d8ab7b2dbc4e",
"skill_code": "sample string 32",
"skill": {
"id": "f66f268b-e23d-46c0-92c2-1cec28075330",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d4c4f28b-30c0-4e00-a02b-f31a90e901b1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "81756b30-57ec-45ac-9ba0-2d26362e6526",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1c31aff-3599-44b8-ba78-916a15c1b18d",
"db_currency_id": "1e2cdfb7-ac66-4483-bfad-39ce47a8b221",
"db_language_id": "dc6a6ce6-707b-463c-81ee-4495dc77c635",
"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-11-06T15:47:37.5470422+00:00"
},
"modified_dateutc": "2025-11-06T15:47:37.5626622+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "83b876f1-58d1-47e8-b1c3-2d28393d58cc",
"date_reported_by_company": "2025-11-06T15:47:37.5626622+00:00",
"id2": 36,
"company_id": "c6fb8b8b-e025-4be2-b40b-67badae4a768",
"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": "3a215221-d821-4eed-aa25-295b4b41ff62",
"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-11-06T15:47:37.5626622+00:00"
},
"work_instruction_details_id": "4c713a65-d930-4b7e-b806-0d3a2e542bce",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "498cf622-b57c-4f27-b099-ef62c95c5567",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a147530c-7ba7-405e-bc76-3f7e2a1976eb",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-06T15:47:37.5626622+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": "a59926e3-1c82-4dfb-8b25-9273feca8fa6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-06T15:47:37.5626622+00:00"
}