Query data from different KM records

Query Data for a Knowledge Model that is combining different Records

SecurityBearerAuth or ApiKeyAuth
Request
path Parameters
km_id
required
string
Example: open-purchase-requisition.purchase-requisition-km
query Parameters
filters
Array of strings

Predefined Knowledge Model filters to apply

Example: filters=active_incidents,cel_and_kpi
fields
Array of strings

Fields are composed from a list of record id "." field id in a knowledge model.

Example: fields=record.active,record.approval
page
integer >= 0
Default: 0

The page number of the result, starting by 0 (first page)

pageSize
integer >= 1
Default: 50

The number of items returned in a page.

sort
Array of strings

Defines the strategy for sorting. Must be a comma separated list of record_id "." field_id, and should start with "+" to apply ASC order or "-" to apply DESC order. Fields with no prefix will be sorted as ASC. Non existing records or fields in the header will throw an error.

Example: sort=+record.field1,-record.field2,record.field3
filterExpr
Array of strings

Dynamic filter expressions. Filters would be built by record_id "." field_id and the operation to apply.

Example: filterExpr=record.active eq 'true',record.approval not eq ‘'
options
Array of strings

Set different options to customize the data results for a query. Supported options

  • distinct: Enable the unique data results for a query
Example: options=distinct
kpis
Array of strings
Example: kpis=AVG_EVENTS_PER_CASE,FILTERED_COUNT
searchTerm
string

Expect an string to search by

searchPrecision
integer [ 1 .. 100 ]
Default: 10

Number value used to approximate the result of search

searchField
string

Parameter composed of record id "." field id

Example: searchField=MATERIALS.ACTIVITY
Responses
200

List of Record data

400

Bad Request.

401

Unauthorized access.

403

Forbidden.

404

The specified resource was not found

429

Too Many Requests.

500

Internal Server Error.

503

Service Unavailable.

get/api/knowledge-models/{km_id}/query
Request samples 
Response samples 
application/json
{
  • "content": [
    ],
  • "page": 0,
  • "pageSize": 50,
  • "total": 1,
  • "sort": [
    ]
}