Rule Set
Summary
Rule Set maintains a mapping between a unique rule-set alias (alias), and a list of filters (filter) to apply to the requested manifest. Invoked via rule-set filter|
Definition
| Name | Schema | Comments |
|---|---|---|
| ID | integer | unique auto-generated record-ID |
| Alias | string | unique alphanumeric code to be used to invoke rule-set filter |
| Filter | string | URI path-separator delimited list of filters, as could be passed in as the URI, i.e. v-f(dvh,hdr)/l(EN,ES) |
| Name | string (optional) | Human-readable description of the rule, such as “Roku Device Filter” or “MX Language/Geo” |
| Global | boolean (optional) | globally applied if set to true |
REST Operations
GET rule-set/<resourceId>
Return rule-set resource identified by resourceId
GET rule-set?<query-parameters>
Return rule-set resources identified by query paramters:
Query Parameters:
| parameter | type | default | comments |
|---|---|---|---|
| page | integer | 0 | zero indexed page of results to return (optional) |
| page_size | integer | items-per-page to return (required) | |
| alias_prefix | string | alias-prefix to match (optional) | |
| alias | string | exact alias to match (optional) | |
| global | boolean | false | globally applied if set to true |
PUT rule-set/<resourceId>
Update rule-set resource idientied by resourceId
JSON body parameters:
| Name | Schema | Comments |
|---|---|---|
| alias | string | unique alphanumeric code to be used to invoke rule-set filter |
| filter | string | URI path-separator delimited list of filters, as could be passed in as the URI, i.e. v-f(dvh,hdr)/l(EN,ES) |
| name | string (optional) | Human-readable description of the rule, such as “Roku Device Filter” or “MX Language/Geo” |
| global | boolean (optional) | globally applied if set to true |
POST rule-set
Create new rule-set resource
JSON body parameters:
| Name | Schema | Comments |
|---|---|---|
| alias | string | unique alphanumeric code to be used to invoke rule-set filter |
| filter | string | URI path-separator delimited list of filters, as could be passed in as the URI, i.e. v-f(dvh,hdr)/l(EN,ES) |
| name | string (optional) | Human-readable description of the rule, such as “Roku Device Filter” or “MX Language/Geo” |
| global | boolean (optional) | globally applied if set to true |
DELETE
Delete rule-set resource idientied by resourceId