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": "0173a6b0-dd6d-43e2-aecf-99526f4a4439",
"jobs_id": "70dbc8c5-12cb-4b71-a97d-9a1b5717b978",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d06b2206-ce0e-49d8-b0e4-bada9bf14bb5",
"_parent_id": "6f2c23df-b603-4e54-9cbd-f10aafbc2321",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "690152a7-54f3-45d6-814c-71bf6da1e87a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "271d3025-51f4-489a-9856-358b74a35465",
"_parent_id": "d579f10c-ea25-48c8-aa9f-ea563582827a",
"root_parent_id": "4a88be0c-8542-4193-8b34-0b05398f7e69",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c2af66eb-83fc-498d-bcd2-9863729c0928",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "447cea00-e2a3-463a-901d-90533228c1c9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d495a608-f539-48ba-98de-0d96cc06086a",
"_parent_code": "sample string 6",
"sales_organization_id": "de3150bd-a5de-4d65-8e35-7b37f70e46f2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f63bf1df-1f1a-4ff0-95c2-352a5fd8bbbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e927f8eb-3ff2-4a24-9db5-b7c976f3811f",
"db_currency_id": "11f7bb19-de71-4c93-aeb4-6e17983f0b38",
"db_language_id": "8933475d-b5ba-4669-a427-93e2379506f7",
"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-07-15T07:01:11.4236368+00:00"
},
"modified_dateutc": "2026-07-15T07:01:11.4236368+00:00"
},
"equipment_model_id": "ba486da6-eec3-4afa-b619-46fca030fcde",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "453d7f1a-e5cc-49bc-bf42-f7d32be52ccd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "439c114d-6a55-4c86-a986-929af72a4134",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "29bcc241-8073-4cb4-ad96-020946844984",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9a09a434-3575-4c64-adfc-788fb3ebbd34",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f63bf1df-1f1a-4ff0-95c2-352a5fd8bbbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e927f8eb-3ff2-4a24-9db5-b7c976f3811f",
"db_currency_id": "11f7bb19-de71-4c93-aeb4-6e17983f0b38",
"db_language_id": "8933475d-b5ba-4669-a427-93e2379506f7",
"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-07-15T07:01:11.4236368+00:00"
},
"modified_dateutc": "2026-07-15T07:01:11.4236368+00:00"
},
"equipment_family_id": "50ad5c1d-aea5-465e-bf39-45e31c5cb65b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "447cea00-e2a3-463a-901d-90533228c1c9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d495a608-f539-48ba-98de-0d96cc06086a",
"_parent_code": "sample string 6",
"sales_organization_id": "de3150bd-a5de-4d65-8e35-7b37f70e46f2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f63bf1df-1f1a-4ff0-95c2-352a5fd8bbbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e927f8eb-3ff2-4a24-9db5-b7c976f3811f",
"db_currency_id": "11f7bb19-de71-4c93-aeb4-6e17983f0b38",
"db_language_id": "8933475d-b5ba-4669-a427-93e2379506f7",
"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-07-15T07:01:11.4236368+00:00"
},
"modified_dateutc": "2026-07-15T07:01:11.4236368+00:00"
},
"date_in_production_since": "2026-07-15T07:01:11.4236368+00:00",
"date_out_of_production_since": "2026-07-15T07:01:11.4236368+00:00",
"date_end_support": "2026-07-15T07:01:11.4236368+00:00",
"sales_organization_id": "676af475-8ad2-48cf-bfd9-1141229ae85f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f63bf1df-1f1a-4ff0-95c2-352a5fd8bbbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e927f8eb-3ff2-4a24-9db5-b7c976f3811f",
"db_currency_id": "11f7bb19-de71-4c93-aeb4-6e17983f0b38",
"db_language_id": "8933475d-b5ba-4669-a427-93e2379506f7",
"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-07-15T07:01:11.4236368+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-07-15T07:01:11.4236368+00:00"
},
"project_status_id": "5c0abddd-63b6-41e8-af5a-2c995281a28f",
"project_status_code": "sample string 10",
"project_status": {
"id": "5c94c2da-52d8-4b80-925b-272fee1bc182",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "94cb223b-0aa7-4db6-b437-bf9c3f84aaef",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f63bf1df-1f1a-4ff0-95c2-352a5fd8bbbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e927f8eb-3ff2-4a24-9db5-b7c976f3811f",
"db_currency_id": "11f7bb19-de71-4c93-aeb4-6e17983f0b38",
"db_language_id": "8933475d-b5ba-4669-a427-93e2379506f7",
"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-07-15T07:01:11.4236368+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-15T07:01:11.4236368+00:00"
},
"company_id": "3cf13820-1534-4f3b-8502-66962118b103",
"company_code": "sample string 12",
"db_address_id": "cc49e977-9117-4a71-b050-4f3761623676",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1c4e13fd-1295-4303-92d6-5b5f89846ce2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "39380a1a-5221-4173-a5e9-4a8f4706107b",
"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-07-15T07:01:11.4236368+00:00",
"date_create": "2026-07-15T07:01:11.4236368+00:00",
"date_update": "2026-07-15T07:01:11.4236368+00:00",
"updated_by_user_id": "af3bdac0-b6ad-4bc6-9092-270a8ba01f05",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-15T07:01:11.4236368+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-07-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-15T07:01:11.4236368+00:00",
"date_last_job": "2026-07-15T07:01:11.4236368+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-15T07:01:11.4236368+00:00",
"modified_dateutc": "2026-07-15T07:01:11.4236368+00:00",
"is_mobile_installation": true
},
"job_type_id": "615e3fc4-bfc3-4fbc-8217-c4bba8c41379",
"job_type_code": "sample string 7",
"job_type": {
"id": "9dd7a1ae-bc49-4fc2-821b-e42baaaed0c2",
"name": "sample string 2",
"sales_organization_id": "a9c87407-acf1-455f-8235-bbf6bd9483a5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-15T07:01:11.4236368+00:00",
"code": "sample string 7"
},
"job_priority_id": "49714a4d-ba7b-45ed-9d38-392a772292a8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2192db6b-e656-425c-827a-2400ec4f6065",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e9c78ad3-2b3d-4395-8a3a-7677a451235b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f63bf1df-1f1a-4ff0-95c2-352a5fd8bbbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e927f8eb-3ff2-4a24-9db5-b7c976f3811f",
"db_currency_id": "11f7bb19-de71-4c93-aeb4-6e17983f0b38",
"db_language_id": "8933475d-b5ba-4669-a427-93e2379506f7",
"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-07-15T07:01:11.4236368+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-15T07:01:11.4236368+00:00"
},
"job_status_id": "f2b9d6eb-cf83-4e1a-9202-843a9c438459",
"job_status_code": "sample string 11",
"db_address_id": "6d71bf69-98c1-4536-a8f4-542b318b4aa5",
"contact_id": "d48ddb41-cdac-4254-819d-37f55544c7b7",
"requested_by_company_id": "326df338-fd71-4c15-93a8-cda3415c081c",
"requested_by_contact_id": "44cabbfd-0ee2-4dc0-a3e1-7ffbd8cb1e9b",
"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-07-15T07:01:11.4236368+00:00",
"due_date": "2026-07-15T07:01:11.4236368+00:00",
"date_create": "2026-07-15T07:01:11.4236368+00:00",
"date_update": "2026-07-15T07:01:11.4236368+00:00",
"date_closed": "2026-07-15T07:01:11.4236368+00:00",
"suggested_user_id": "8b45fd1a-ac26-4c97-b43c-f55dd68f2f09",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "69c0fcc1-e04b-4cd4-8519-3fd4db2e7376",
"db_language_id": "0e999785-5399-46e3-b92e-ba6a213776f5",
"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-07-15T07:01:11.4236368+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2d7e181e-eefc-47a5-8395-d018f370cf71",
"sales_organization": {
"id": "f63bf1df-1f1a-4ff0-95c2-352a5fd8bbbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e927f8eb-3ff2-4a24-9db5-b7c976f3811f",
"db_currency_id": "11f7bb19-de71-4c93-aeb4-6e17983f0b38",
"db_language_id": "8933475d-b5ba-4669-a427-93e2379506f7",
"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-07-15T07:01:11.4236368+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2bfcdcbd-0999-4e07-99c2-c1a63f97f911",
"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": "e9d67441-e889-4bd4-bbef-8e60e81c8f57",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-15T07:01:11.4236368+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "db464fcf-62f5-46e0-bc8a-9b413e2b72ab"
},
"suggested_date_start": "2026-07-15T07:01:11.4236368+00:00",
"skill_id": "12f4bb77-64b6-4607-ae07-313e93c4bea7",
"skill_code": "sample string 32",
"skill": {
"id": "aba477e4-f25c-4d82-95ba-47d4a1041f0d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "60240d98-3b2c-42b7-bebc-b177e37a9add",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f63bf1df-1f1a-4ff0-95c2-352a5fd8bbbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e927f8eb-3ff2-4a24-9db5-b7c976f3811f",
"db_currency_id": "11f7bb19-de71-4c93-aeb4-6e17983f0b38",
"db_language_id": "8933475d-b5ba-4669-a427-93e2379506f7",
"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-07-15T07:01:11.4236368+00:00"
},
"modified_dateutc": "2026-07-15T07:01:11.4236368+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9d375f53-2a44-4ebc-a044-162da78ac084",
"date_reported_by_company": "2026-07-15T07:01:11.4236368+00:00",
"id2": 36,
"company_id": "5190767f-2f51-4a75-acb9-4789904c79e0",
"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": "37e594e3-322c-4f45-86b4-f4821aff51e1",
"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-07-15T07:01:11.4236368+00:00"
},
"work_instruction_details_id": "2fee1e46-54e3-4041-9cce-14e474f9b0cd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8429359d-bc1b-42ea-99f9-c2fdf1df5b74",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d82ffb0b-460f-4879-85d0-5af2bace838a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-15T07:01:11.4236368+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": "8dad49be-83f2-4898-9535-04ce82f82ce6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-15T07:01:11.4236368+00:00"
}