Skip to main content
POST
HTTP request

Authorizations

Authorization
string
header
required

An API key is a token that you provide when making API calls. Read more about how to secure your project.

Include the API key to the Authorization header, for instance:

If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:

Scopes

dynamicSearchRules.get
dynamicSearchRules.*
*.get
*

Body

application/json
offset
integer

Number of rules to skip. Defaults to 0.

Required range: x >= 0
limit
integer

Maximum number of rules to return. Default to 20.

Required range: x >= 0
filter
null | object

Optional filter to restrict which rules are returned (e.g. by attribute patterns or by properties like if the rule is active or not)

showTarget
boolean

Show the target state of the dynamic search rules.

  • Enabling this boolean adds additional information about the future state of the dynamic search rules in the response, such as whether there are pending dynamic search rules tasks or not.
  • Enabling this boolean requires the Enterprise Edition.

Response

Dynamic search rules are returned.

results
object[]
required

Rules for the current page.

offset
integer
required

Number of rules skipped.

Required range: x >= 0
limit
integer
required

Maximum number of rules returned in a single request.

Required range: x >= 0
total
integer
required

Total number of rules that match the filter.

Required range: x >= 0
totalRuleCount
integer | null

Total number of declared rules, including those that don't match the filter.

Returned when showTarget is present and set to true in the request.

Required range: x >= 0
targetTotalRuleCount
integer | null

Total number of declared rules after processing all pending tasks.

Returned when showTarget is present and set to true in the request.

Required range: x >= 0
needsProcessing
boolean | null

Whether the dynamic search rules have at least a pending task to process.

Returned when showTarget is present and set to true in the request.

taskUids
integer<u-int32>[] | null

The uids of the pending tasks to process.

Returned when showTarget is present and set to true in the request.

Required range: x >= 0