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"
}
],
"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 aliqua Duis eiusmod velit",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "dc9c032d1400bdecc9f8b49a"
},
"_id": "3e211f914f1683fa51d2d215",
"lastModifiedBy": "ea",
"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": "in nisi reprehenderit magna",
"imported": [
{
"success": true,
"message": "ad",
"original": {
"_id": "545cb10b4c3448372d6f62a8",
"name": "test",
"data": {
"gbac": {
"write": [
"e1b66a750a83f3395f13f966",
"463e542def7989df538684fb"
],
"read": [
"050d3d4df1d567c3e451b561",
"bb377aeea9a0b22b61cc75b5",
"c8b2b02a5aeb865dc2cc7574",
"620fcdedd7ccc7d23b222d40",
"9d267711fd4edc5c77a573f1"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "officia ut sint",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "fa337d558fe98d49e6dc4681"
},
"lastModifiedBy": "aute aliqua eiusmod",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "1 day"
},
"created": {
"_id": "02bb31e4f6030b107ad62069",
"name": "test",
"data": {
"gbac": {
"write": [
"a0fa5ae7ee09ba934f205bf2",
"d7463e2a1c6790804493f023",
"96335e24722ffe4ef14de44e",
"606840c5247b01cf69125770",
"3772a8fa27f0fe41264784f6"
],
"read": [
"1a2a254dbb1450b448bd8d44"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "enim",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "abbba31da7e2719da70bd7fc"
},
"lastModifiedBy": "sunt laboris mollit",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "1 day"
}
},
{
"success": false,
"message": "mollit elit",
"original": {
"_id": "70814eff99fcffe92a562f80",
"name": "test",
"data": {
"gbac": {
"write": [
"759ff6514f47991391751ccf",
"ad3309873dd9f5d3f8d405e0",
"0f8deef9ba330dc72b3208a8",
"f9525af7038cd5a171f33134",
"70f1b389ec17b308bc622479"
],
"read": [
"8ec6f3e1a249b3b3237599bb"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "commodo irure ut ullamco",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "7638b523fbe2ecd64cd32d09"
},
"lastModifiedBy": "qui",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "3 weeks"
},
"created": null
},
{
"success": true,
"message": "in",
"original": {
"_id": "6dc16ed0d8d98d40ac58408a",
"name": "test",
"data": {
"gbac": {
"write": [
"3efb0e66c055b55a3f8821a7",
"fa8cea041abd7ba4cced6573"
],
"read": [
"daf0996f1ba59358478f91de",
"aa9127770309e7eabd6c888a",
"f362575d63e66c2a13a366a4"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "elit aute",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "b58f8768f12d2458c6879a14"
},
"lastModifiedBy": "labore laboris",
"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"
}
]
}
}
}
}
}