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": null, "_id": "647a45e65515c9197f225071", "gbac": { "write": [ { "provenance": "ldap", "name": "operators", "description": "Description of a group" } ], "read": [ { "provenance": "ldap", "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" }, { "provenance": "ldap", "name": "admins", "description": "Description of a group" }, { "provenance": "ldap", "name": "operators", "description": "Description of a group" } ] }, "componentName": null, "createdBy": null, "created": "1964-02-21T06:38:55.585Z", "lastUpdatedBy": null, "lastUpdated": "2002-03-23T20:20:48.429Z", "triggers": [ { "name": "myCoolDocumentName", "type": "endpoint", "enabled": true, "actionType": "automations", "actionId": "526421ced5b3945e737fd9a0", "verb": "POST", "routeName": "sKS0i1re", "_id": "c897a39b7a58b7680bbc1d5b", "description": "Some helpful information about the document", "lastExecuted": null, "migrationVersion": -84978915, "createdBy": null, "created": "1986-05-02T08:14:55.457Z", "lastUpdatedBy": null, "lastUpdated": "1992-03-29T09:18:28.802Z" }, { "name": "myCoolDocumentName", "type": "manual", "enabled": false, "actionType": "automations", "actionId": "419a71e3c97cc749bef39d0e", "formData": { "deviceName": "ATL-123", "action": "SYNC" }, "_id": "0961afba1c51c67a23872051", "formId": null, "description": "Some helpful information about the document", "lastExecuted": 58744883, "migrationVersion": -92647826, "createdBy": "exercitation culpa magna aute", "created": "2002-11-19T11:25:34.302Z", "lastUpdatedBy": "anim do nisi", "lastUpdated": "2004-01-02T14:56:57.162Z", "formSchemaHash": null, "legacyWrapper": false } ] }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": "workflows", "_id": "2cbdde54b529758eb227a0bd", "gbac": { "write": [ { "provenance": "ldap", "name": "designers", "description": "Description of a group" }, { "provenance": "localAAA", "name": "admins", "description": "Description of a group" }, { "provenance": "localAAA", "name": "admins", "description": "Description of a group" } ], "read": [ { "provenance": "localAAA", "name": "designers", "description": "Description of a group" }, { "provenance": "ldap", "name": "operators", "description": "Description of a group" } ] }, "componentName": null, "createdBy": "anim sed velit ut officia", "created": "1985-09-23T00:22:27.029Z", "lastUpdatedBy": "cillum", "lastUpdated": "2022-05-31T00:53:46.313Z", "triggers": [ { "name": "myCoolDocumentName", "type": "endpoint", "enabled": false, "actionType": "automations", "actionId": "09121b2e07880c82a93cce4a", "verb": "POST", "routeName": "Vt_D8F2-3K", "_id": "5f3e73e7eab724eb5fd6412e", "jst": null, "description": "Some helpful information about the document", "lastExecuted": 3793706, "migrationVersion": -17120642, "createdBy": "aliqua", "created": "1951-04-29T19:59:18.118Z", "lastUpdatedBy": "do deserunt", "lastUpdated": "1987-07-30T12:13:26.815Z" }, { "name": false, "type": "magna", "enabled": 12968113.814155042, "actionType": "elit Duis laboris mollit", "actionId": "adipisicing non", "formData": true, "firstRunAt": "id dolor non in aliquip", "processMissedRuns": 73641993, "repeatUnit": true, "repeatFrequency": -94748467, "repeatInterval": "in", "_id": false, "formId": "qui non sunt enim" }, { "name": "myCoolDocumentName", "type": "manual", "enabled": false, "actionType": "automations", "actionId": "8cf62324641437978ef2d012", "formData": { "deviceName": "ATL-123", "action": "SYNC" }, "_id": "9ebbc53b1f95acfb8e289e94", "formId": "myCoolDocumentName", "description": "Some helpful information about the document", "lastExecuted": 80384777, "migrationVersion": -21278335, "createdBy": "sunt", "created": "2008-08-30T15:25:29.442Z", "lastUpdatedBy": "tempor ut occaecat", "lastUpdated": "1996-05-02T23:25:51.615Z", "formSchemaHash": "Excepteur", "legacyWrapper": false }, { "name": "myCoolDocumentName", "type": "manual", "enabled": true, "actionType": "automations", "actionId": "b761290c5af4b0d49740e399", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "_id": "23deefd0c9d497abe8c24f0f", "formId": "myCoolDocumentName", "description": "Some helpful information about the document", "lastExecuted": null, "migrationVersion": -48176169, "createdBy": "reprehenderit esse sed id", "created": "1979-05-19T08:04:31.494Z", "lastUpdatedBy": null, "lastUpdated": "2005-10-31T21:23:21.14Z", "formSchemaHash": null, "legacyWrapper": true } ] }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": "workflows", "_id": "f33b6b1d287552e05c115bb8", "gbac": { "write": [ { "provenance": "localAAA", "name": "admins", "description": "Description of a group" }, { "provenance": "localAAA", "name": "admins", "description": "Description of a group" } ], "read": [ { "provenance": "localAAA", "name": "operators", "description": "Description of a group" }, { "provenance": "ldap", "name": "operators", "description": "Description of a group" } ] }, "componentName": "mollit", "createdBy": "dolor laborum ut ipsum Duis", "created": "1972-04-23T05:09:35.485Z", "lastUpdatedBy": null, "lastUpdated": "1986-03-06T22:03:43.391Z", "triggers": [ { "name": "myCoolDocumentName", "type": "eventSystem", "enabled": true, "actionType": "automations", "actionId": "278e8c13f7bc78361958fc67", "source": "aute esse", "topic": "sunt qui", "schema": null, "_id": "445136ad13c8689beaf7e750", "jst": null, "description": "Some helpful information about the document", "lastExecuted": 97908132, "migrationVersion": -24766562, "legacyWrapper": false, "createdBy": null, "created": "1991-07-30T22:08:46.747Z", "lastUpdatedBy": null, "lastUpdated": "2004-01-24T06:15:54.377Z" }, { "name": "myCoolDocumentName", "type": "eventSystem", "enabled": false, "actionType": "automations", "actionId": "69efac27d2582293bec9ec22", "source": "enim proident mollit Excepteur", "topic": "ea aliquip commodo consequat incididunt", "schema": null, "_id": "4404fa8f79f264323a5a4fc5", "jst": null, "description": "Some helpful information about the document", "lastExecuted": 27257958, "migrationVersion": 79653835, "legacyWrapper": true, "createdBy": null, "created": "2021-09-09T03:22:49.032Z", "lastUpdatedBy": "commodo", "lastUpdated": "1992-06-15T05:10:16.003Z" } ] }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": "ucm_compliance_plans", "_id": "16cb28f618b0e2586625dee1", "gbac": { "write": [ { "provenance": "localAAA", "name": "operators", "description": "Description of a group" }, { "provenance": "ldap", "name": "admins", "description": "Description of a group" }, { "provenance": "ldap", "name": "designers", "description": "Description of a group" }, { "provenance": "localAAA", "name": "admins", "description": "Description of a group" }, { "provenance": "localAAA", "name": "admins", "description": "Description of a group" } ], "read": [ { "provenance": "localAAA", "name": "operators", "description": "Description of a group" } ] }, "componentName": "qui non nostrud tempor labore", "createdBy": "Excepteur qui Lorem in", "created": "2013-05-02T10:42:23.825Z", "lastUpdatedBy": null, "lastUpdated": "1952-01-16T00:35:31.255Z", "triggers": [ { "name": "myCoolDocumentName", "type": "eventSystem", "enabled": false, "actionType": "automations", "actionId": "f2ead832355c1fca03b7c1ee", "source": "laboris", "topic": "mollit", "schema": null, "_id": "ecfd9d86ebb3c3b1e23fc17c", "description": "Some helpful information about the document", "lastExecuted": 99539779, "migrationVersion": -25037639, "legacyWrapper": false, "createdBy": null, "created": "2001-12-13T15:51:37.047Z", "lastUpdatedBy": "sed fugiat commodo Ut magna", "lastUpdated": "1967-07-14T11:20:22.382Z" } ] }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": null, "_id": "56b36c02e6042d05ef80906d", "gbac": { "write": [ { "provenance": "ldap", "name": "admins", "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": "designers", "description": "Description of a group" }, { "provenance": "ldap", "name": "designers", "description": "Description of a group" }, { "provenance": "localAAA", "name": "designers", "description": "Description of a group" } ] }, "componentName": "mollit tempor labore", "createdBy": "mollit consectetur ex fugiat ullamco", "created": "2023-10-13T01:42:46.518Z", "lastUpdatedBy": null, "lastUpdated": "1984-06-07T13:45:56.278Z", "triggers": [ { "name": "myCoolDocumentName", "type": "eventSystem", "enabled": true, "actionType": "automations", "actionId": "5de2a096f2ee8398b4e73976", "source": "consequat in id incididunt consectetur", "topic": "reprehenderit Lorem exercitation voluptate", "schema": null, "_id": "388153982e398dd3be2fbe69", "description": "Some helpful information about the document", "lastExecuted": null, "migrationVersion": -49816941, "legacyWrapper": true, "createdBy": "pariatur est consequat cupidatat ex", "created": "1966-09-19T22:11:58.311Z", "lastUpdatedBy": "adipisicing Duis Excepteur", "lastUpdated": "1952-02-18T00:16:30.116Z" }, { "name": "myCoolDocumentName", "type": "endpoint", "enabled": false, "actionType": "automations", "actionId": "dc6b46b2e48d6cce3fe8e38e", "verb": "POST", "routeName": "wkOm", "schema": null, "_id": "d54bc38a8a8b617653ef8cad", "jst": null, "description": "Some helpful information about the document", "lastExecuted": 42188899, "migrationVersion": 77262487, "createdBy": null, "created": "2021-03-12T01:08:13.722Z", "lastUpdatedBy": null, "lastUpdated": "2020-04-02T20:18:22.069Z" }, { "name": "myCoolDocumentName", "type": "manual", "enabled": false, "actionType": "automations", "actionId": "4eccfe2ee2cd5824448177ea", "formData": { "deviceName": "ATL-123", "action": "SYNC" }, "_id": "f0eebf5b064d24ccd3d6f562", "formId": null, "description": "Some helpful information about the document", "lastExecuted": null, "migrationVersion": 46355010, "createdBy": "reprehenderit Ut sint qui", "created": "1968-09-14T03:43:59.709Z", "lastUpdatedBy": "elit", "lastUpdated": "2011-05-14T22:20:09.49Z", "formSchemaHash": "aliquip non eiusmod", "legacyWrapper": true } ] } ], "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 imported 3 of 4 documents", "data": [ { "success": true, "data": { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": "workflows", "createdBy": "Pronghorn", "created": "2001-05-10T14:42:40.728Z", "lastUpdatedBy": "Pronghorn", "lastUpdated": "2025-01-22T22:08:23.172Z", "_id": "db2e9a9c64cc711b851fd142", "gbac": { "write": [ "f50f869f857e84e461506c94" ], "read": [ "662d2302cc33878681261e9d", "5a6d96d0ab7580205ba0b5d8", "2f1b992c71353e7e7c5d05d4", "f25fcbf15205ef451e992961", "e6d9d30a8841fc530c4818d5" ] }, "componentId": null } }, { "success": true, "data": { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": "workflows", "createdBy": "ddadacd9338aac327559d006", "created": "1969-01-02T02:46:47.569Z", "lastUpdatedBy": "b3285b30eb39b5568339b057", "lastUpdated": "2005-05-29T07:12:44.734Z", "_id": "86cfce033103ecc7f6e70206", "gbac": { "write": [ "dec1fd13bc399676ffedc9b1" ], "read": [ "9fdbf0a981f9aaabcdb0ac2c", "e2ec9a97f4cc60115f22264e", "f91ef447e2753887c020ebdb" ] }, "componentId": "bD2C8aAb-9875-fC3f-66CD-244ffDbcEC08" } }, { "success": true, "data": { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": "workflows", "createdBy": "Pronghorn", "created": "1945-10-08T05:38:54.713Z", "lastUpdatedBy": "Pronghorn", "lastUpdated": "1955-06-03T08:23:03.185Z", "_id": "44bc38a9d60b28011e0b7db6", "gbac": { "write": [ "0155894dad529454aa9808ad", "d4c82c8f45de281b2371c28c", "2f0bc9612904cf8a52416680", "83f97d248ab9e3542d00daf1" ], "read": [ "854b3a8b250f04f1ed38c157", "67be431a6b9513be8ab790eb", "a6ff79547fba7bfdddcdb813" ] }, "componentId": "e19698b1-57eB-5d13-4A36-D7deBBb5Afcb" } } ] }
{ "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" } } } ] } } } } } } ] }