GET | /Consumer/Policy/Changes | Minimum API version 5.1 Returns the list of changes that will be deployed in case a policy Deployment is requested at this time. | Requires 'Execute' permission on 'PolicyDeployment' securable type |
POST | /Consumer/Policy | Initiates Policy deployment. | Requires 'Execute' permission on 'PolicyDeployment' securable type |
POST | /Consumer/Policy/Responses/{ruleId} | Returns responses to a Policy for a specific Rule. Results can be filtered and sorted, they can also be retrieved in batches. Minimum information required in the request payload {
"PageSize":20,
"Start":"0;0"
}Apart from the minimum required you can see in the example above, the request can contain other fields: Filter - filter expression. If null then no filter is applied. Searchable columns depends of schema. To learn about how to define filter check Using scope and filter expressions page. Pagesize - number of results to fetch. Start - starting index to support pagination. For the first page it has to be unencoded 0;0 and for the subsequent page it has to be the value returned as the encoded Range value passed back by the previous page request. You will get a base64 encoded string containing something like “1;4,2;2” which is a comma separated list of pairs of ShardId;ResponseId. Sort - Defines sorting parameters. Data is sorted after it is filtered but before it is paginated. More on sorting can be found on Sort Definition page. ClobDefaultReadSize - Number of characters to which a CLOB type field will be truncated. If this value is not provided a global value configured in GlobalSettings will be used. Please see Instruction Definition Reference#SchemaJson page for detailsSchemaJson
| Requires 'Read' permission on 'GuaranteedState' securable type |
POST | /Consumer/Policy/Responses/Search | Returns responses to policies. Results can be filtered and sorted, they can also be retrieved in batches. Request payload has the same fields as in the request above. | Requires 'Read' permission on 'GuaranteedState' securable type |
POST | /Consumer/Policy/Responses/{policyId:int}/Search | Return responses to a specific policy. Results can be filtered and sorted, they can also be retrieved in batches. | Requires 'Read' permission on 'GuaranteedState' securable type |
GET | /Consumer/Policy/Dashboard/DeviceStatus | Returns dashboard device status | Requires 'Read' permission on 'GuaranteedState' securable type |
GET | /Consumer/Policy/Dashboard/DeviceStatus/{id} | Returns dashboard device status for a given policy | Requires 'Read' permission on 'GuaranteedState' securable type |
GET | /Consumer/Policy/Dashboard/DeviceStatusByCriticality | Returns dashboard device status by criticality | Requires 'Read' permission on 'GuaranteedState' securable type |
GET | /Consumer/Policy/Dashboard/DeviceStatusByCriticality/{id} | Returns dashboard device status by criticality for a given policy id | Requires 'Read' permission on 'GuaranteedState' securable type |
GET | /Consumer/Policy/Dashboard/PolicyRuleStatus | Returns dashboard policy rule status | Requires 'Read' permission on 'GuaranteedState' securable type |
GET | /Consumer/Policy/Dashboard/PolicyRuleStatus/{id} | Returns dashboard policy rule status for a given policy id | Requires 'Read' permission on 'GuaranteedState' securable type |
GET | /Consumer/Policy/Dashboard/PolicyEffectiveness | Returns dashboard with policy effectiveness | Requires 'Read' permission on 'GuaranteedState' securable type |
GET | /Consumer/Policy/Dashboard/PolicyEffectiveness/{id} | Returns dashboard with policy effectiveness for a given policy id | Requires 'Read' permission on 'GuaranteedState' securable type |
GET | /Consumer/Policy/Dashboard/ PolicyRuleRemediation/{days} | Returns dashboard device status in the last X days | Requires 'Read' permission on 'GuaranteedState' securable type |
GET | /Consumer/Policy/Dashboard/ PolicyRuleRemediation/{days}/{id} | Returns dashboard device status for a given policy id | Requires 'Read' permission on 'GuaranteedState' securable type |
POST | /Consumer/Policy/View/PolicyStatus/Search | Returns filtered and sorted policy statuses. Filter - filter expression. If null then no filter is applied. Searchable columns depends of schema. To learn about how to define filter check Using scope and filter expressions page. Pagesize - number of results to fetch. Start - starting index to support pagination. For the first page it has to be unencoded 0;0 and for the subsequent page it has to be the value returned as the encoded Range value passed back by the previous page request. You will get a base64 encoded string containing something like “1;4,2;2” which is a comma separated list of pairs of ShardId;ResponseId. Sort - Defines sorting parameters. Data is sorted after it is filtered but before it is paginated. More on sorting can be found on Sort Definition page.
| Requires 'Read' permission on 'GuaranteedState' securable type |
POST | /Consumer/Policy/View/DevicePolicyRuleStatus/Search | Returns filtered and sorted policy rule status Filter - filter expression. If null then no filter is applied. Searchable columns depends of schema. To learn about how to define filter check Using scope and filter expressions page. Pagesize - number of results to fetch. Start - starting index to support pagination. For the first page it has to be unencoded 0;0 and for the subsequent page it has to be the value returned as the encoded Range value passed back by the previous page request. You will get a base64 encoded string containing something like “1;4,2;2” which is a comma separated list of pairs of ShardId;ResponseId. Sort - Defines sorting parameters. Data is sorted after it is filtered but before it is paginated. More on sorting can be found on Sort Definition page.
| Requires 'Read' permission on 'GuaranteedState' securable type |
POST | /Consumer/Policy/View/DevicePolicyRuleStatus/ policyid/{policyId}/Search | Returns filtered and sorted policy rule status Filter - filter expression. If null then no filter is applied. Searchable columns depends of schema. To learn about how to define filter check Using scope and filter expressions page. Pagesize - number of results to fetch. Start - starting index to support pagination. For the first page it has to be unencoded 0;0 and for the subsequent page it has to be the value returned as the encoded Range value passed back by the previous page request. You will get a base64 encoded string containing something like “1;4,2;2” which is a comma separated list of pairs of ShardId;ResponseId. Sort - Defines sorting parameters. Data is sorted after it is filtered but before it is paginated. More on sorting can be found on Sort Definition page.
| Requires 'Read' permission on 'GuaranteedState' securable type |
POST | /Consumer/Policy/View/PolicyRuleStatus/Search | Returns filtered and sorted rules status Filter - filter expression. If null then no filter is applied. Searchable columns depends of schema. To learn about how to define filter check Using scope and filter expressions page. Pagesize - number of results to fetch. Start - starting index to support pagination. For the first page it has to be unencoded 0;0 and for the subsequent page it has to be the value returned as the encoded Range value passed back by the previous page request. You will get a base64 encoded string containing something like “1;4,2;2” which is a comma separated list of pairs of ShardId;ResponseId. Sort - Defines sorting parameters. Data is sorted after it is filtered but before it is paginated. More on sorting can be found on Sort Definition page.
| Requires 'Read' permission on 'GuaranteedState' securable type |
POST | /Consumer/Policy/View/PolicyRuleStatus/ policyid/{policyId}/Search | Returns filtered and sorted rules status Filter - filter expression. If null then no filter is applied. Searchable columns depends of schema. To learn about how to define filter check Using scope and filter expressions page. Pagesize - number of results to fetch. Start - starting index to support pagination. For the first page it has to be unencoded 0;0 and for the subsequent page it has to be the value returned as the encoded Range value passed back by the previous page request. You will get a base64 encoded string containing something like “1;4,2;2” which is a comma separated list of pairs of ShardId;ResponseId. Sort - Defines sorting parameters. Data is sorted after it is filtered but before it is paginated. More on sorting can be found on Sort Definition page.
| Requires 'Read' permission on 'GuaranteedState' securable type |
POST | /Consumer/Policy/View/PolicyRuleStatus/ tachyonguid/{guid}/Search | Returns filtered and sorted rules for given device Filter - filter expression. If null then no filter is applied. Searchable columns depends of schema. To learn about how to define filter check Using scope and filter expressions page. Pagesize - number of results to fetch. Start - starting index to support pagination. For the first page it has to be unencoded 0;0 and for the subsequent page it has to be the value returned as the encoded Range value passed back by the previous page request. You will get a base64 encoded string containing something like “1;4,2;2” which is a comma separated list of pairs of ShardId;ResponseId. Sort - Defines sorting parameters. Data is sorted after it is filtered but before it is paginated. More on sorting can be found on Sort Definition page.
| Requires 'Read' permission on 'GuaranteedState' securable type |
POST | /Consumer/Policy/View/PolicyRuleStatus/ policyid/{policyId}/tachyonguid/{guid}/Search | Returns filtered and sorted rules for given device Filter - filter expression. If null then no filter is applied. Searchable columns depends of schema. To learn about how to define filter check Using scope and filter expressions page. Pagesize - number of results to fetch. Start - starting index to support pagination. For the first page it has to be unencoded 0;0 and for the subsequent page it has to be the value returned as the encoded Range value passed back by the previous page request. You will get a base64 encoded string containing something like “1;4,2;2” which is a comma separated list of pairs of ShardId;ResponseId. Sort - Defines sorting parameters. Data is sorted after it is filtered but before it is paginated. More on sorting can be found on Sort Definition page.
| Requires 'Read' permission on 'GuaranteedState' securable type |
POST | /Consumer/Policy/View/DevicePolicyRuleStatus/ ruleid/{ruleId}/Search | Returns filtered and sorted device rules Filter - filter expression. If null then no filter is applied. Searchable columns depends of schema. To learn about how to define filter check Using scope and filter expressions page. Pagesize - number of results to fetch. Start - starting index to support pagination. For the first page it has to be unencoded 0;0 and for the subsequent page it has to be the value returned as the encoded Range value passed back by the previous page request. You will get a base64 encoded string containing something like “1;4,2;2” which is a comma separated list of pairs of ShardId;ResponseId. Sort - Defines sorting parameters. Data is sorted after it is filtered but before it is paginated. More on sorting can be found on Sort Definition page.
| Requires 'Read' permission on 'GuaranteedState' securable type |
POST | /Consumer/Policy/View/DevicePolicyRuleStatus/ policyid/{policyId}/ruleid/{ruleId}/Search | Returns filtered and sorted device rules Filter - filter expression. If null then no filter is applied. Searchable columns depends of schema. To learn about how to define filter check Using scope and filter expressions page. Pagesize - number of results to fetch. Start - starting index to support pagination. For the first page it has to be unencoded 0;0 and for the subsequent page it has to be the value returned as the encoded Range value passed back by the previous page request. You will get a base64 encoded string containing something like “1;4,2;2” which is a comma separated list of pairs of ShardId;ResponseId. Sort - Defines sorting parameters. Data is sorted after it is filtered but before it is paginated. More on sorting can be found on Sort Definition page.
| Requires 'Read' permission on 'GuaranteedState' securable type |
POST | /Consumer/Policy/View/DevicePolicyPolicyStatus/ policyid/{policyId}/Search | Returns filtered and sorted policy device from policy status Filter - filter expression. If null then no filter is applied. Searchable columns depends of schema. To learn about how to define filter check Using scope and filter expressions page. Pagesize - number of results to fetch. Start - starting index to support pagination. For the first page it has to be unencoded 0;0 and for the subsequent page it has to be the value returned as the encoded Range value passed back by the previous page request. You will get a base64 encoded string containing something like “1;4,2;2” which is a comma separated list of pairs of ShardId;ResponseId. Sort - Defines sorting parameters. Data is sorted after it is filtered but before it is paginated. More on sorting can be found on Sort Definition page.
| Requires 'Read' permission on 'GuaranteedState' securable type |
POST | /Consumer/Policy/View/PolicyRulePolicyDeviceStatus/ policyid/{policyId}/tachyonguid/{guid}/Search | Returns filtered and sorted policy rule device and policy status Filter - filter expression. If null then no filter is applied. Searchable columns depends of schema. To learn about how to define filter check Using scope and filter expressions page. Pagesize - number of results to fetch. Start - starting index to support pagination. For the first page it has to be unencoded 0;0 and for the subsequent page it has to be the value returned as the encoded Range value passed back by the previous page request. You will get a base64 encoded string containing something like “1;4,2;2” which is a comma separated list of pairs of ShardId;ResponseId. Sort - Defines sorting parameters. Data is sorted after it is filtered but before it is paginated. More on sorting can be found on Sort Definition page.
| Requires 'Read' permission on 'GuaranteedState' securable type |