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": "c146470b147d81fb929f4419", "gbac": { "write": [ { "provenance": "localAAA", "name": "admins", "description": "Description of a group" }, { "provenance": "localAAA", "name": "operators", "description": "Description of a group" }, { "provenance": "localAAA", "name": "operators", "description": "Description of a group" }, { "provenance": "ldap", "name": "admins", "description": "Description of a group" } ], "read": [ { "provenance": "ldap", "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" }, { "provenance": "localAAA", "name": "designers", "description": "Description of a group" } ] }, "componentName": null, "createdBy": null, "created": "1995-10-25T18:39:16.248Z", "lastUpdatedBy": "eiusmod aliquip anim", "lastUpdated": "2023-02-23T21:35:28.63Z", "triggers": [ { "name": 38391630.39254573, "type": -22800719.43521604, "enabled": 58242899, "actionType": "velit", "actionId": true, "formData": "consequat ipsum", "firstRunAt": false, "processMissedRuns": -94781819.51109272, "repeatUnit": false, "repeatFrequency": -19539808.490790203, "repeatInterval": 3505556.6308955103, "_id": 56168408, "formId": -15025048.27410233 }, { "name": "myCoolDocumentName", "type": "manual", "enabled": true, "actionType": "automations", "actionId": "0bdd36d03196bab51c2974a8", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "_id": "923c2e58b04a3b82579d1188", "formId": null, "description": "Some helpful information about the document", "lastExecuted": 99292042, "migrationVersion": -95929507, "createdBy": "ipsum in amet", "created": "1971-07-30T10:47:56.402Z", "lastUpdatedBy": "eiusmod anim laboris", "lastUpdated": "1993-08-20T03:10:10.136Z", "formSchemaHash": "laborum sunt enim irure occaecat", "legacyWrapper": false }, { "name": "myCoolDocumentName", "type": "manual", "enabled": true, "actionType": "automations", "actionId": "06b883126af747e5b62e7cfb", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "_id": "4cbde4098efe09ec98fedc96", "formId": "myCoolDocumentName", "description": "Some helpful information about the document", "lastExecuted": null, "migrationVersion": 28712761, "createdBy": "sit magna", "created": "1975-05-02T15:54:54.491Z", "lastUpdatedBy": "ex do ut aliquip", "lastUpdated": "1964-12-26T17:53:23.803Z", "formSchemaHash": null, "legacyWrapper": true }, { "name": "myCoolDocumentName", "type": "endpoint", "enabled": true, "actionType": "automations", "actionId": "7eb05373ac09600c5a2b8189", "verb": "POST", "routeName": "6", "_id": "b1f77b5c93a15fda7a314a2d", "description": "Some helpful information about the document", "lastExecuted": null, "migrationVersion": -29672022, "createdBy": null, "created": "1997-09-11T11:29:48.945Z", "lastUpdatedBy": null, "lastUpdated": "2003-12-14T15:50:37.332Z" }, { "name": "myCoolDocumentName", "type": "endpoint", "enabled": false, "actionType": "automations", "actionId": "442eb134b9059522a5da7619", "verb": "POST", "routeName": "W4zecvRHyYV", "_id": "bc68eccefe0aa103c0d60d09", "jst": null, "description": "Some helpful information about the document", "lastExecuted": 22275106, "migrationVersion": -40582839, "createdBy": null, "created": "1952-05-26T10:29:10.274Z", "lastUpdatedBy": "ut elit veniam dolor in", "lastUpdated": "1980-10-27T01:36:22.964Z" } ] } ], "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": null, "createdBy": "2efda447589518c36c6e3bcf", "created": "2025-03-27T03:53:25.702Z", "lastUpdatedBy": "Pronghorn", "lastUpdated": "1949-02-09T16:15:20.324Z", "_id": "9bc25c627cd8a8eda3f62dc4", "gbac": { "write": [ "1c93b28049497d5c9035e8b1", "e5697e1dff47da66aa87c790", "6ec5984c7646384e788856b4", "f2636e6eab792380d4d32a6e" ], "read": [ "7deb51575e811d20493e5f22" ] }, "componentId": "" } }, { "success": false, "data": { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": null, "createdBy": "3d50c96d620e64451b419a1c", "created": "2005-03-06T08:46:23.041Z", "lastUpdatedBy": "c09fc106501cb5fa9b3008c6", "lastUpdated": "1954-08-03T19:08:17.817Z", "_id": "c223b915ab681ae14b26823f", "gbac": { "write": [ "d887365a2bd44f517b464253", "606e48b7c1722dd652c40279", "1ff4dbfde36b48c4fa40f334" ], "read": [ "ca35b5e4f88065e9296f3f7b", "f4116fd15f63ba673c839734", "08556fc64495da2a0a367bfa", "ac07894d93ff80a533cfba33", "d5b3d84451a228b472435ccf" ] }, "componentId": null } }, { "success": true, "data": { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": "ucm_compliance_plans", "createdBy": "e71f31cbed9736681dce8dba", "created": "1976-09-19T17:43:23.864Z", "lastUpdatedBy": "4c2f55d7af69821f405fe2ae", "lastUpdated": "1979-01-26T14:03:18.309Z", "_id": "60c5e7002988f6cbf736f383", "gbac": { "write": [ "a276fc5683eb583192ac64f4", "f8187e6575257515c113602b", "fdd23541a231d06fda03db47" ], "read": [ "dfe09c36740098a987aa8d0a", "5c5b6d623864bc80c90e22d9", "2440e9e96dc55e28d638a7e5", "e0c76beeb6b845f9ee6603c0", "188b33cc569b1de5151a772b" ] }, "componentId": "8f035bef-8821-DFf8-c275-952880ee4321" } }, { "success": false, "data": { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "componentType": "workflows", "createdBy": "eee3e725b9fec981dcec88a7", "created": "1947-06-07T19:18:09.399Z", "lastUpdatedBy": "215b6b8507ff1702deed9b7f", "lastUpdated": "2025-01-08T02:29:26.426Z", "_id": "281e7e9e1dd994f20effb91c", "gbac": { "write": [ "2eaaa1dca63fa6fd97e5e375" ], "read": [ "a687c97990187dc65c22a92f", "f24288d9dfbc1ca3c1b94b4b", "2d723fc76192bb8d7ae3e672" ] }, "componentId": "Fe3dF6c7-0FCa-BeD4-dd5f-F1DbAdFF2D4b" } } ] }
{ "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" } } } ] } } } } } } ] }