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