Summary
Search all Compliance Plans
Description
Gets a list of all Compliance Plans that match the search criteria
Route
POST /configuration_manager/search/compliance_plans
Roles
admin
apiread
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
name |
string |
yes |
Name of the compliance plan(s) |
options |
object |
yes |
- |
Copied to Clipboard
{
"name": "deserunt qui anim proident do",
"options": {
"start": 0,
"limit": 20,
"sort": 62463331.15729171
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"name": {
"title": "name",
"type": "string"
},
"options": {
"title": "options",
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"examples": [
0
]
},
"limit": {
"type": "integer",
"minimum": 1,
"examples": [
20
]
},
"sort": {
"type": "number",
"example": 1
}
},
"required": [
"start",
"limit"
]
}
},
"required": [
"name",
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
compliancePlans |
object |
List of Compliance Plans that match the search criteria |
Copied to Clipboard
{
"totalCount": -67654422.39779036,
"groups": []
}
Copied to Clipboard
{
"title": "compliancePlans",
"type": "object",
"properties": {
"totalCount": {
"type": "number"
},
"groups": {
"type": "array",
"items": {}
}
}
}