Skip to main content

SearchAssetsRequest

search objectrequired
asset object
uidstring
externalIds object
property name*string
parent object
uidstring
externalIds object
property name*string
parentRecursive object
uidstring
externalIds object
property name*string
child object
uidstring
externalIds object
property name*string
name object
equalsstring[]

Exact matching

matchesstring[]

Regex matching

type object
equalsstring[]

Exact matching

matchesstring[]

Regex matching

includeDeletedboolean

If false or undefined only returns non deleted assets. If true also includes deleted assets

updatedAtAfterstring

Filter on assets updated after this date

representations object
isPresentbooleanrequired

Filter on assets having or not a representation. true: Only assets with representation. false: Only assets without representation. If not specified, return both assets having or not a representation

paginate objectrequired

Size is set to 50 by default

sizeinteger<int32>

Number of results

Possible values: <= 2000

Default value: 50
cursorstring

A marker indicating the position in a dataset, used to determine where to continue fetching results in paginated data

Default value: 0
fieldsstring[]required

Fields to include in the response, in addition to uid which is always included. Allowed values are: uid, name, updatedAt, deletedAt, type, externalIds, representations, parent.

Example: ['name', 'type']
properties object
simplestring[]required
SearchAssetsRequest
{
  "search": {
    "asset": {
      "uid": "string",
      "externalIds": {}
    },
    "parent": {
      "uid": "string",
      "externalIds": {}
    },
    "parentRecursive": {
      "uid": "string",
      "externalIds": {}
    },
    "child": {
      "uid": "string",
      "externalIds": {}
    },
    "name": {
      "equals": [
        "string"
      ],
      "matches": [
        "string"
      ]
    },
    "type": {
      "equals": [
        "string"
      ],
      "matches": [
        "string"
      ]
    },
    "includeDeleted": true,
    "updatedAtAfter": "string",
    "representations": {
      "isPresent": true
    }
  },
  "paginate": {
    "size": 50,
    "cursor": "0"
  },
  "fields": "['name', 'type']",
  "properties": {
    "simple": [
      "string"
    ]
  }
}