Sign in
Assets

Delete assets by query

Changed on
delete/api/v1/{tenant}/assets/by-query

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/{tenant}/assets/by-query
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Path parameters

tenantstring required

Query parameters

field'QUERY' | 'SCOPE' | 'NAMESPACE' | 'KIND' | 'LABELS' | 'METADATA' | 'FLOW_ID' | 'FLOW_REVISION' | 'ID' | 'ASSET_ID' | 'TYPE' | 'CREATED' | 'UPDATED' | 'START_DATE' | 'END_DATE' | 'EXPIRATION_DATE' | 'STATE' | 'TIME_RANGE' | 'TRIGGER_EXECUTION_ID' | 'TRIGGER_ID' | 'TRIGGER_STATE' | 'EXECUTION_ID' | 'TASK_ID' | 'TASK_RUN_ID' | 'CHILD_FILTER' | 'WORKER_ID' | 'EXISTING_ONLY' | 'MIN_LEVEL' | 'PATH' | 'PARENT_PATH' | 'VERSION' | 'USERNAME'
operation'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'LESS_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN_OR_EQUAL_TO' | 'IN' | 'NOT_IN' | 'STARTS_WITH' | 'ENDS_WITH' | 'CONTAINS' | 'REGEX' | 'PREFIX'
valueobject

Filters

purgeboolean required

If true, will purge instead of soft-delete

Response

Number of deleted assets

countinteger

Example response

{
  "count": 0
}

Changes

  • b6097dbc46aeRevision changes
    • breaking

      added the new required query request parameter purge

    • info

      added the enum value EXPIRATION_DATE to the property items/field of the query request parameter filters

    • info

      added the enum value USERNAME to the property items/field of the query request parameter filters

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status