Summary
Import Automations
Description
Import Automations.
Route
PUT /operations-manager/automations
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
automations | array | yes | An array of exported Automation documents. |
options | object | yes | Optional parameters. |
{ "automations": [ { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": "workflows", "_id": "f9aeb084a2717334f94cb396", "gbac": { "write": [ { "provenance": "localAAA", "name": "admins", "description": "Description of a group" } ], "read": [ { "provenance": "localAAA", "name": "admins", "description": "Description of a group" }, { "provenance": "localAAA", "name": "admins", "description": "Description of a group" }, { "provenance": "localAAA", "name": "designers", "description": "Description of a group" } ] }, "componentName": null, "createdBy": "veniam culpa exercitation", "created": "1992-01-29T15:37:29.303Z", "lastUpdatedBy": null, "lastUpdated": "2021-02-08T22:56:17.828Z", "triggers": [ { "name": "myCoolDocumentName", "type": "endpoint", "enabled": false, "actionType": "automations", "actionId": "57f5ec29655630634a0ea5e6", "verb": "POST", "routeName": "Dcs9znEG", "_id": "d9cfbe4b4634c06001fc7686", "jst": null, "description": "Some helpful information about the document", "lastExecuted": null, "migrationVersion": -90667024, "createdBy": null, "created": "1958-01-28T09:27:25.426Z", "lastUpdatedBy": null, "lastUpdated": "1967-11-13T21:36:10.055Z" }, { "name": "myCoolDocumentName", "type": "manual", "enabled": false, "actionType": "automations", "actionId": "2e682c7c6b339bdbddb7712a", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "_id": "15e9f88a72037d14f7f82a75", "formId": null, "description": "Some helpful information about the document", "lastExecuted": null, "migrationVersion": -79658791, "createdBy": "nisi dolor ad", "created": "1954-12-14T00:27:16.198Z", "lastUpdatedBy": null, "lastUpdated": "2000-12-01T18:48:32.304Z", "formSchemaHash": null }, { "name": "myCoolDocumentName", "type": "manual", "enabled": false, "actionType": "automations", "actionId": "c054fe4f43f23a61cc2304c1", "formData": { "deviceName": "ATL-123", "action": "SYNC" }, "_id": "dd9e845d91953c7b25221f5b", "formId": "myCoolDocumentName", "description": "Some helpful information about the document", "lastExecuted": null, "migrationVersion": 95373232, "createdBy": "officia nulla", "created": "1948-05-04T07:45:05.299Z", "lastUpdatedBy": "dolor", "lastUpdated": "2024-05-05T03:55:28.275Z", "formSchemaHash": "ex" }, { "name": "myCoolDocumentName", "type": "manual", "enabled": false, "actionType": "automations", "actionId": "4e66dc05cbffd2193c18190b", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "_id": "8ebc09b748a260789c321f0c", "formId": "myCoolDocumentName", "description": "Some helpful information about the document", "lastExecuted": 50963069, "migrationVersion": -53518027, "createdBy": "in nostrud ad", "created": "2011-01-08T06:02:10.256Z", "lastUpdatedBy": null, "lastUpdated": "2000-10-02T08:29:22.299Z", "formSchemaHash": null }, { "name": 89229971.20695767, "type": -8869621.725095332, "enabled": "aliquip dolore enim", "actionType": false, "actionId": -63726712.1440805, "formData": "irure exercitation laborum non", "firstRunAt": 99068681, "processMissedRuns": 15605184, "repeatUnit": false, "repeatFrequency": "culpa ipsum nisi", "repeatInterval": 94428401.63133591, "_id": -65043438, "formId": false } ] }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": "workflows", "_id": "c087d3acfcca75256900ccb7", "gbac": { "write": [ { "provenance": "localAAA", "name": "designers", "description": "Description of a group" }, { "provenance": "ldap", "name": "admins", "description": "Description of a group" }, { "provenance": "localAAA", "name": "designers", "description": "Description of a group" }, { "provenance": "localAAA", "name": "designers", "description": "Description of a group" }, { "provenance": "ldap", "name": "designers", "description": "Description of a group" } ], "read": [ { "provenance": "localAAA", "name": "designers", "description": "Description of a group" } ] }, "componentName": null, "createdBy": null, "created": "2007-10-12T15:30:41.856Z", "lastUpdatedBy": null, "lastUpdated": "1967-05-23T19:02:50.995Z", "triggers": [] }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": "workflows", "_id": "03dfc1c5b98381fd2f644ed3", "gbac": { "write": [ { "provenance": "localAAA", "name": "designers", "description": "Description of a group" } ], "read": [ { "provenance": "localAAA", "name": "operators", "description": "Description of a group" }, { "provenance": "ldap", "name": "designers", "description": "Description of a group" } ] }, "componentName": "dolor", "createdBy": "voluptate ut Ut", "created": "1969-04-26T18:29:27.519Z", "lastUpdatedBy": "in veniam dolore dolor eu", "lastUpdated": "1951-10-26T21:39:45.185Z", "triggers": [ { "name": "myCoolDocumentName", "type": "eventSystem", "enabled": false, "actionType": "automations", "actionId": "d64f6f3ca81624e700f1d361", "source": "ut cupidatat sed minim", "topic": "qui sit deserunt cupidatat ut", "_id": "b74acc1b6bbbe2cb3c7e0836", "description": "Some helpful information about the document", "lastExecuted": null, "migrationVersion": -6311244, "createdBy": null, "created": "1951-10-20T05:37:38.805Z", "lastUpdatedBy": null, "lastUpdated": "2021-01-31T19:36:18.173Z" }, { "name": "myCoolDocumentName", "type": "eventSystem", "enabled": false, "actionType": "automations", "actionId": "3944f0916447cf30ea3e7c45", "source": "aliquip minim", "topic": "veniam est ex do enim", "schema": null, "_id": "4deb5d7dff4db9664729236d", "description": "Some helpful information about the document", "lastExecuted": 33144501, "migrationVersion": 89420077, "createdBy": "occaecat", "created": "1955-09-29T10:51:16.719Z", "lastUpdatedBy": null, "lastUpdated": "2000-02-13T17:09:32.197Z" }, { "name": "myCoolDocumentName", "type": "endpoint", "enabled": false, "actionType": "automations", "actionId": "bc8b9b7196771c5791ffd9c4", "verb": "POST", "routeName": "jnxuk", "schema": null, "_id": "b9614e0912c41efd31237755", "description": "Some helpful information about the document", "lastExecuted": null, "migrationVersion": -54097426, "createdBy": null, "created": "1965-10-27T13:22:56.728Z", "lastUpdatedBy": "nostrud sed non irure ea", "lastUpdated": "1994-09-20T04:13:41.562Z" } ] }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": null, "_id": "e7fa74eb500102fc8cd86db4", "gbac": { "write": [ { "provenance": "localAAA", "name": "designers", "description": "Description of a group" }, { "provenance": "localAAA", "name": "admins", "description": "Description of a group" } ], "read": [ { "provenance": "ldap", "name": "admins", "description": "Description of a group" }, { "provenance": "localAAA", "name": "operators", "description": "Description of a group" }, { "provenance": "localAAA", "name": "designers", "description": "Description of a group" } ] }, "componentName": "et nostrud eiusmod est esse", "createdBy": null, "created": "1987-07-04T20:07:16.522Z", "lastUpdatedBy": null, "lastUpdated": "1975-10-28T06:08:01.037Z", "triggers": [ { "name": "myCoolDocumentName", "type": "endpoint", "enabled": true, "actionType": "automations", "actionId": "145d15b39257b9abd8ad23e2", "verb": "POST", "routeName": "aIYR_", "schema": null, "_id": "85622ba92f7d3ef013ea2b0b", "jst": null, "description": "Some helpful information about the document", "lastExecuted": null, "migrationVersion": -4843286, "createdBy": null, "created": "1988-06-21T13:49:38.831Z", "lastUpdatedBy": null, "lastUpdated": "2017-12-13T13:54:58.552Z" }, { "name": "myCoolDocumentName", "type": "manual", "enabled": false, "actionType": "automations", "actionId": "6e209aebcb0e2ea26915edd2", "formData": { "deviceName": "ATL-123", "action": "SYNC" }, "_id": "e5fb599061e6fce3bed754ee", "formId": "myCoolDocumentName", "description": "Some helpful information about the document", "lastExecuted": 15662336, "migrationVersion": -80483464, "createdBy": "labore culpa esse", "created": "1989-08-09T13:19:58.752Z", "lastUpdatedBy": "eiusmod ut aliquip magna Duis", "lastUpdated": "2011-05-14T20:42:40.103Z", "formSchemaHash": null }, { "name": "myCoolDocumentName", "type": "eventSystem", "enabled": true, "actionType": "automations", "actionId": "13ab07196360626da0c12874", "source": "reprehenderit anim", "topic": "laboris irure mollit id do", "schema": null, "_id": "d4d2bbc769e8572a8780db2f", "description": "Some helpful information about the document", "lastExecuted": 92169974, "migrationVersion": 37894245, "createdBy": "aliquip laborum in", "created": "2015-01-21T14:31:51.706Z", "lastUpdatedBy": null, "lastUpdated": "1960-10-31T02:02:22.914Z" } ] }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": "workflows", "_id": "6c7acacf24cfad9260704e5f", "gbac": { "write": [ { "provenance": "ldap", "name": "designers", "description": "Description of a group" }, { "provenance": "ldap", "name": "admins", "description": "Description of a group" }, { "provenance": "ldap", "name": "operators", "description": "Description of a group" } ], "read": [ { "provenance": "localAAA", "name": "designers", "description": "Description of a group" }, { "provenance": "ldap", "name": "operators", "description": "Description of a group" }, { "provenance": "ldap", "name": "admins", "description": "Description of a group" }, { "provenance": "ldap", "name": "operators", "description": "Description of a group" } ] }, "componentName": null, "createdBy": null, "created": "1954-10-22T09:10:26.267Z", "lastUpdatedBy": null, "lastUpdated": "1968-06-05T21:29:03.603Z", "triggers": [ { "name": "myCoolDocumentName", "type": "eventSystem", "enabled": false, "actionType": "automations", "actionId": "1e862b7def74efeefafc582d", "source": "tempor magna sit", "topic": "commodo tempor deserunt", "_id": "2d37047c6e653845f74ea83e", "description": "Some helpful information about the document", "lastExecuted": null, "migrationVersion": 83091527, "createdBy": "sit in", "created": "1965-05-02T11:16:50.002Z", "lastUpdatedBy": null, "lastUpdated": "1977-03-29T23:30:58.331Z" }, { "name": "myCoolDocumentName", "type": "eventSystem", "enabled": true, "actionType": "automations", "actionId": "d4a8e8974ecef1ba8cea3d68", "source": "anim", "topic": "dolor", "schema": null, "_id": "b636c40cfdcbc779d3fd2099", "jst": null, "description": "Some helpful information about the document", "lastExecuted": null, "migrationVersion": -47040407, "createdBy": "magna anim", "created": "1954-09-09T04:31:24.18Z", "lastUpdatedBy": "dolore laborum minim esse", "lastUpdated": "1982-02-11T23:51:42.184Z" }, { "name": "myCoolDocumentName", "type": "endpoint", "enabled": false, "actionType": "automations", "actionId": "8423ea0fb0dbf24a2a833ba4", "verb": "POST", "routeName": "whi", "_id": "fa4b78f6f2a78f5d23efb2f2", "description": "Some helpful information about the document", "lastExecuted": 57351067, "migrationVersion": -34914392, "createdBy": null, "created": "1979-10-11T05:48:46.822Z", "lastUpdatedBy": null, "lastUpdated": "1994-12-26T21:25:57.071Z" } ] } ], "options": { "adapterMap": { "staging": "production" } } }
{ "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
Name | Type | Description |
---|---|---|
status | object | The result of the import operation. |
{ "message": "Successfully created the requested item", "data": [ { "success": false, "data": { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": "workflows", "createdBy": "f3937dd97086be4ed6166ebd", "created": "2000-12-20T07:25:10.108Z", "lastUpdatedBy": "80b3c7d73151e9630415b359", "lastUpdated": "2001-01-17T14:16:43.666Z", "_id": "9033f173ea515423e82affd2", "gbac": { "write": [ "c2516e0efd18182b313974a3", "1c93d3da03bf775375cb320c", "7ed83ef3450cd738a7f6c7ba", "83d758215273751a1d7696f3" ], "read": [ "6afc8dc2f9800fd11f8057b5" ] }, "componentId": "" } }, { "success": false, "data": { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": null, "createdBy": "Pronghorn", "created": "2005-03-19T23:55:45.591Z", "lastUpdatedBy": "Pronghorn", "lastUpdated": "2022-09-21T23:25:23.348Z", "_id": "203054d9cabc9f6b0e116d9a", "gbac": { "write": [ "2fcdb1f6fab4a1964501ffba", "f33ee396285d4afa3b7faf36", "a1da6d1e868800a18f301e92", "c736332214bd75e974a79e8d", "b67466d11fd3608d04f34f50" ], "read": [ "546e14b41a49cced2af8abe3", "6c917bf77e45a5ecbb24dc32" ] }, "componentId": null } } ] }
{ "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" } } } ] } } } } } } ] }