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