Retrieve assets using a query

POST 
/asset/query

Retrieve assets using a query

Request

Header Parameters

Authorization string
X-Forwarded-Proto string
X-Forwarded-Host string

application/json

Body

recursive boolean

select

object

basic boolean
access string

Possible values: [PRIVATE, PROTECTED, PUBLIC]

ids string[]

names

object[]

Array [

match string

Possible values: [EXACT, BEGIN, END, CONTAINS]

caseSensitive boolean

value string

negate boolean

]

parents

object[]

Array [

id string

]

paths

object[]

Array [

path string[]

]

realm

object

name string
userIds string[]
types string[]

attributes

object

operator string

Possible values: [AND, OR]

items

object[]

Array [

name

object

match string

Possible values: [EXACT, BEGIN, END, CONTAINS]

caseSensitive boolean

value string

negate boolean

negated boolean

path object[]

value

object

predicateType stringrequired

meta

object[]

Array [

name

object

match string

Possible values: [EXACT, BEGIN, END, CONTAINS]

caseSensitive boolean

value string

negate boolean

negated boolean

path object[]

value

object

predicateType stringrequired

]

previousValue

object

predicateType stringrequired

]

groups undefined[]

orderBy

object

property string

Possible values: [CREATED_ON, FIRST_NAME, LAST_NAME, USERNAME, EMAIL]

descending boolean
limit int32

Responses

default

default response

application/json

Schema

Schema

• Array [

id string

Possible values: Value must match regular expression ^[0-9A-Za-z]{22}$

version int64
createdOn date-time
name stringrequired

Possible values: non-empty and <= 1023 characters

accessPublicRead boolean
parentId string

Possible values: Value must match regular expression ^[0-9A-Za-z]{22}$

realm stringrequired

Possible values: non-empty and <= 255 characters

type string
path string[]

attributes

object

delegate

object

property name*

AttributeObject

type

object

name string

Possible values: Value must match regular expression ^\w+(\[\])?$

constraints

object[]

Array [

message string

type stringrequired

]

format

object

useGrouping boolean

minimumIntegerDigits int32

minimumFractionDigits int32

maximumFractionDigits int32

minimumSignificantDigits int32

maximumSignificantDigits int32

asBoolean boolean

asDate boolean

asSlider boolean

resolution number

dateStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriod string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12 boolean

iso8601 boolean

weekday string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

era string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

year string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

month string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

week string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

day string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

minute string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

second string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigits int32

timeZoneName string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormat string

asNumber boolean

asOnOff boolean

asPressedReleased boolean

asOpenClosed boolean

asMomentary boolean

multiline boolean

units string[]

arrayDimensions int32

metaUseOnly boolean

jsonType string

name stringrequired

Possible values: Value must match regular expression ^\w+$

meta

object

delegate

object

property name*

MetaItemObject

type

object

name string

Possible values: Value must match regular expression ^\w+(\[\])?$

constraints

object[]

Array [

message string

type stringrequired

]

format

object

useGrouping boolean

minimumIntegerDigits int32

minimumFractionDigits int32

maximumFractionDigits int32

minimumSignificantDigits int32

maximumSignificantDigits int32

asBoolean boolean

asDate boolean

asSlider boolean

resolution number

dateStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriod string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12 boolean

iso8601 boolean

weekday string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

era string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

year string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

month string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

week string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

day string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

minute string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

second string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigits int32

timeZoneName string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormat string

asNumber boolean

asOnOff boolean

asPressedReleased boolean

asOpenClosed boolean

asMomentary boolean

multiline boolean

units string[]

arrayDimensions int32

metaUseOnly boolean

jsonType string

name stringrequired

Possible values: Value must match regular expression ^\w+$

property name*

MetaItemObject

type

object

name string

Possible values: Value must match regular expression ^\w+(\[\])?$

constraints

object[]

Array [

message string

type stringrequired

]

format

object

useGrouping boolean

minimumIntegerDigits int32

minimumFractionDigits int32

maximumFractionDigits int32

minimumSignificantDigits int32

maximumSignificantDigits int32

asBoolean boolean

asDate boolean

asSlider boolean

resolution number

dateStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriod string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12 boolean

iso8601 boolean

weekday string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

era string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

year string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

month string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

week string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

day string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

minute string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

second string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigits int32

timeZoneName string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormat string

asNumber boolean

asOnOff boolean

asPressedReleased boolean

asOpenClosed boolean

asMomentary boolean

multiline boolean

units string[]

arrayDimensions int32

metaUseOnly boolean

jsonType string

name stringrequired

Possible values: Value must match regular expression ^\w+$

timestamp int64

property name*

AttributeObject

type

object

name string

Possible values: Value must match regular expression ^\w+(\[\])?$

constraints

object[]

Array [

message string

type stringrequired

]

format

object

useGrouping boolean

minimumIntegerDigits int32

minimumFractionDigits int32

maximumFractionDigits int32

minimumSignificantDigits int32

maximumSignificantDigits int32

asBoolean boolean

asDate boolean

asSlider boolean

resolution number

dateStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriod string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12 boolean

iso8601 boolean

weekday string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

era string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

year string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

month string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

week string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

day string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

minute string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

second string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigits int32

timeZoneName string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormat string

asNumber boolean

asOnOff boolean

asPressedReleased boolean

asOpenClosed boolean

asMomentary boolean

multiline boolean

units string[]

arrayDimensions int32

metaUseOnly boolean

jsonType string

name stringrequired

Possible values: Value must match regular expression ^\w+$

meta

object

delegate

object

property name*

MetaItemObject

type

object

name string

Possible values: Value must match regular expression ^\w+(\[\])?$

constraints

object[]

Array [

message string

type stringrequired

]

format

object

useGrouping boolean

minimumIntegerDigits int32

minimumFractionDigits int32

maximumFractionDigits int32

minimumSignificantDigits int32

maximumSignificantDigits int32

asBoolean boolean

asDate boolean

asSlider boolean

resolution number

dateStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriod string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12 boolean

iso8601 boolean

weekday string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

era string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

year string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

month string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

week string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

day string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

minute string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

second string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigits int32

timeZoneName string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormat string

asNumber boolean

asOnOff boolean

asPressedReleased boolean

asOpenClosed boolean

asMomentary boolean

multiline boolean

units string[]

arrayDimensions int32

metaUseOnly boolean

jsonType string

name stringrequired

Possible values: Value must match regular expression ^\w+$

property name*

MetaItemObject

type

object

name string

Possible values: Value must match regular expression ^\w+(\[\])?$

constraints

object[]

Array [

message string

type stringrequired

]

format

object

useGrouping boolean

minimumIntegerDigits int32

minimumFractionDigits int32

maximumFractionDigits int32

minimumSignificantDigits int32

maximumSignificantDigits int32

asBoolean boolean

asDate boolean

asSlider boolean

resolution number

dateStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriod string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12 boolean

iso8601 boolean

weekday string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

era string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

year string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

month string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

week string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

day string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

minute string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

second string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigits int32

timeZoneName string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormat string

asNumber boolean

asOnOff boolean

asPressedReleased boolean

asOpenClosed boolean

asMomentary boolean

multiline boolean

units string[]

arrayDimensions int32

metaUseOnly boolean

jsonType string

name stringrequired

Possible values: Value must match regular expression ^\w+$

timestamp int64

• ]

Example (from schema)

[
  {
    "id": "string",
    "version": 0,
    "createdOn": "2024-07-29T15:51:28.071Z",
    "name": "string",
    "accessPublicRead": true,
    "parentId": "string",
    "realm": "string",
    "type": "string",
    "path": [
      "string"
    ],
    "attributes": {
      "delegate": {}
    }
  }
]

Loading...