List Validation Rules' Assignment(s)

List all validation rules' assignments or filter the results using the related object ID or the validation rule ID query parameters. ## How to retrieve specific validation rule assignments(s) ### Related object ID To find an assignment for a particular resource, you can use the ID of the object to which the validation rule was assigned. This could be, for example, an ID of a: voucher, campaign, distribution, reward assignment, earning rule, promotion tier. <!-- title: "Request" lineNumbers: true --> ```curl curl -X **GET** \ -H "X-App-Id: c70a6f00-cf91-4756-9df5-47628850002b" \ -H "X-App-Token: 3266b9f8-e246-4f79-bdf0-833929b1380c" \ -H "Content-Type: application/json" \ https://api.voucherify.io/v1/validation-rules-assignments?related_object_id=promo_kJliy076IuJYtuYWSHE9fSuT ``` <!-- title: "Response" lineNumbers: true --> ```json { "object": "list", "data_ref": "data", "data": [ { "id": "asgm_tZaqxeO8gP4q91jG", "rule_id": "val_WB6ETAiFztw5", "related_object_id": "promo_kJliy076IuJYtuYWSHE9fSuT", "related_object_type": "promotion_tier", "created_at": "2022-08-10T10:30:39.986Z", "object": "validation_rules_assignment" } ], "total": 1 } ``` ### Validation rule ID You can use the validation rule ID to find assignment(s) for a specific validation rule. <!-- title: "Request" lineNumbers: true --> ```curl curl -X **GET** \ -H "X-App-Id: c70a6f00-cf91-4756-9df5-47628850002b" \ -H "X-App-Token: 3266b9f8-e246-4f79-bdf0-833929b1380c" \ -H "Content-Type: application/json" \ https://api.voucherify.io/v1/validation-rules-assignments?rule=val_ZEZmA9oit8aU ``` <!-- title: "Response" lineNumbers: true --> ```json { "object": "list", "data_ref": "data", "data": [ { "id": "asgm_vef0G6d9Al0rABxq", "rule_id": "val_ZEZmA9oit8aU", "related_object_id": "camp_rRsfatlwN7unSeUIJDCYedal", "related_object_type": "campaign", "created_at": "2022-06-29T11:43:52.953Z", "object": "validation_rules_assignment" }, { "id": "asgm_sFV4wEFvldwIvgfb", "rule_id": "val_ZEZmA9oit8aU", "related_object_id": "distr_9QKI02wqgjWyvZXeQkFEPmkkYe", "related_object_type": "distribution", "created_at": "2022-06-29T11:41:07.680Z", "object": "validation_rules_assignment" }, { "id": "asgm_69Qifyv6UZynFIIQ", "rule_id": "val_ZEZmA9oit8aU", "related_object_id": "promo_g83qUzYZpfX0OMAFOVoQuOYG", "related_object_type": "promotion_tier", "created_at": "2022-06-29T11:29:41.906Z", "object": "validation_rules_assignment" } ], "total": 3 } ```

Authorizations

X-App-Id · string · header · required

X-App-Token · string · header · required

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

related_object_id · string

The resource ID to which the validation rule was assigned; this could be, for example, a resource ID of a voucher, campaign, earning rule, reward assignment, promotion tier, or distribution.

rule · string

Validation rule ID.

Example:

"val_TU4de3EP4dlL"

page · integer

Which page of results to return. The lowest value is 1.

Required range: 1 <= x <= 100

limit · integer

Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

Required range: 1 <= x <= 100

order · string

Sorts the results using one of the filtering options: -created_at, created_at, where the dash - preceding a sorting option means sorting in a descending order.

Response

200 - application/json

Returns a dictionary with a data property that contains an array of validation rule assignments. Each entry in the array is a separate object. If no more validation rule assignments are available, the resulting array will be empty. The result can be narrowed down according to default filters.

Response body for GET v1/validation-rules-assignments and GET v1/validation-rules/{validationRuleId}/assignments. Validation Rule Assignments List

object · string · default: list · required

The type of the object represented by JSON. This object stores information about validation rule assignments.

data_ref · string · default: data · required

Identifies the name of the JSON property that contains the array of validation rule assignments.

data · Validation Rule Assignment · object[] · required

A dictionary that contains an array of validation rule assignments.

Show child attributes

total · integer · required

Total number of validation rule assignments.