Summary
Import compliance plan documents
Description
Insert compliance plan documents into the ucm_compliance_plans collection
Route
POST /configuration_manager/import/plans
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
plans |
array |
yes |
Array of compliance plans |
Copied to Clipboard
{
"plans": [
{
"_id": "aute in non esse",
"name": "consectetur ex",
"description": "pariatur qui",
"nodes": [
{
"treeId": "dolor",
"version": "sed exercitation labore",
"nodeId": "cupidatat"
},
{
"treeId": "ex ea",
"version": "eu occaecat nisi ea",
"nodeId": "labore"
},
{
"treeId": "culpa ea fugiat laborum",
"version": "id Ut proident exercitation aute",
"nodeId": "occaecat dolore"
},
{
"treeId": "sit ut",
"version": "anim nulla reprehenderit",
"nodeId": "aute laboris"
}
],
"gbac": {
"read": [
"63696917c49ecc7b03b5f02b"
],
"write": [
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b"
]
}
},
{
"_id": "dolor",
"name": "Ut exercitation",
"description": "pariatur amet exercitation dolor sunt",
"nodes": [
{
"treeId": "Excepteur do quis ex",
"version": "culpa pariatur qui do ad",
"nodeId": "incididunt"
},
{
"treeId": "Ut laboris ullamco nostrud",
"version": "in ut",
"nodeId": "veniam"
}
],
"gbac": {
"read": [
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b"
],
"write": [
"63696917c49ecc7b03b5f02b"
]
}
},
{
"_id": "tempor pariatur sunt Lorem in",
"name": "nisi irure",
"description": "Duis minim",
"nodes": [
{
"treeId": "dolore magna nostrud incididunt",
"version": "consequat dolor labore anim",
"nodeId": "veniam aliqua"
},
{
"treeId": "minim",
"version": "Duis proident",
"nodeId": "ex"
},
{
"treeId": "proident",
"version": "nisi exercitation Ut",
"nodeId": "adipisicing"
},
{
"treeId": "quis sunt pariatur",
"version": "consequat nostrud occaecat in",
"nodeId": "deserunt"
},
{
"treeId": "eu deserunt",
"version": "id in Duis in elit",
"nodeId": "anim adipisicing Duis in veniam"
}
],
"gbac": {
"read": [
"63696917c49ecc7b03b5f02b"
],
"write": [
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b"
]
}
}
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"plans": {
"title": "plans",
"type": "array",
"items": {
"type": "object",
"properties": {
"_id": {
"type": "string",
"description": "The ID of the compliance plan."
},
"name": {
"type": "string",
"description": "The name of the compliance plan to import"
},
"description": {
"type": "string",
"description": "The description of the compliance plan to import"
},
"nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"treeId": {
"type": "string",
"description": "The treeId of the GC that the node belongs to."
},
"version": {
"type": "string",
"description": "The version of the GC tree that the node belongs to."
},
"nodeId": {
"type": "string",
"description": "The configId of the node."
},
"variables": {
"type": "object",
"example": "{ \"ipAddress\": \"1.2.3.4\" }"
}
}
}
},
"gbac": {
"type": "object",
"properties": {
"read": {
"type": "array",
"items": {
"type": "string",
"examples": [
"63696917c49ecc7b03b5f02b"
]
}
},
"write": {
"type": "array",
"items": {
"type": "string",
"examples": [
"63696917c49ecc7b03b5f02b"
]
}
}
}
}
}
}
}
},
"required": [
"plans"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
status |
object |
Status of compliance plan import operation |
Copied to Clipboard
{
"status": "success",
"message": "esse"
}
Copied to Clipboard
{
"title": "status",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"message": {
"type": "string",
"example": "2 compliance plan(s) imported successfully."
}
}
}