Sitecore API catalog/Selection API/
/
Create a selection

Create a selection

Request

Creates a selection using one of the following modes:

  • Mode 1 Direct Entity IDs - use this mode when you know the specific entity IDs to add.
  • Mode 2 Query-Based Selection - use this mode to select entities based on search criteria. The system executes the query and adds matching entities.

Query types are case-insensitive (for example, BASIC, basic, Basic). You can create queries that include various parameters.

Note
If values is provided and non-empty, it takes precedence and query is ignored.

Security
OAuth2.0
Bodyapplication/jsonrequired
selectionPoolstringrequired
valuesArray of integers
typestring

Query type (e.g. "basic")

querystring
definitionNamestring
subPoolIdinteger, (int64)
ignorePermissionsboolean
Default:false
curl -i -X POST \
  https://your-server/api/selection \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "values": [
      1234,
      5678,
      9012
    ],
    "selectionPool": "AssetSelectionPool",
    "definitionName": "M.Asset",
    "subPoolId": 123,
    "ignorePermissions": false
  }'

Responses

Selection created

Headers
Locationstring

URI to retrieve the selection

Bodyapplication/json
itemsArray of integers
permissionsArray of strings
Response
{
  "items": [
    0
  ],
  "permissions": [
    "string"
  ],
  "link": {
    "href": "string",
    "type": "string"
  }
}