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