Retrieve a selection by pool and definition

Request

Retrieves selection items for a given selection pool.

Note

At least one of the following must be provided. If both are provided, the route parameter takes precedence:

definitionName (route parameter) - single definition name.
definitionNames (query parameter) - comma-separated list of definition names; for example, GET /api/selection/AssetSelectionPool?definitionNames=M.Asset,M.Content.

Security

OAuth2.0

Path

selectionPoolstringrequired

Selection pool identifier

definitionNamestringrequired

Single definition name

Query

definitionNamesstring

Comma-separated list of definition names

Example:definitionNames=M.Asset,M.Content

subPoolIdinteger, (int64)

Optional sub-pool identifier for scoped selections

ignorePermissionsboolean

Skip permission calculation for faster response

Default:false

If-Modified-Sincestring, (date-time)

Conditional request support (not currently implemented)

curl -i -X GET \
  'https://your-server/api/selection/{selectionPool}/{definitionName}?definitionNames=M.Asset%2CM.Content&subPoolId=0&ignorePermissions=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'If-Modified-Since: 2019-08-24T14:15:22Z'

Responses

Selection retrieved successfully

Bodyapplication/json

property name*object(SelectionResult)additional property

Response

{
  "M.Asset": {
    "items": [ … ],
    "permissions": [ … ],
    "link": { … }
  }
}