Summary
Import Automations
Description
Import Automations.
Route
PUT /operations-manager/automations
Roles
admin
apiwrite
engineering
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
automations |
array |
yes |
An array of exported Automation documents. |
options |
object |
yes |
Optional parameters. |
Copied to Clipboard
{
"automations": [
{
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"componentType": "workflows",
"_id": "fe504b2b898a04a75e167828",
"gbac": {
"write": [
{
"provenance": "ldap",
"name": "admins",
"description": "Description of a group"
},
{
"provenance": "ldap",
"name": "admins",
"description": "Description of a group"
},
{
"provenance": "ldap",
"name": "designers",
"description": "Description of a group"
}
],
"read": [
{
"provenance": "localAAA",
"name": "operators",
"description": "Description of a group"
},
{
"provenance": "localAAA",
"name": "designers",
"description": "Description of a group"
},
{
"provenance": "localAAA",
"name": "designers",
"description": "Description of a group"
},
{
"provenance": "localAAA",
"name": "admins",
"description": "Description of a group"
}
]
},
"componentName": "in",
"createdBy": "est",
"created": "1952-10-11T05:49:28.317Z",
"lastUpdatedBy": "id",
"lastUpdated": "1949-01-31T06:53:58.936Z",
"triggers": [
{
"name": "myCoolDocumentName",
"type": "endpoint",
"enabled": false,
"actionType": "automations",
"actionId": "4539af1e29a678344b84e899",
"verb": "POST",
"routeName": "jCCrgLTrx6L",
"schema": null,
"_id": "2d548d7d8260e9871fceaf11",
"description": "Some helpful information about the document",
"lastExecuted": 87693189,
"migrationVersion": 13335008,
"createdBy": null,
"created": "1978-05-12T06:38:28.214Z",
"lastUpdatedBy": "veniam do",
"lastUpdated": "1944-07-01T13:19:45.576Z"
},
{
"name": "myCoolDocumentName",
"type": "manual",
"enabled": true,
"actionType": "automations",
"actionId": "6cd4a8eabfabe2f85dfbb4fc",
"formData": {
"deviceName": "ATL-123",
"action": "SYNC"
},
"_id": "072808e0b1118cbe10a696ed",
"formId": null,
"description": "Some helpful information about the document",
"lastExecuted": null,
"migrationVersion": -7443625,
"createdBy": null,
"created": "1945-04-04T05:31:10.758Z",
"lastUpdatedBy": "consectetur nisi in",
"lastUpdated": "1972-06-04T18:07:00.905Z",
"formSchemaHash": null
}
]
}
],
"options": {
"adapterMap": {
"old_name": "new_name"
}
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"automations": {
"title": "automations",
"type": "array",
"items": {
"$ref": "automation-json"
}
},
"options": {
"title": "options",
"type": "object",
"properties": {
"adapterMap": {
"type": "object",
"description": "A mapping of provenance names to be converted upon import, specified in \"old_name\": \"new_name\" format.",
"examples": [
{
"staging": "production"
},
{
"old_name": "new_name"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"automations",
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
status |
object |
The result of the import operation. |
Copied to Clipboard
{
"message": "Successfully created the requested item",
"data": [
{
"success": false,
"data": {
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"componentType": null,
"createdBy": "Pronghorn",
"created": "1998-03-02T05:17:42.847Z",
"lastUpdatedBy": "fd56629b01ad4d314279ffe0",
"lastUpdated": "2013-11-03T20:19:05.239Z",
"_id": "2633b06ce8e435b061f5177d",
"gbac": {
"write": [
"1c2d345172c70d65fcd07d1c",
"79f06bbc8ca0dab2eb7a0c55",
"a948fe956c24711749e6246f"
],
"read": [
"f875c92b184955538b4da32c",
"b7687319876abf0bc2d4f679",
"7edb6f27627e7355b7c2eb31",
"183e0abccb5e2ad26df9d1fb",
"2c517089948ebc660f987c9f"
]
},
"componentId": ""
}
}
]
}
Copied to Clipboard
{
"title": "status",
"allOf": [
{
"$ref": "common-api#/definitions/success-response"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"data": {
"allOf": [
{
"$ref": "automation-common#/definitions/commonFields"
},
{
"$ref": "common#/definitions/metadataFields"
},
{
"type": "object",
"properties": {
"_id": {
"$ref": "common#/definitions/ObjectIdLikeString"
},
"gbac": {
"$ref": "automation-common#/definitions/gbac"
},
"componentId": {
"$ref": "automation-common#/definitions/componentId"
}
}
}
]
}
}
}
}
}
}
]
}