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"
}
],
"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"
}
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "ut",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "cb1d3b03c975a5ec16041060"
},
"_id": "8660d04f1b95f75ecd1e6627",
"lastModifiedBy": "exercitation",
"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"
},
{
"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": "incididunt dolore",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "91d4f7c3d6b40329edcbe4b6"
},
"_id": "923990109876248db0e93119",
"lastModifiedBy": "ipsum ea",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "1 hour"
}
],
"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": "sint aliquip in sunt aute",
"imported": [
{
"success": true,
"message": "mollit nulla eu",
"original": {
"_id": "4176cff7c331d520eb5332b6",
"name": "test",
"data": {
"gbac": {
"write": [
"565e2af3c8d207816b478eb4",
"985236ba66d5df9a68337fdb",
"c2f79ce1ee563aee2dc17a6b",
"11d549fe14ac43c083b57d64",
"4b6c0435eac308b85eaae50b"
],
"read": [
"41c0b4a4004843f946f26830"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "fugiat cupidatat",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "2a76bc7e1ee14efe5a0b550b"
},
"lastModifiedBy": "do sunt proident culpa incididunt",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "1 hour"
},
"created": null
}
]
}
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"
}
]
}
}
}
}
}