Summary
Create Automation
Description
Create a new Automation document in IAP.
Route
POST /operations-manager/automations
Roles
admin
apiwrite
engineering
Parameters
Details Example Schema
Name
Type
Required
Description
automation
object
yes
The automation document to create
Copied to Clipboard
{
"automation": {
"name": "My document",
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "A description about an Automation",
"componentType": "workflows",
"componentId": "nostrud Excepteur reprehenderit exercitation",
"gbac": {
"write": [
"5cb7b531d06cceb89fd21b1c",
"5cb7b531d06cceb89fd21b1c",
"5cb7b531d06cceb89fd21b1c",
"5cb7b531d06cceb89fd21b1c",
"4321abcdef694aa79dae47ad"
],
"read": [
"5cb7b531d06cceb89fd21b1c",
"4321abcdef694aa79dae47ad",
"4321abcdef694aa79dae47ad"
]
},
"created": "2019-04-16T00:43:22.038Z",
"createdBy": "Pronghorn",
"lastUpdated": "2019-04-16T00:43:22.038Z",
"lastUpdatedBy": "4321abcdef694aa79dae47ad"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"automation": {
"title": "automation",
"$ref": "automations-schema"
}
},
"required": [
"automation"
],
"additionalProperties": false
}
Return
Details Example Schema
Name
Type
Description
results
object
The results of the automation creation process
Copied to Clipboard
{
"status": "Created",
"message": "mollit consectetur nisi",
"data": {
"name": "My document",
"_id": "4321abcdef694aa79dae47ad",
"description": "A description about an Automation",
"componentType": null,
"componentId": null,
"gbac": {
"write": [
"4321abcdef694aa79dae47ad",
"4321abcdef694aa79dae47ad"
],
"read": [
"4321abcdef694aa79dae47ad",
"4321abcdef694aa79dae47ad",
"4321abcdef694aa79dae47ad"
]
},
"created": "2019-04-16T00:43:22.038Z",
"createdBy": "5cb7b531d06cceb89fd21b1c",
"lastUpdated": "2019-04-16T00:43:22.038Z",
"lastUpdatedBy": "Pronghorn"
}
}
Copied to Clipboard
{
"title": "results",
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the API request.",
"enum": [
"Created"
]
},
"message": {
"type": "string",
"description": "Message containing either confirmation of the operation or the reason for the failure of the operation."
},
"data": {
"$ref": "automations-schema"
}
}
}