Summary
Import automation documents
Description
Insert automation documents into the automation collection from a user supplied JSON document.
Route
POST /automation_catalog/automations/import
Roles
admin
other
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| automations |
array |
yes |
Array of automations |
| options |
object |
yes |
optional parameters |
Copied to Clipboard
{
"automations": [
{
"name": "test",
"data": {
"gbac": {
"write": [
{
"provenance": "Local AAA",
"name": "my admin group",
"description": "My short description"
},
{
"provenance": "Local AAA",
"name": "my admin group",
"description": "My short description"
},
{
"provenance": "Local AAA",
"name": "my admin group",
"description": "My short description"
},
{
"provenance": "Local AAA",
"name": "my admin group",
"description": "My short description"
}
],
"read": [
{
"name": "Itential Artifact",
"provenance": "Pronghorn",
"description": "My short description"
},
{
"name": "Itential Artifact",
"provenance": "Pronghorn",
"description": "My short description"
},
{
"name": "Itential Artifact",
"provenance": "Pronghorn",
"description": "My short description"
},
{
"name": "Itential Artifact",
"provenance": "Pronghorn",
"description": "My short description"
}
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "voluptate eu",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "09984b1c473ec661e2ab6c19"
},
"_id": "9883e2bd9f1fb2ebed72449c",
"lastModifiedBy": "et enim nulla qui dolor",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "3 weeks"
}
],
"options": {}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"automations": {
"title": "automations",
"type": "array",
"items": {
"$ref": "exportedAutomation"
}
},
"options": {
"title": "options",
"type": "object",
"properties": {
"adapterMap": {
"type": "object"
}
},
"additionalProperties": false
}
},
"required": [
"automations",
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| status |
object |
Status of automation import operation |
Copied to Clipboard
{
"status": "success",
"message": "voluptate laboris Excepteur irure",
"imported": [
{
"success": true,
"message": "amet magna esse fugiat do",
"original": {
"_id": "92ae7b9d26c76ece62e13f01",
"name": "test",
"data": {
"gbac": {
"write": [
"aecae1fb4be81c9c3fde2936",
"f810897ce324d7ba2235dd93",
"c23e0fc9d26f53b586e8e91b",
"d9ae15c9e74d0bc736ce84cc",
"b909fb85305fcb2e3fa8e013"
],
"read": [
"e2596c5eb4b2dd031ec88e68",
"ad83d5e2f75ff9464e0cfd03",
"d878e8ef1a5fcbf9d1cf5f97",
"edcf3379a09813b56d5a70a6"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "laborum ea cupidatat Lorem",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "e88d27995769a223388054af"
},
"lastModifiedBy": "mollit pariatur id laboris ea",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "2 months",
"migratedToOM": true,
"correspondingOMAutomationId": "2a8e1b82a07ab8a05910d91d"
},
"created": {
"_id": "456f965e40075ff7a144c5e5",
"name": "test",
"data": {
"gbac": {
"write": [
"06dd598238de2c45ce8f4857",
"ff10102524ab69c75599f689",
"35c70213e12ac9c6f55c6c51"
],
"read": [
"f6924a067a1320850cd30ca6",
"49d66be4ee12239cf998c8f6",
"eafd2f7be38da6a4a749fe70",
"462f381c23acbdf234ed8842",
"702d4d0dc3cbc35e26b747f0"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "ad aute",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "707d0cb15042145427e6f3b0"
},
"lastModifiedBy": "fugiat ad in esse",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "1 hour",
"migratedToOM": true,
"correspondingOMAutomationId": "882433afb7e7bc219b4daf2f"
}
}
]
}
Copied to Clipboard
{
"title": "status",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"message": {
"type": "string",
"example": "2 automations imported successfully"
},
"imported": {
"type": "array",
"items": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
},
"original": {
"$ref": "automationDocument"
},
"created": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "automationDocument"
}
]
}
}
}
}
}