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": "c16f357ac2477b659775a62a", "gbac": { "write": [ { "provenance": "localAAA", "name": "operators", "description": "Description of a group" }, { "provenance": "localAAA", "name": "operators", "description": "Description of a group" }, { "provenance": "localAAA", "name": "admins", "description": "Description of a group" }, { "provenance": "localAAA", "name": "admins", "description": "Description of a group" }, { "provenance": "ldap", "name": "designers", "description": "Description of a group" } ], "read": [ { "provenance": "localAAA", "name": "admins", "description": "Description of a group" }, { "provenance": "ldap", "name": "admins", "description": "Description of a group" } ] }, "componentName": "enim commodo consectetur labore", "createdBy": "eiusmod qui velit", "created": "1977-10-10T15:07:48.966Z", "lastUpdatedBy": null, "lastUpdated": "1986-06-18T08:22:57.221Z", "triggers": [ { "name": "myCoolDocumentName", "type": "eventSystem", "enabled": true, "actionType": "automations", "actionId": "0b7de1d56ee162fea9e5cf0f", "source": "amet dolor anim mollit officia", "topic": "laboris", "_id": "67956684de79e4865d3a586f", "description": "Some helpful information about the document", "lastExecuted": 90902668, "migrationVersion": -22925452, "legacyWrapper": false, "createdBy": "deserunt sunt ullamco mollit labore", "created": "1960-05-28T14:54:27.513Z", "lastUpdatedBy": null, "lastUpdated": "1959-07-25T04:59:25.976Z" }, { "name": "myCoolDocumentName", "type": "eventSystem", "enabled": false, "actionType": "automations", "actionId": "71abb52151d8ba51370bcb9d", "source": "minim non consequat", "topic": "Ut Duis", "schema": null, "_id": "fffb1c549869293bbadafd3c", "jst": null, "description": "Some helpful information about the document", "lastExecuted": null, "migrationVersion": 19119891, "legacyWrapper": false, "createdBy": "exercitation irure et aliquip proident", "created": "1972-01-07T08:26:12.2Z", "lastUpdatedBy": "aliqua anim veniam", "lastUpdated": "2011-12-11T03:13:33.847Z" }, { "name": "myCoolDocumentName", "type": "eventSystem", "enabled": true, "actionType": "automations", "actionId": "706c410c80def40d8805c2aa", "source": "sed laborum pariatur sunt ea", "topic": "est id deserunt ex", "schema": null, "_id": "c2b05e5f33cb428032016f01", "description": "Some helpful information about the document", "lastExecuted": 62700490, "migrationVersion": -96414789, "legacyWrapper": false, "createdBy": "id fugiat velit enim", "created": "1967-02-16T14:38:58.964Z", "lastUpdatedBy": null, "lastUpdated": "1955-09-07T16:19:19.192Z" } ] }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": "workflows", "_id": "b1bd210e6f04f17e622b6a37", "gbac": { "write": [ { "provenance": "localAAA", "name": "admins", "description": "Description of a group" }, { "provenance": "localAAA", "name": "designers", "description": "Description of a group" }, { "provenance": "localAAA", "name": "operators", "description": "Description of a group" }, { "provenance": "localAAA", "name": "designers", "description": "Description of a group" }, { "provenance": "ldap", "name": "admins", "description": "Description of a group" } ], "read": [ { "provenance": "localAAA", "name": "operators", "description": "Description of a group" }, { "provenance": "localAAA", "name": "operators", "description": "Description of a group" } ] }, "componentName": null, "createdBy": null, "created": "1988-07-31T21:07:10.132Z", "lastUpdatedBy": null, "lastUpdated": "1970-09-25T14:20:26.62Z", "triggers": [ { "name": "myCoolDocumentName", "type": "eventSystem", "enabled": true, "actionType": "automations", "actionId": "73d2353b88cd0fd07a22196c", "source": "Ut aliquip eu esse", "topic": "exercitation", "_id": "2f97e4cc3409bdb1827291cc", "jst": null, "description": "Some helpful information about the document", "lastExecuted": 65658237, "migrationVersion": -19459188, "legacyWrapper": true, "createdBy": "qui officia nisi ut Excepteur", "created": "2000-10-31T18:25:51.795Z", "lastUpdatedBy": null, "lastUpdated": "2021-07-23T18:33:39.846Z" }, { "name": "myCoolDocumentName", "type": "eventSystem", "enabled": false, "actionType": "automations", "actionId": "da8b464b2c94bb4aedb5f050", "source": "sunt Excepteur adipisicing ullamco voluptate", "topic": "ut in consequat ut irure", "_id": "74ecf4b8d936911ffbff5307", "description": "Some helpful information about the document", "lastExecuted": null, "migrationVersion": 90345993, "legacyWrapper": false, "createdBy": null, "created": "1993-10-17T14:54:39.326Z", "lastUpdatedBy": null, "lastUpdated": "1989-06-30T11:38:47.925Z" }, { "name": "myCoolDocumentName", "type": "manual", "enabled": true, "actionType": "automations", "actionId": "ca233460b66e5cba7dc4020a", "formData": { "deviceName": "ATL-123", "action": "SYNC" }, "_id": "a8efa9e6f7dbcb88acaebb44", "formId": null, "description": "Some helpful information about the document", "lastExecuted": 77609740, "migrationVersion": 52661376, "createdBy": "dolore cupidatat", "created": "2008-05-15T02:19:54.017Z", "lastUpdatedBy": null, "lastUpdated": "2019-06-18T08:18:50.686Z", "formSchemaHash": null, "legacyWrapper": false }, { "name": "myCoolDocumentName", "type": "manual", "enabled": true, "actionType": "automations", "actionId": "0f6f028b1c09d247f2f5fa82", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "_id": "70b9fda91f68be8e383beff0", "formId": null, "description": "Some helpful information about the document", "lastExecuted": null, "migrationVersion": 3399269, "createdBy": null, "created": "1972-08-09T12:42:29.321Z", "lastUpdatedBy": null, "lastUpdated": "1966-05-23T04:20:50.869Z", "formSchemaHash": "ea et labore sit", "legacyWrapper": false } ] } ], "options": { "adapterMap": { "old_name": "new_name" } } }
{ "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": null, "createdBy": "ef6f17b561f4943daca47bd2", "created": "1978-11-23T10:09:22.264Z", "lastUpdatedBy": "40aedb1a23963638147d3a94", "lastUpdated": "1994-12-28T18:46:43.099Z", "_id": "ea50f5d52fa1600a02ba9ecd", "gbac": { "write": [ "10db6a3d8407da8bb349c12f", "1b5cd344601db0f21b72bc17", "9ce6060a6a5e9c2c9326fc47", "2b38123638280474f80e3c96" ], "read": [ "d19f30204014ec71dfd8ce98", "ce84196b844bf7242d9960a9", "80941f569449b4e5db7c2998", "ae8d44865eff3f49fbfe1e9f" ] }, "componentId": "fFEa9Ba3-D9b2-462f-2daA-ebE26fee2919" } }, { "success": false, "data": { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": "workflows", "createdBy": "Pronghorn", "created": "1990-06-01T22:15:35.751Z", "lastUpdatedBy": "Pronghorn", "lastUpdated": "1958-10-17T07:26:55.152Z", "_id": "6c42c9dcab7fbbd47362db00", "gbac": { "write": [ "f4860b800f5dc2c3f07899e3", "34df1fad8cd209a58ab2e1e4", "d958f137a09a81eba534e068", "532c0ee3626e43355e0ebde8" ], "read": [ "30b7a624b8bab6a444d3ea70", "507e16b8a4e6073d1f999495", "e745d85e1b44426996574215" ] }, "componentId": null } }, { "success": true, "data": { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": "workflows", "createdBy": "Pronghorn", "created": "1961-06-27T20:25:56.173Z", "lastUpdatedBy": "5d7f7b5023c0be88c396680b", "lastUpdated": "1998-12-04T19:54:10.545Z", "_id": "4e7c0be2eccaf5251c3b7a31", "gbac": { "write": [ "4439f3491cae38c731e2f78b" ], "read": [ "53b35d4320ac80ee4ed37883", "7780804de981406f7c3657ab", "f9ab01c56f88e96629a26b71", "2213e07bf703b9a3047b018c" ] }, "componentId": "408991d412ea25b80c66c067" } } ] }
{ "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" } } } ] } } } } } } ] }