/
Retrieve a draft ruleset

Retrieve a draft ruleset

Request

Retrieves a draft ruleset with a specified ID and event type.

Security
SecretApiKey or JWT
Path
eventTypestringrequired

Type of event.

idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

Query
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/{id}?fields=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Draft ruleset retrieved.

Bodyapplication/json
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": {
    "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
    "name": "string"
  },
  "name": "string",
  "description": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}