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": "7f40972926477bcd4286d952",
"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": "ldap",
"name": "admins",
"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": "ldap",
"name": "designers",
"description": "Description of a group"
}
]
},
"componentName": null,
"createdBy": null,
"created": "1984-03-16T20:39:37.112Z",
"lastUpdatedBy": "in incididunt aute",
"lastUpdated": "1968-05-29T21:16:50.26Z",
"triggers": [
{
"name": "myCoolDocumentName",
"type": "endpoint",
"enabled": false,
"actionType": "automations",
"actionId": "16929620ffe3cf826aa64e06",
"verb": "POST",
"routeName": "tfYiRK3BdZt",
"schema": null,
"_id": "3b672854aa12b95dce0098ee",
"jst": null,
"description": "Some helpful information about the document",
"lastExecuted": null,
"migrationVersion": -72315366,
"createdBy": "est minim magna quis",
"created": "1958-07-19T23:31:41.651Z",
"lastUpdatedBy": "ex dolor",
"lastUpdated": "2004-11-10T00:15:36.422Z"
}
]
}
],
"options": {
"adapterMap": {
"staging": "production"
}
}
}
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 retrieved search results",
"data": [
{
"success": false,
"data": {
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"componentType": null,
"createdBy": "aeb3f69ec9f79d808324885d",
"created": "2011-04-03T12:51:11.597Z",
"lastUpdatedBy": "0ca672f5693ab84dbdb2bd61",
"lastUpdated": "1946-11-15T04:30:34.543Z",
"_id": "0b52bda585bbdee167363148",
"gbac": {
"write": [
"aca9ff975f469edddb8ca034",
"e1a9e5b649b1372062301010",
"5d4a547e794df00dc881cc22"
],
"read": [
"a790e1b94fb86e893e39f0b1",
"d5964bcdf1ec9c771d8d8bb5",
"063a06070ad888276e96dd70",
"9936fdf043f0fc0430eeadc3",
"51d223339617df36ae81be60"
]
},
"componentId": null
}
},
{
"success": false,
"data": {
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"componentType": "ucm_compliance_plans",
"createdBy": "Pronghorn",
"created": "1952-09-13T16:15:37.619Z",
"lastUpdatedBy": "Pronghorn",
"lastUpdated": "1998-07-06T01:07:36.592Z",
"_id": "b18828abd17c4bb821f403f6",
"gbac": {
"write": [
"1f29121dd52bd7970458fbce",
"786319ed6f9ff3fc0907b9e7",
"7d0bacf19983a5adc9453f66"
],
"read": [
"e9485772b491e165cdf62a91",
"bc8c1100241fbca9dc29cac6",
"4c9bd25eef3ce90937cef88c",
"aa977492683ec60fc860f237"
]
},
"componentId": "3Cd07e91-c3Ae-AfFa-9e47-A2fad2d0353F"
}
}
]
}
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"
}
}
}
]
}
}
}
}
}
}
]
}