/
Retrieve draft rulesets

Retrieve draft rulesets

Request

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

Security
SecretApiKey or JWT
Path
eventTypestringrequired

Type of event.

Query
limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

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

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

qstring

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

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

fieldsstring

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

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/events/{eventType}/rules/drafts?limit=1000&offset=1000&filter=string&q=string&sort=string&fields=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Draft rulesets retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

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
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only

ID of the draft rule set.

Example:"rule_dft_0YVDN3FN43CEQ8CQ93Y0H00ZQ7"
baseVersioninteger, >= 0required

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.

bindsArray of objects(Bind)

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

rulesArray of objects(Rule)required

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.

authorobjectread-only

Author of the draft.

namestringrequired

Name of the draft.

descriptionstring

Detailed description of the drafted ruleset.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

]
Response
[
  {
    "id": "rule_dft_0YVDN3FN43CEQ8CQ93Y0H00ZQ7",
    "baseVersion": 0,
    "binds": [ … ],
    "rules": [ … ],
    "author": { … },
    "name": "string",
    "description": "string",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]