v1

latestOpenAPI 3.0.32026-07-2659199427.5 KB
Rule Management

List rules

List all rules with optional filtering and pagination. Note that sorting applies to the rule's staging content only. Filtering applies OR logic, matching if either the staging or live content matches the filter. Use textSearchRelevance sort to sort by search relevance (cannot be combined with other sort parameters).

get/em-rules

Query parameters

searchQuerystring

Search query for text-based search (used with textSearchRelevance sort).

tagsstring[]

Filter by tags (OR logic).

groupsstring[]

Filter by rule groups (OR logic).

typesstring[]

Types of rules to filter by (OR logic).

publishState'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS'

Filter by publish state.

publishedboolean

Filter by published status.

targetedDocumentIdstring

Filter by targeted document ID (cannot be combined with other filters).

targetedDocumentIdFieldstring

Field name for targeted document search (defaults to id).

activeDateStartstring date-time

Filter by active date start (ISO 8601 date-time).

activeDateEndstring date-time

Filter by active date end (ISO 8601 date-time).

expirationDateStartstring date-time

Filter by expiration date start (ISO 8601 date-time).

expirationDateEndstring date-time

Filter by expiration date end (ISO 8601 date-time).

lastModifiedStartstring date-time

Filter by last modified start (ISO 8601 date-time).

lastModifiedEndstring date-time

Filter by last modified end (ISO 8601 date-time).

createdStartstring date-time

Filter by creation date start (ISO 8601 date-time).

createdEndstring date-time

Filter by creation date end (ISO 8601 date-time).

contentType'RULE' | 'QUERY_REWRITE'

Filter by content type.

pageinteger

Page number for pagination (zero-indexed).

sizeinteger

Number of items per page.

sortstring[]

Sort order in the format property,direction (e.g., createdDate,desc). Can specify multiple sort parameters.

fieldsstring[]

Optional additional fields to include in the response. Keep in mind that additional fields can slow the call and increase the response size.

Response

OK