# Retrieve a draft ruleset

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

Endpoint: GET /events/{eventType}/rules/drafts/{id}
Version: latest
Security: SecretApiKey, JWT

## Path parameters:

  - `eventType` (string, required)
    Type of event.

  - `id` (string, required)
    ID of the resource.

## Query parameters:

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

## Response 200 fields (application/json):

  - `id` (string)
    ID of the draft rule set.
    Example: "rule_dft_0YVDN3FN43CEQ8CQ93Y0H00ZQ7"

  - `baseVersion` (integer, required)
    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.
 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.

  - `binds` (array)
    Binds always execute, regardless of rule based events.
A rule is a configuration of an event and one or more actions.

  - `binds.id` (string)
    Unique resource ID.
    Example: "4f6cf35x-2c4y-483z-a0a9-158621f77a21"

  - `binds.name` (string, required)
    Name of the rule.

  - `binds.labels` (array)
    Labels of the rule.
    Example: ["test-rule","category:foo"]

  - `binds.status` (string)
    Status of the rule.
    Enum: "active", "inactive"

  - `binds.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](https://www.rebilly.com/docs/dev-docs/search-filters).

  - `binds.actions` (array, required)
    Actions that execute when an event occurs.

  - `binds.actions.name` (string, required)
    Name of the action.
    Enum: "abandon-scheduled-payments", "add-risk-score", "adjust-ready-to-pay", "blocklist", "cancel-scheduled-payments", "create-intuit-quickbooks-balance-transaction-entry", "create-intuit-quickbooks-invoice", "create-intuit-quickbooks-payment", "create-intuit-quickbooks-refund-receipt", "create-intuit-quickbooks-revenue-recognition-entry", "create-keap-infusionsoft-order", "create-keap-infusionsoft-payment", "decline-transaction", "check-ontario-restriction", "display-other-choices", "guess-payment-card-expiration", "perform-experian-check", "pick-gateway-account", "remove-reminder", "request-kyc", "reset-reminder", "schedule-invoice-retry", "schedule-payment", "schedule-reminder", "send-email", "stop-subscriptions", "tag-or-untag-customer", "update-intuit-quickbooks-invoice", "void-intuit-quickbooks-invoice"

  - `binds.actions.status` (string)
    Status of the action.
    Enum: "active", "inactive"

  - `rules` (array, 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.

  - `rules.final` (boolean)
    Specifies if the rule stops subsequent rules in the event list from being executed.

  - `author` (object)
    Author of the draft.

  - `author.name` (string)
    Author's first and last name.

  - `name` (string, required)
    Name of the draft.

  - `description` (string)
    Detailed description of the drafted ruleset.

  - `createdTime` (string)
    Date and time which is set automatically when the resource is created.

  - `updatedTime` (string)
    Date and time which updates automatically when the resource is updated.

  - `_links` (array)
    Related links.

  - `_links.href` (string)
    Link URL.

  - `_links.rel` (string)
    Type of link.
    Enum: "self", "user"

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 404 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.