Get a list of KM Record data with advanced filtering

Query Data for a Record in the Knowledge Model. This endpoint allows clients to easily include more complicated queries.

SecurityBearerAuth or ApiKeyAuth

Request

path Parameters

km_id required	string Example: open-purchase-requisition.purchase-requisition-km
record_id required	string Example: MATERIALS

Request Body schema: application/json

required

object (KmRecordDataRequestProjection)

Defines the parameters related to the query to be executed against the Knowledge Model Record.

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.

post/intelligence/api/knowledge-models/{km_id}/records/{record_id}/data

Request samples

application/json

{"projection": {"fields": "material_name,material_number,material_group",
"filters": {"kmFilterNames": ["filter1",
"filter2",
"filter3"
],
"filterExpr": ["active eq true and name ne 'John Doe'"
]
},
"pagination": {"pageNumber": 0,
"pageSize": 50
},
"sort": "+field1,-field2,+field3",
"options": ["distinct"
],
"search": {"term": "tot_revenue",
"field": "revenue",
"precision": 10
}
}
}

Response samples

application/json

{"content": {"headers": [{"id": "material_name",
"name": "Material name",
"type": "string",
"format": "",
"unit": "",
"aggregation": "false",
"filterable": "true",
"sortable": "true"
},
{"id": "material_number",
"name": "Material number",
"type": "string",
"format": "",
"unit": "",
"aggregation": "false",
"filterable": "true",
"sortable": "true"
},
{"id": "material_group",
"name": "Material group",
"type": "string",
"format": "",
"unit": "",
"aggregation": "false",
"filterable": "true",
"sortable": "true"
}
],
"data": [[{"material_name": "PC Installation / Configuration",
"material_number": "I-1000",
"material_group": "Services"
}
]
]
},
"page": 0,
"pageSize": 50,
"total": 1,
"sort": ["material_number"
]
}