Unicat API Reference

Up - API Reference - Home

data queries

A query is a combination of search term and filters that can be used to search for assets, records, or schema elements (definitions, classes, and fields).

The returned dictionary with queries uses the global identifier (gid) as a key.

Query data

{
    …,
    "data": {
        "queries": {
            "e8ea6667-27f6-4ae9-8892-3d75edd1b3fb": {
                "gid": "e8ea6667-27f6-4ae9-8892-3d75edd1b3fb",
                "type": "schema",
                "name": "catalog",
                "q": "",
                "filter": ["and", "", [
                    ["is_committed", "is_true"],
                    ["validation", "not_translated"]
                ]]
            }
        }
    }
}

Query properties

gid global identifier
type 'asset', 'record', or 'schema'
name a user-defined name for the query
q a string of search words, like '+cms 225'
filter json with nested filter specification (see the basic workings of a filter)