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
readonly
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"
}
],
"read": [
{
"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": "ea cupidatat incididunt esse",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "1ff21cfdd15b1aba303ab94d"
},
"_id": "e8bb8305200c2abf77a0917f",
"lastModifiedBy": "veniam",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "1 day"
},
{
"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"
},
{
"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"
}
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "irure fugiat dolore sed",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "852525a041ef8e0715d7458a"
},
"_id": "d2ee474f92376e5001b1135c",
"lastModifiedBy": "veniam do nulla",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "2 months"
}
],
"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": "anim voluptate aute tempor"
}
Copied to Clipboard
{
"title": "status",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"message": {
"type": "string",
"example": "2 automations imported successfully"
}
}
}