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
Parameters
Name | Type | Required | Description |
---|---|---|---|
automations | array | yes | Array of automations |
options | object | yes | optional parameters |
{ "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" } ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "laborum ad Lorem", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "d5b83d040658209508556fcd" }, "_id": "842cdbfe2c3cfc8d25d31830", "lastModifiedBy": "sed ullamco", "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" } ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "in dolor Ut proident aliqua", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "9c14a6416c758631de3c82ae" }, "_id": "c7debfe21ccc038d1ae54f05", "lastModifiedBy": "tempor mollit nulla incididunt", "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": "aute non sit elit dolore", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "95f5b28bd46f125584c1d588" }, "_id": "6182bdf69588453239eb33f6", "lastModifiedBy": "sunt elit dolore", "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" }, { "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": "reprehenderit Duis amet in dolore", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "58c79c8d00df3260867db6ef" }, "_id": "b958a166a777457d39bf38bb", "lastModifiedBy": "pariatur minim", "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" } ], "read": [ { "name": "Itential Artifact", "provenance": "Pronghorn", "description": "My short description" } ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "cillum", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "9f3cf28957e3f11540d37b59" }, "_id": "cdb29c3c43468b3b3d525858", "lastModifiedBy": "deserunt ut occaecat nostrud anim", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "3 weeks" } ], "options": {} }
{ "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
Name | Type | Description |
---|---|---|
status | object | Status of automation import operation |
{ "status": "success", "message": "labore consectetur in", "imported": [ { "success": true, "message": "ex quis nulla", "original": { "_id": "fbd2e9621f95e2b163007d31", "name": "test", "data": { "gbac": { "write": [ "b25f78ff72d72d571fc14551", "c7a71ec94f9e39acd839fd6d", "476ace726e4e66485e429d72", "77a7d00026bc5db0a63a32c8" ], "read": [ "27439dabce9ffdc1343c9df0", "72f693dc3365c5a7461080f6", "0ef0d25391ad064c2c264c07", "766fa0b016579e3f6706c639", "650981a2b1bb1fb75924bbba" ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "esse in sint in irure", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "14436c9c4f3166e96eb76952" }, "lastModifiedBy": "sint", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "2 months" }, "created": null } ] }
{ "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" } ] } } } } }