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": "14f5adb24a0819e24f0ad424",
"gbac": {
"write": [
{
"provenance": "ldap",
"name": "admins",
"description": "Description of a group"
},
{
"provenance": "ldap",
"name": "admins",
"description": "Description of a group"
},
{
"provenance": "localAAA",
"name": "operators",
"description": "Description of a group"
},
{
"provenance": "ldap",
"name": "admins",
"description": "Description of a group"
},
{
"provenance": "localAAA",
"name": "admins",
"description": "Description of a group"
}
],
"read": [
{
"provenance": "ldap",
"name": "designers",
"description": "Description of a group"
}
]
},
"componentName": null,
"createdBy": "eiusmod sit adipisicing",
"created": "2020-10-04T18:17:33.638Z",
"lastUpdatedBy": null,
"lastUpdated": "1962-11-27T16:37:11.467Z",
"triggers": [
{
"name": "myCoolDocumentName",
"type": "endpoint",
"enabled": false,
"actionType": "automations",
"actionId": "0fdee74187b90f3177f81a3b",
"verb": "POST",
"routeName": "g7bOPhHZ",
"_id": "ea32fd761d6ba84509b777ae",
"jst": null,
"description": "Some helpful information about the document",
"lastExecuted": null,
"migrationVersion": -26773717,
"createdBy": null,
"created": "1979-04-27T06:43:42.891Z",
"lastUpdatedBy": "do qui adipisicing",
"lastUpdated": "1955-07-09T18:16:38.104Z"
},
{
"name": "myCoolDocumentName",
"type": "endpoint",
"enabled": false,
"actionType": "automations",
"actionId": "c97b06f2d67908e09a0a7ddb",
"verb": "POST",
"routeName": "DP4SdQXJt",
"_id": "f5b64e54c70d546e60f46842",
"jst": null,
"description": "Some helpful information about the document",
"lastExecuted": null,
"migrationVersion": -30435882,
"createdBy": "est fugiat deserunt",
"created": "1956-12-28T13:47:01.275Z",
"lastUpdatedBy": null,
"lastUpdated": "1951-12-17T21:30:11.597Z"
}
]
}
],
"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 imported 3 of 4 documents",
"data": [
{
"success": true,
"data": {
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"componentType": "ucm_compliance_plans",
"createdBy": "Pronghorn",
"created": "1996-05-24T05:31:07.0Z",
"lastUpdatedBy": "05240f8e394c711f61059b7c",
"lastUpdated": "1998-02-21T23:06:05.387Z",
"_id": "3834cabfbe8880b7faf809fe",
"gbac": {
"write": [
"85e9b336b659d1ade6b4d9a6",
"4d53858abc62c5d9e9a0e388",
"99ced297de4456b2d48a75d1",
"261f52e94514d145869fed63"
],
"read": [
"c4149b4d6f7ed092924505e5",
"7689f2ac13f5abe75f51aebb",
"5511ab5a58cece2665b8d81d"
]
},
"componentId": "5284026935a17223058f90bb"
}
}
]
}
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"
}
}
}
]
}
}
}
}
}
}
]
}