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": "culpa officia non",
"name": "Lorem eiusmod esse",
"description": "culpa cillum",
"nodes": [
{
"treeId": "ea aliqua ad voluptate do",
"version": "in",
"nodeId": "proident officia incididunt eu"
},
{
"treeId": "Excepteur occaecat elit",
"version": "in velit",
"nodeId": "enim ut minim non"
},
{
"treeId": "anim",
"version": "laboris pariatur in nisi est",
"nodeId": "sint aliqua Lorem dolore"
},
{
"treeId": "voluptate dolore esse irure",
"version": "adipisicing occaecat laboris consectetur",
"nodeId": "amet nisi irure Duis in"
}
],
"gbac": {
"read": [
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b"
],
"write": [
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b"
]
}
},
{
"_id": "ad dolor",
"name": "labore ut",
"description": "ad reprehenderit Lorem",
"nodes": [
{
"treeId": "sit nulla est",
"version": "minim sed",
"nodeId": "elit"
}
],
"gbac": {
"read": [
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b"
],
"write": [
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b"
]
}
},
{
"_id": "cupidatat",
"name": "exercitation in ut",
"description": "ad veniam commodo ut adipisicing",
"nodes": [
{
"treeId": "ipsum est exercitation",
"version": "eiusmod ullamco incididunt",
"nodeId": "exercitation officia in sint amet"
},
{
"treeId": "eu pariatur ad minim labore",
"version": "in aliqua",
"nodeId": "tempor"
},
{
"treeId": "in Ut enim magna nostrud",
"version": "Duis eu consectetur enim",
"nodeId": "magna enim"
},
{
"treeId": "laborum proident et non",
"version": "cupidatat voluptate",
"nodeId": "esse do nulla in"
},
{
"treeId": "deserunt quis ut",
"version": "anim",
"nodeId": "do Duis reprehenderit esse"
}
],
"gbac": {
"read": [
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b"
],
"write": [
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b"
]
}
},
{
"_id": "mollit aute cillum",
"name": "commodo dolore Lorem irure",
"description": "amet",
"nodes": [
{
"treeId": "pariatur",
"version": "est proident ullamco do ut",
"nodeId": "proident est incididunt sit aute"
},
{
"treeId": "ipsum velit Ut laborum",
"version": "aute cillum Lorem",
"nodeId": "sunt Ut reprehenderit"
},
{
"treeId": "in",
"version": "Excepteur sint ipsum in",
"nodeId": "sit reprehenderit consequat nisi esse"
},
{
"treeId": "voluptate",
"version": "Duis sed in cillum",
"nodeId": "irure aliqua voluptate enim non"
},
{
"treeId": "et dolore sunt consectetur",
"version": "sunt eu veniam aliquip",
"nodeId": "est Lorem ea et consequat"
}
],
"gbac": {
"read": [
"63696917c49ecc7b03b5f02b"
],
"write": [
"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": "enim do"
}
Copied to Clipboard
{
"title": "status",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"message": {
"type": "string",
"example": "2 compliance plan(s) imported successfully."
}
}
}