Search Criteria reference¶
Search Criteria are filters for content and location search.
You use them over the REST API, in the Filter or Query element of the payload of the
POST /views request.
In the payload, the name of a Criterion has the Criterion suffix, for example, ContentIdCriterion.
Criteria that you provide in one Filter or Query element are combined with a logical AND.
To build more complex conditions, nest them in the AND,
OR, and NOT elements.
Criteria can take some of the following arguments:
target- when the Criterion supports targeting a specific field, example:FieldDefinitionor Metadata identifiervalue- the value(s) to filter on, typically a scalar or array of scalarsoperator- one ofIN,EQ,GT,GTE,LT,LTE,LIKE,BETWEEN,CONTAINS. Most Criteria don't expose this and selectEQorINdepending on whether the value is scalar or an array.INandBETWEENalways act on an array of values, while the other operators act on single scalar value
Search Criteria¶
| Search Criterion | Search based on | Content Search | Location Search | Filtering |
|---|---|---|---|---|
| Ancestor | Whether the content item is an ancestor of the provided location | ✔ | ✔ | ✔ |
| ContentId | Content item's ID | ✔ | ✔ | ✔ |
| ContentName | Content item's name | ✔ | ✔ | ✔ |
| ContentTypeGroupId | ID of the content item's content type group | ✔ | ✔ | ✔ |
| ContentTypeId | ID of the content item's content type | ✔ | ✔ | ✔ |
| ContentTypeIdentifier | Identifier of the content item's content type | ✔ | ✔ | ✔ |
| DateMetadata | The date when content was created or last modified | ✔ | ✔ | ✔ |
| Field | Content of one of content item's fields | ✔ | ✔ | |
| FullText | Full text content of a content item's fields | ✔ | ✔ | |
| Image | Image by specified image attributes | ✔ | ✔ | |
| ImageDimensions | Image dimensions: height and width | ✔ | ✔ | |
| ImageFileSize | Image size in MB | ✔ | ✔ | |
| ImageMimeType | Image type | ✔ | ✔ | |
| ImageOrientation | Image orientation | ✔ | ✔ | |
| IsBookmarked | Whether a location is added to a list of Favourites or not | ✔ | ✔ | |
| IsContainer | Whether a content item is a container (can contain other content items) | ✔ | ✔ | ✔ |
| IsUserEnabled | Whether a User account is enabled | ✔ | ✔ | ✔ |
| LanguageCode | Whether a content item is translated into the selected language | ✔ | ✔ | ✔ |
| LocationId | Location ID | ✔ | ✔ | ✔ |
| LocationRemoteId | Location remote ID | ✔ | ✔ | ✔ |
| ObjectStateId | Object state ID | ✔ | ✔ | ✔ |
| ObjectStateIdentifier | Object state Identifier | ✔ | ✔ | ✔ |
| ParentLocationId | Location ID of a content item's parent | ✔ | ✔ | ✔ |
| ParentLocationRemoteId | Location remote ID of a content item's parent | ✔ | ✔ | |
| RemoteId | Remote content ID | ✔ | ✔ | ✔ |
| SectionId | ID of the Section content is assigned to | ✔ | ✔ | ✔ |
| SectionIdentifier | Identifier of the Section content is assigned to | ✔ | ✔ | ✔ |
| Sibling | Locations that are children of the same parent | ✔ | ✔ | ✔ |
| Subtree | Location subtree | ✔ | ✔ | ✔ |
| UserEmail | Email address of a User account | ✔ | ✔ | ✔ |
| UserId | User ID | ✔ | ✔ | ✔ |
| UserLogin | User login | ✔ | ✔ | ✔ |
| UserMetadata | The creator or modifier of a content item | ✔ | ✔ | ✔ |
| Visibility | Whether the content item is visible or not | ✔ | ✔ | ✔ |
Logical operators¶
All Logical operators are supported by Content and Location Search.
| Search Criterion |
|---|
| LogicalAnd |
| LogicalNot |
| LogicalOr |