Skip to content

Scroll search for assets

Request

Asset scroll searches provide a means of scrolling one way through search results of any number of Asset resources.

Page size can stil be specified, but a scroll search will always proceed sequentially once through each page.

The AssetScrollSearch.scrollId in the search the response is used to continue the scroll search.

Security
bearerToken
Bodyapplication/jsonrequired
pageSizeinteger, [ 0 .. 1000 ]

The maximum number of items to return in the result set.

Default:100
Example:100
criterionanyrequired
sortsArray of objectsrequired

Sorts to be applied to the search in order of precedence

actionstring

Specifies the context in which the search is being run. For example if you only want to return Asset resources that the search User has permission to delete then set the action to be SEARCH_FOR_DELETE.

Default:"SEARCH_FOR_VIEW"
Enum:"SEARCH_FOR_CHANGE_LIFECYCLE_STATE_TO_PENDING_APPROVAL""SEARCH_FOR_CHANGE_LIFECYCLE_STATE_TO_LIVE""SEARCH_FOR_CHANGE_LIFECYCLE_STATE_TO_BINNED""SEARCH_FOR_DELETE""SEARCH_FOR_EDIT""SEARCH_FOR_PROMOTE_TO_LIVE""SEARCH_FOR_SEND_FOR_APPROVAL""SEARCH_FOR_VIEW"
Example:"SEARCH_FOR_VIEW"
curl -i -X POST \
  https://api-v2.dash.app/asset-scroll-searches \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "pageSize": 100,
    "criterion": {
      "type": "MATCH_ALL"
    },
    "sorts": [
      {
        "field": {
          "type": "FIXED",
          "fieldName": "DATE_LIVE"
        },
        "order": "DESC"
      }
    ]
  }'

Responses

Success

Bodyapplication/json
resultsArray of objectsrequired

The requested page of Asset resources which match the search criterion

totalResultsintegerrequired

The total number of Asset resources which match the search criterion

Example:1337
scrollIdstringrequired

The ID used to continue the AssetScrollSearch

Example:"58b0d88b-d0c9-47fc-9038-7195b234cc0b"
Response
{
  "results": [
    { … }
  ],
  "totalResults": 1337,
  "scrollId": "58b0d88b-d0c9-47fc-9038-7195b234cc0b"
}