Retrieve draft rulesets

Retrieves a list of draft rulesets for a specified event type. The result are sorted by updated time in descending order.

SecuritySecretApiKey or JWT
Request
path Parameters
eventType
required
string

Type of event.

query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

q
string

Use this field to perform a partial search of text fields.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

fields
string

Limits the returned fields to the specified list, each field separated by a comma. The ID value is always returned.

expand
string

Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.

For more information, see Expand to include embedded objects.

Responses
200

Draft rulesets retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
required
Array of objects (Rule)

Rule can be configured to stop subsequent rules in the event list from being executed. A rule is a configuration of an event and one or more actions.

Array
name
required
string

Name of the rule.

required
Array of objects (RuleAction) unique

Actions that execute when an event occurs.

id
string <= 50 characters

ID of the rule.

labels
Array of strings unique

Labels of the rule.

status
string (OnOff)
Default: "active"
Enum: "active" "inactive"
filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

final
boolean
Default: true

Specifies whether the rule stops subsequent rules in the event list from being executed.

name
required
string

Name of the draft.

baseVersion
required
integer >= 0

Ruleset version on which the draft ruleset is based. Generally, a draft ruleset is cloned from an existing ruleset. Use this field to determine if the active ruleset changed since the draft creation. 0 denotes a draft ruleset that is not created from an existing ruleset. The value of this field is informational only, it is not assigned to the active ruleset.

id
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

Array of objects (Bind)

Binds always execute, regardless of rule based events. A rule is a configuration of an event and one or more actions.

Array
name
required
string

Name of the rule.

required
Array of objects (RuleAction) unique

Actions that execute when an event occurs.

id
string <= 50 characters

ID of the rule.

labels
Array of strings unique

Labels of the rule.

status
string (OnOff)
Default: "active"
Enum: "active" "inactive"
filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

object

Author of the draft.

id
string <= 50 characters

Author's user ID.

name
string

Author's first and last name.

description
string

Detailed description of the drafted ruleset.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of LinkSelf (object) or LinkUser (object)

Related links.

Array
Any of:
rel
required
string

Type of link.

Value: "self"
href
required
string

Link URL.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/events/{eventType}/rules/drafts
Request samples
Response samples
application/json
[
  • {
    }
]