Query Similar Items

get

/content/management/api/v1.1/items/{id}/similarItems

This resource enables searching for items similar to a given item. Supports both synchronous and asynchronous invocation.

Visual similarity is supported only for Images.
When not provided the query expression defaults to q=repositoryId eq "{repoId}" AND (fileGroup eq "Images").

Filter rules specific to Visual search:
repositoryId, if provided, should match the id of the repository to which the asset belongs.
type, if provided, should be DigitalAsset.
fileGroup, if provided, should be Images.
Any other values for the above fields will result in an error response.

Request

Path Parameters
Query Parameters
  • This parameter accepts channelToken of a channel and is used to control the returned results. The result will contain only items, targeted to the channel that the specified channelToken belongs to. This can also be achieved by specifying the channels (standard field of an item) contains query condition (channels co "{channelId}") as one of the query conditions in the q query parameter. This is an optional parameter and by default returns all the results.
  • Default search query expression, that matches values of the items across all fields.
  • This parameter is used to control the returned fields in each item in the result. This parameter accepts a comma-separated list of field names or all. These fields will be returned for each items in the result. All the field name are case-sensitive, and users must provide the correct field name in the query. All the user-defined field names should be provided with prefix fields and followed by period (.). When fields is specified as all (case-insensitive), all the standard fields are returned in case of query across types and in case of type specific query, all standard and user fields are returned. This parameter is optional in the query, and by default the result shows only standard fields name, description. The standard fields id, type are always returned irrespective of any field asked. Any incorrect or invalid field name given in the query will throw an error.

    Example: This returns standard fields name, user fields state and country of type Address in the search results.
    https://{cecsdomain}/content/management/api/v1.1/items?q=type eq "Address"&fields=fields.state,fields.country

    Example: This returns all the attributes for a specific type used in the search results.
    https://{cecsdomain}/content/management/api/v1.1/items?q=type eq "Address"&fields=all

    Example: This returns standard fields name, createdBy in the search results for all items across all the types.
    https://{cecsdomain}/content/management/api/v1.1/items?fields=name,createdBy

    Example: This returns all the standard fields in the search results for all items across all the types.
    https://{cecsdomain}/content/management/api/v1.1/items?fields=all
    Default Value: name,description
  • This parameter accepts a non negative integer and is used to control the size of the result.
    Default Value: 100
  • This parameter accepts a non negative integer and is used to control the start index of the result.
    Default Value: 0
  • This parameter accepts a query expression condition that matches the field values. Many such query conditions can be joined using AND/OR operators and grouped with parentheses. The value of query condition follows the format of {fieldName} {operator} "{fieldValue}". In case of query across type the field names are limited to standard fields (id, type, name, description, slug, translatable, language, createdBy, createdDate, updatedBy, updatedDate, repositoryId, status, channels, collections, tags, isPublished, languageIsMaster, taxonomies). However in case of type specific query the field names are limited to standard fields and user defined fields (except fields of largeText data type). The only values allowed in the operator are eq (Equals), co (Contains), sw (Startswith), ge (Greater than or equals to), le (Less than or equals to), gt (Greater than), lt (Less than), mt (Matches), sm (Similar).
    Example:
    https://{cecsdomain}/content/management/api/v1.1/items?q=(name eq "John")
    Example:
    https://{cecsdomain}/content/management/api/v1.1/items?q=(type eq "Employee" AND name eq "John")
    Example:
    https://{cecsdomain}/content/management/api/v1.1/items?q=(type eq "Employee" AND ((name eq "John" AND field.age ge "40") OR fields.weight gt "70"))
    Example:
    https://{cecsdomain}/content/management/api/v1.1/items?q=(taxonomies.categories.id eq "9E1A79EE600C4C4BB727FE3E39E95489" OR (taxonomies.categories.name co "cat" AND taxonomies.categories.name co "red"))
    Example:
    https://{cecsdomain}/content/management/api/v1.1/items?q=(taxonomies.categories.nodes.id eq "9E1A79EE600C4C4BB727FE3E39E95489" OR taxonomies.categories.nodes.name co "cars")
  • This parameter accepts a boolean flag. If specified as true, then the returned result must include the total result count.
    Default Value: false
Header Parameters
  • This parameter is used to control the interaction type (synchronous/asynchronous) of the request. If the header is provided with value respond-async, it indicates that asynchronous interaction is preferred. Otherwise, synchronous interaction is preferred. Asynchronous request is responded with 202 status with a status link in the location header. Synchronous request is responded with 200 along with response body.
    Allowed Values: [ "respond-async" ]
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : SearchItems
Type: object
Search Items
Show Source
Nested Schema : items
Type: array
Singular resources contained in the collection.
Show Source
Nested Schema : Item
Type: object
Item
Show Source
Nested Schema : ItemSubResourceListTaxonomyInfo
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListChannelId
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListCollectionId
Type: object
Item SubResource.
Show Source
Nested Schema : date
Type: object
date
Show Source
Nested Schema : fields
Type: object
Read Only: true
Additional Properties Allowed
Show Source
User-defined fields data. Map. All the user-defined fields required in the type definition must be provided under this property in PUT and POST request.
Nested Schema : ItemSubResourceListPublishInfo
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceRelationships
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListSuggestedTaxonomyInfo
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListTag
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListVariationsInfo
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListVersionInfo
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListWorkflowInfo
Type: object
Item SubResource.
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : TaxonomyInfo
Type: object
TaxonomyInfo
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : ChannelId
Type: object
ChannelId
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : CollectionId
Type: object
CollectionId
Show Source
Nested Schema : additionalProperties
Type: object
Nested Schema : data
Type: array
Show Source
Nested Schema : PublishInfo
Type: object
PublishInfo
Show Source
Nested Schema : Relationships
Type: object
Relationships
Show Source
Nested Schema : referencedBy
Type: array
Referenced by ids
Show Source
Nested Schema : references
Type: array
Reference ids
Show Source
Nested Schema : References
Type: object
References
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : SuggestedTaxonomyInfo
Type: object
SuggestedTaxonomyInfo
Show Source
Nested Schema : categories
Type: array
Categories in the Suggested Taxonomy the item belongs to.
Show Source
Nested Schema : ItemSuggestedCategoryInfo
Type: object
Show Source
Nested Schema : nodes
Type: array
Nodes in the category assigned to the item.
Show Source
Nested Schema : CategoryNodeBean
Type: object
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : Tag
Type: object
Tag.
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : VariationsInfo
Type: object
Variations Info.
Show Source
Nested Schema : items
Type: array
Content item variations.
Show Source
Nested Schema : Language
Type: object
LanguageItem
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : VersionInfo
Type: object
VersionInfo
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : WorkflowInfo
Type: object
WorkflowInfo.
Show Source

202 Response

Accepted.

304 Response

Not modified.

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

429 Response

Too Many Requests.

500 Response

Internal server error.
Back to Top