Retrieves a list of tags rules.
Retrieves a list of tags rules.
limit | integer [ 0 .. 1000 ] Limits the number of collection items to be returned. |
offset | integer [ 0 .. 1000 ] Specifies the starting point within the collection of items to be returned. |
sort | Array of strings Sorts and orders the collection of items. To sort in descending order, prefix with |
filter | string Filters the collection items. This field requires a special format. Use For more information, see Using filter with collections. |
q | string Use this field to perform a partial search of text fields. |
200
List of tags rules retrieved.
id | string <= 50 characters ID of the rule. |
name required | string Name of the rule. |
eventType required | string Type of event. |
filter | string or null Filter that determines whether to tag or untag. This field requires a special format. Use For more information, see Using filters. |
addTags required | Array of strings [ 0 .. 1000 ] items List of tags to add to the customer. |
removeTags required | Array of strings [ 0 .. 1000 ] items List of tags to remove for the customer. |
status | string Default: "active" Status of the rule. |
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 objects Related resource links. |
401
Unauthorized access. Invalid credentials used.
403
Access forbidden.
[ { "id": "tag_rule_0YVCEE5APAD7V84MK3P9CCJVYY", "name": "string", "eventType": "aml-list-possibly-matched", "filter": "string", "addTags": [ "string" ], "removeTags": [ "string" ], "status": "active", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { "href": "string", "rel": "self" } ] } ]