Summary
Search all Compliance Plan instances
Description
Gets a list of all Compliance Plan Instances that match the search criteria
Route
POST /configuration_manager/search/compliance_plan_instances
Roles
admin
apiread
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
searchParams |
object |
yes |
- |
Copied to Clipboard
{
"searchParams": {
"planName": "occaecat magna aute adipisicing nostrud",
"description": "ipsum laborum",
"status": "error",
"dateRange": [],
"start": 0,
"limit": 20,
"sort": {
"started": 1,
"jobStatus": -1,
"name": 1
}
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"searchParams": {
"title": "searchParams",
"type": "object",
"properties": {
"instanceId": {
"type": "string",
"description": "ID of the instance to fetch"
},
"planId": {
"type": "string",
"description": "Fetches all instances with this planId"
},
"planName": {
"type": "string",
"description": "Fetches all instances with this planName"
},
"description": {
"type": "string",
"description": "Filter by description of the plan instance.",
"example": [
"A description for my compliance plan."
]
},
"status": {
"type": "string",
"description": "Filter by status of the Job pertainig to the plan instance.",
"enum": [
"running",
"complete",
"paused",
"error",
"canceled"
]
},
"dateRange": {
"type": "array",
"description": "An array containing the start and end date. Index 0 = start date, index 1 = end date.",
"items": {}
},
"start": {
"type": "integer",
"minimum": 0,
"examples": [
0
]
},
"limit": {
"type": "integer",
"minimum": 1,
"examples": [
20
]
},
"sort": {
"type": "object",
"properties": {
"started": {
"enum": [
-1,
1
]
},
"jobStatus": {
"enum": [
-1,
1
]
},
"name": {
"enum": [
-1,
1
]
}
}
}
},
"oneOf": [
{
"required": [
"instanceId"
]
},
{
"required": [
"planId"
]
},
{
"required": [
"planName"
]
}
]
}
},
"required": [
"searchParams"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
compliancePlanInstances |
object |
List of Compliance Plan Instances that match the search criteria |
Copied to Clipboard
{
"totalCount": 45241472.48322162,
"groups": []
}
Copied to Clipboard
{
"title": "compliancePlanInstances",
"type": "object",
"properties": {
"totalCount": {
"type": "number"
},
"groups": {
"type": "array",
"items": {}
}
}
}