Summary
Import Automations
Description
Import Automation documents from a user supplied JSON document.
Route
PUT /operations-manager/automations
Roles
admin
apiwrite
engineering
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
automations |
array |
yes |
Array of automations |
options |
object |
yes |
optional parameters |
Copied to Clipboard
{
"automations": [],
"options": {}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"automations": {
"title": "automations",
"type": "array",
"items": {}
},
"options": {
"title": "options",
"type": "object",
"properties": {
"adapterMap": {
"type": "object"
}
},
"additionalProperties": false
}
},
"required": [
"automations",
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
status |
object |
Status of automation import operation |
Copied to Clipboard
{
"status": "success",
"message": "irure commodo deserunt ut",
"imported": [
{
"success": false,
"message": "eiusmod ipsum",
"original": {
"name": "My document",
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "A description about an Automation",
"componentType": "workflows",
"componentId": "quis ad anim occaecat",
"gbac": {
"write": [
"4321abcdef694aa79dae47ad",
"5cb7b531d06cceb89fd21b1c",
"5cb7b531d06cceb89fd21b1c"
],
"read": [
"5cb7b531d06cceb89fd21b1c",
"5cb7b531d06cceb89fd21b1c",
"4321abcdef694aa79dae47ad",
"5cb7b531d06cceb89fd21b1c",
"4321abcdef694aa79dae47ad"
]
},
"created": "2019-04-16T00:43:22.038Z",
"createdBy": "4321abcdef694aa79dae47ad",
"lastUpdated": "2019-04-16T00:43:22.038Z",
"lastUpdatedBy": "Pronghorn"
},
"created": {
"name": "My document",
"_id": "4321abcdef694aa79dae47ad",
"description": "A description about an Automation",
"componentType": "workflows",
"componentId": null,
"gbac": {
"write": [
"5cb7b531d06cceb89fd21b1c",
"4321abcdef694aa79dae47ad",
"5cb7b531d06cceb89fd21b1c",
"4321abcdef694aa79dae47ad",
"5cb7b531d06cceb89fd21b1c"
],
"read": [
"5cb7b531d06cceb89fd21b1c",
"5cb7b531d06cceb89fd21b1c",
"5cb7b531d06cceb89fd21b1c",
"5cb7b531d06cceb89fd21b1c",
"5cb7b531d06cceb89fd21b1c"
]
},
"created": "2019-04-16T00:43:22.038Z",
"createdBy": "Pronghorn",
"lastUpdated": "2019-04-16T00:43:22.038Z",
"lastUpdatedBy": "Pronghorn"
}
}
]
}
Copied to Clipboard
{
"title": "status",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"message": {
"type": "string",
"example": "2 automation imported successfully"
},
"imported": {
"type": "array",
"items": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
},
"original": {
"$ref": "automations-schema"
},
"created": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "automations-schema"
}
]
}
}
}
}
}