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