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": "do labore",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "bb7cbde1993408f22bd1cdcd"
},
"_id": "f2ea5c2bfb92fd8e412745d6",
"lastModifiedBy": "in esse veniam culpa",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "3 weeks"
},
{
"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"
}
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "veniam",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "7a8541cb5c612bbd449174d2"
},
"_id": "45601739a226a1a398b950e5",
"lastModifiedBy": "est",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "1 day"
}
],
"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": "irure ut nostrud",
"imported": [
{
"success": false,
"message": "consectetur laboris ex aliquip",
"original": {
"_id": "cdf2da7c5b8f6eda9e5cc2a2",
"name": "test",
"data": {
"gbac": {
"write": [
"f8ee83822a9435227260da49",
"c64dcd04d5ddd06c4a7080c7"
],
"read": [
"f786ce60f387fbfc38a1b6ec",
"43030682af598ec817f7f9b8",
"06fe2eda04bad75d0d505456",
"4f1e4eab34d5ec37d4a59b42",
"5861748c17afc15930f68d5a"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "esse ut culpa",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "e53b3ef83e63e2763145ea94"
},
"lastModifiedBy": "est eu",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "2 months"
},
"created": {
"_id": "3ef8819cdbe08220f127bcf9",
"name": "test",
"data": {
"gbac": {
"write": [
"e508ad4ffd632416e4c02fdf"
],
"read": [
"5d01f0d7c8ba1219c415ed3b"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "ipsum sed labore anim",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "44ce50f85dfa7a8e8f4c634d"
},
"lastModifiedBy": "nisi occaecat dolor et adipisicing",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "2 months"
}
}
]
}
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"
}
]
}
}
}
}
}