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": "dd9ce414-dfec-405c-81df-20e6d19d5d6e",
"jobs_id": "45893f0e-ab6e-43f6-8796-2f75dd7199a4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fd9c5de2-1986-47a8-804a-e0419ee6a063",
"_parent_id": "9a68960a-a794-4d88-a611-42e150b6c20d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fe76b33c-208f-4c51-bf11-337697737785",
"project_reference_back_office": "sample string 5",
"project": {
"id": "05f1d712-083a-45b9-ac70-afb2612066aa",
"_parent_id": "a28e3296-19b8-4ad2-b62b-0f4ff8ae2b3e",
"root_parent_id": "e7411a64-2d98-455a-849b-942997103d22",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "069d10d8-fd0d-49f8-b3ca-a47cea4c7f8b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "39c1c56c-54fa-450b-92b9-4133198bbcea",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f1c9f6fc-28b2-481f-9685-2190f97b00d1",
"_parent_code": "sample string 6",
"sales_organization_id": "6d8f6b54-5be2-43dd-ba5b-0f270cb4cd64",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "08fe26ce-282e-4623-ae94-1103f8c3416f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95d222c2-0e38-42ea-9fa5-b8727e68926a",
"db_currency_id": "3bfb4897-aae6-42aa-b38c-8588fdea789d",
"db_language_id": "329abceb-a0f9-4a6d-bfcf-77b334b18d7e",
"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-10-23T15:16:24.2226862+00:00"
},
"modified_dateutc": "2026-10-23T15:16:24.2226862+00:00"
},
"equipment_model_id": "29ea5764-2c25-47ad-b65b-640aaeed75f2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4dca0787-4cdd-4424-81c5-8ea3b6007ee9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3c4593f1-c905-4008-a1e8-ea0cac390e6a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "cf7572e4-2600-4434-a59a-aee234d90b6a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "70aef13d-da1f-4a2f-9679-ff2688479c81",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "08fe26ce-282e-4623-ae94-1103f8c3416f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95d222c2-0e38-42ea-9fa5-b8727e68926a",
"db_currency_id": "3bfb4897-aae6-42aa-b38c-8588fdea789d",
"db_language_id": "329abceb-a0f9-4a6d-bfcf-77b334b18d7e",
"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-10-23T15:16:24.2226862+00:00"
},
"modified_dateutc": "2026-10-23T15:16:24.2226862+00:00"
},
"equipment_family_id": "e4ebee9a-3dc0-446b-b372-7efc4929fd43",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "39c1c56c-54fa-450b-92b9-4133198bbcea",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f1c9f6fc-28b2-481f-9685-2190f97b00d1",
"_parent_code": "sample string 6",
"sales_organization_id": "6d8f6b54-5be2-43dd-ba5b-0f270cb4cd64",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "08fe26ce-282e-4623-ae94-1103f8c3416f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95d222c2-0e38-42ea-9fa5-b8727e68926a",
"db_currency_id": "3bfb4897-aae6-42aa-b38c-8588fdea789d",
"db_language_id": "329abceb-a0f9-4a6d-bfcf-77b334b18d7e",
"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-10-23T15:16:24.2226862+00:00"
},
"modified_dateutc": "2026-10-23T15:16:24.2226862+00:00"
},
"date_in_production_since": "2026-10-23T15:16:24.2226862+00:00",
"date_out_of_production_since": "2026-10-23T15:16:24.2226862+00:00",
"date_end_support": "2026-10-23T15:16:24.2226862+00:00",
"sales_organization_id": "81f7b062-b2eb-465f-9730-706c55b634e1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "08fe26ce-282e-4623-ae94-1103f8c3416f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95d222c2-0e38-42ea-9fa5-b8727e68926a",
"db_currency_id": "3bfb4897-aae6-42aa-b38c-8588fdea789d",
"db_language_id": "329abceb-a0f9-4a6d-bfcf-77b334b18d7e",
"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-10-23T15:16:24.2226862+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-10-23T15:16:24.2425017+00:00"
},
"project_status_id": "506b19d3-f4ed-4347-997a-e4955114a479",
"project_status_code": "sample string 10",
"project_status": {
"id": "cc6c48ed-8699-4224-8cf4-d018ea5bd407",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f9f15a10-a938-4727-9aac-68219b7364b5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "08fe26ce-282e-4623-ae94-1103f8c3416f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95d222c2-0e38-42ea-9fa5-b8727e68926a",
"db_currency_id": "3bfb4897-aae6-42aa-b38c-8588fdea789d",
"db_language_id": "329abceb-a0f9-4a6d-bfcf-77b334b18d7e",
"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-10-23T15:16:24.2226862+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-23T15:16:24.2425017+00:00"
},
"company_id": "65a2629a-4119-4f1e-a788-699de2e3607d",
"company_code": "sample string 12",
"db_address_id": "f4fa7fe6-fc9d-47b5-9ede-b7ac10d46f1a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1c2631d6-192e-4293-8c3f-5e5dacbd6d3c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "13394111-a7d8-45ac-8a1e-bfe04730fb1b",
"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-10-23T15:16:24.2425017+00:00",
"date_create": "2026-10-23T15:16:24.2425017+00:00",
"date_update": "2026-10-23T15:16:24.2425017+00:00",
"updated_by_user_id": "06ebd0b3-8dcb-41dd-8ab5-93e6c79020bf",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-23T15:16:24.2425017+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-10-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-23T15:16:24.2425017+00:00",
"date_last_job": "2026-10-23T15:16:24.2425017+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-23T15:16:24.2425017+00:00",
"modified_dateutc": "2026-10-23T15:16:24.2425017+00:00",
"is_mobile_installation": true
},
"job_type_id": "abacc554-59e5-40b5-a4d0-f8776a335318",
"job_type_code": "sample string 7",
"job_type": {
"id": "681e6202-1e97-444e-8582-161c8a473b87",
"name": "sample string 2",
"sales_organization_id": "e2c2030f-a6b1-40aa-a354-8e620f21172c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-23T15:16:24.2425017+00:00",
"code": "sample string 7"
},
"job_priority_id": "8484bff9-e437-4d23-a4ce-a1c7d555dcf0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c5552ede-d50e-4175-801d-439521f60dd9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "24713fd1-7f4f-442d-a3de-5b57cdf9efeb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "08fe26ce-282e-4623-ae94-1103f8c3416f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95d222c2-0e38-42ea-9fa5-b8727e68926a",
"db_currency_id": "3bfb4897-aae6-42aa-b38c-8588fdea789d",
"db_language_id": "329abceb-a0f9-4a6d-bfcf-77b334b18d7e",
"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-10-23T15:16:24.2226862+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-23T15:16:24.2425017+00:00"
},
"job_status_id": "40360eef-861f-4234-8cae-7900447aafa4",
"job_status_code": "sample string 11",
"db_address_id": "e80de30a-cb4d-4dc4-8d8c-d0a1c3b56b4a",
"contact_id": "847fa9cf-082a-49e4-8c0b-8f4fdc0101e4",
"requested_by_company_id": "11202887-c2af-4474-8d47-12915f93559f",
"requested_by_contact_id": "66a19f87-2725-4ce4-864c-f8216a951b17",
"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-10-23T15:16:24.2425017+00:00",
"due_date": "2026-10-23T15:16:24.2425017+00:00",
"date_create": "2026-10-23T15:16:24.2425017+00:00",
"date_update": "2026-10-23T15:16:24.2425017+00:00",
"date_closed": "2026-10-23T15:16:24.2425017+00:00",
"suggested_user_id": "1724774e-c9f2-4a67-94c9-7286ddf3b9e2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a8efab63-570f-4df7-ad4c-b2df21ae4bf1",
"db_language_id": "45386841-6da9-48c7-9bea-f087ef13f532",
"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-10-23T15:16:24.2425017+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "68868963-8361-4389-b23f-121919247ffa",
"sales_organization": {
"id": "08fe26ce-282e-4623-ae94-1103f8c3416f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95d222c2-0e38-42ea-9fa5-b8727e68926a",
"db_currency_id": "3bfb4897-aae6-42aa-b38c-8588fdea789d",
"db_language_id": "329abceb-a0f9-4a6d-bfcf-77b334b18d7e",
"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-10-23T15:16:24.2226862+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d127282c-f0f5-4eea-ba5e-ab01ba299384",
"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": "25fce876-f298-4f88-91f6-e06cfffb5439",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-23T15:16:24.2425017+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "69d57473-642d-4b6c-a807-f30adb8b5cd6"
},
"suggested_date_start": "2026-10-23T15:16:24.2425017+00:00",
"skill_id": "7f568059-3bfc-4fef-94cb-9ff34fdb2353",
"skill_code": "sample string 32",
"skill": {
"id": "66ea0b68-a65c-40e4-b1c8-487b92e46e22",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0e75344f-b238-4510-8d1a-05b8e6319086",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "08fe26ce-282e-4623-ae94-1103f8c3416f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95d222c2-0e38-42ea-9fa5-b8727e68926a",
"db_currency_id": "3bfb4897-aae6-42aa-b38c-8588fdea789d",
"db_language_id": "329abceb-a0f9-4a6d-bfcf-77b334b18d7e",
"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-10-23T15:16:24.2226862+00:00"
},
"modified_dateutc": "2026-10-23T15:16:24.2533247+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0f97e139-3ff6-4c40-a173-b9ad83276791",
"date_reported_by_company": "2026-10-23T15:16:24.2533247+00:00",
"id2": 36,
"company_id": "5b300ede-15cd-4c16-a0a7-efdef42408cd",
"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": "3f78c7f6-ddf0-48c3-a6fc-f0c97c89df9c",
"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-10-23T15:16:24.2533247+00:00"
},
"work_instruction_details_id": "412aeba5-69de-4bfe-95fd-5787f9fdafa8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "788ec6fd-42ca-4a64-8026-00f3b86e2c02",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3f1b23b2-b310-4b38-b2bd-36a60167f2bc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-23T15:16:24.2533247+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": "bd872dba-8c12-4017-9dd5-c0c4ad551596",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-23T15:16:24.2533247+00:00"
}