Summary
Update Automation
Description
Update an Automation document
Route
PATCH /operations-manager/automations/:id
Roles
admin
apiwrite
engineering
Parameters
Details Example Schema
Name
Type
Required
Description
id
string
yes
the id of the automation to update
updates
object
yes
an entire automation document to update the existing one
Copied to Clipboard
{
"updates": {
"name": "My document",
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "A description about an Automation",
"componentType": "workflows",
"componentId": "magna proident quis adipisicing qui",
"gbac": {
"write": [
"5cb7b531d06cceb89fd21b1c",
"5cb7b531d06cceb89fd21b1c",
"5cb7b531d06cceb89fd21b1c",
"5cb7b531d06cceb89fd21b1c",
"5cb7b531d06cceb89fd21b1c"
],
"read": [
"4321abcdef694aa79dae47ad",
"4321abcdef694aa79dae47ad",
"4321abcdef694aa79dae47ad",
"4321abcdef694aa79dae47ad"
]
},
"created": "2019-04-16T00:43:22.038Z",
"createdBy": "5cb7b531d06cceb89fd21b1c",
"lastUpdated": "2019-04-16T00:43:22.038Z",
"lastUpdatedBy": "5cb7b531d06cceb89fd21b1c"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"updates": {
"title": "updates",
"$ref": "automations-schema"
}
},
"required": [
"updates"
],
"additionalProperties": false
}
Return
Details Example Schema
Name
Type
Description
result
object
the updated trigger document
Copied to Clipboard
{
"status": "OK",
"message": "sunt irure anim amet",
"data": {
"name": "My document",
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "A description about an Automation",
"componentType": null,
"componentId": "mollit minim magna",
"gbac": {
"write": [
"5cb7b531d06cceb89fd21b1c",
"5cb7b531d06cceb89fd21b1c"
],
"read": [
"5cb7b531d06cceb89fd21b1c",
"4321abcdef694aa79dae47ad",
"4321abcdef694aa79dae47ad"
]
},
"created": "2019-04-16T00:43:22.038Z",
"createdBy": "Pronghorn",
"lastUpdated": "2019-04-16T00:43:22.038Z",
"lastUpdatedBy": "5cb7b531d06cceb89fd21b1c"
}
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the API request.",
"enum": [
"OK"
]
},
"message": {
"type": "string",
"description": "Message containing either confirmation of the operation or the reason for the failure of the operation."
},
"data": {
"$ref": "automations-schema"
}
}
}
