Field Selection

The /data endpoint allows API consumers to retrieve data for the following record objects:

  • Attributes
  • Augmented Attributes In order to do so, the ids of the objects to be retrieved must be listed as part of the fields query parameter:
  • fields: A comma-separated list of attribute, augmented attribute or flag ids for a given knowledge model record.

Note that:

  • fields is a mandatory query parameter.
  • The maximum number of objects per record that can be retrieved through the API Data endpoint is 200.
  • fields query parameter is case-sensitive. The object ids must match the object ids returned by the record. schema endpoint ( /knowledge-models/{km_id}/records/{record_id} ).
  • Each object id must be separated by a comma or alternatively, use the fields query parameter multiple times.

Example:

Copy
Copied
fields=ACTIVE,Category,APPROVAL or fields=ACTIVE&fields=Category&fields=APPROVAL

Distinct data rows

If your request returns duplicate rows, then the way to deduplicate is by using the parameter options=distinct

:warning: If a date field is included in the request: Please make sure to use ROUND_DAY in the PQL definition of the attribute in the Knowledge Model record !