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