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"
},
{
"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": "ipsum",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "6463d46a6999cab44801d0ce"
},
"_id": "81c729421d7d06c538cac62e",
"lastModifiedBy": "aliquip minim nisi ex culpa",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "2 months"
},
{
"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": "in do id ad",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "9bba9ce698a192f56f00c439"
},
"_id": "2883b543a5a2b63157217e0e",
"lastModifiedBy": "et",
"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": "eu ut Lorem",
"imported": [
{
"success": true,
"message": "ea",
"original": {
"_id": "615b837672b3dfa891f7c666",
"name": "test",
"data": {
"gbac": {
"write": [
"15c7c59be8e9035fe1d138f9",
"9d84e09d4d11f6483f7b58ce"
],
"read": [
"a9c167886ef5d54766e98261",
"b7aa07f4e20eac4657f47d57",
"6e90599b3488df65d5ec330a",
"beab18586459d8bf8c032483",
"efb9d02ae6fbd4ffbe08cc7a"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "veniam nostrud adipisicing quis",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "68b0ccf5c8add081a03f15be"
},
"lastModifiedBy": "laboris aliquip exercitation ut",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "1 hour",
"migratedToOM": false,
"correspondingOMAutomationId": "3a01922ae4b0549670abf760"
},
"created": {
"_id": "db958b67ee4b143bea027fa7",
"name": "test",
"data": {
"gbac": {
"write": [
"f909213475104d3827dad8b4",
"391a64015e2fef5714cf4a0c",
"f3da93c1946326687d26905e"
],
"read": [
"84c3d4b0e979702e2ba79d54",
"9fd66704941faa3137e577bd",
"c6af9cc96268d59b3b63ab45",
"cbe6e3790820efac8ce18919"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "do tempor ea quis dolore",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "d55d504e40d8b2a84cad7712"
},
"lastModifiedBy": "elit est",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "3 weeks",
"migratedToOM": false,
"correspondingOMAutomationId": "1dea1ff6fc45e0f27e620618"
}
}
]
}
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"
}
]
}
}
}
}
}