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"
}
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "id Excepteur qui",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "55292953652e63030d34746e"
},
"_id": "9d247c7938cd2faeca21cd20",
"lastModifiedBy": "ipsum",
"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",
"imported": [
{
"success": false,
"message": "nostrud Excepteur irure nisi cupidatat",
"original": {
"_id": "58875142bcd5b43df9b4ab38",
"name": "test",
"data": {
"gbac": {
"write": [
"ac36248a84343cc7db379ab7",
"b44591478cb2aac5b1a5d01d"
],
"read": [
"acb46b9153bbcb54aecbcd71"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "laboris",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "0025a351dcc95143c787f7d7"
},
"lastModifiedBy": "exercitation",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "3 weeks"
},
"created": null
},
{
"success": true,
"message": "magna do laborum",
"original": {
"_id": "1f77dc550fd22983b4048e28",
"name": "test",
"data": {
"gbac": {
"write": [
"699c319095289b79d470be11",
"3410c63a22203715000c6af9",
"60501a733e3d68aa0f02aafe",
"75dd0785a9ff3574780f3f4f",
"b362782c4959697d1b8ce8d1"
],
"read": [
"dcb029c820909f101af69ec0",
"74004deaf5eb8cfbf207dfe7",
"58cb3af5b3a2cb221bbca0f5",
"c037c4db72c68b13115a796c",
"3a45114dd96a542802e34222"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "nostrud sed velit fugiat",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "e1d20efb619eb1a6ed9eee42"
},
"lastModifiedBy": "ad minim",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "1 hour"
},
"created": null
},
{
"success": false,
"message": "enim",
"original": {
"_id": "2846fa00e4d5076c4a4ae730",
"name": "test",
"data": {
"gbac": {
"write": [
"f98324d0a05c31be7182eba2",
"76ef7a5872166bb2db06c58e"
],
"read": [
"518b3744ee83a84a5e6b5eee"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "qui in eu exercitation in",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "ece0a0b91b90d6fa83dbbe2f"
},
"lastModifiedBy": "labore pariatur",
"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"
}
]
}
}
}
}
}