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" } ], "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": "sunt ut magna adipisicing", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "a6e4bc4fb76c7b5429525ec6" }, "_id": "43d0c889de56f319998baf25", "lastModifiedBy": "ipsum laboris Excepteur ullamco", "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" } ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "aute labore laboris", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "a5d07971b42bd43a4fc9bfb9" }, "_id": "81f3d2f642142b4548c086e7", "lastModifiedBy": "consectetur ut esse cupidatat id", "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" } ], "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": "in sit in ad minim", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "9109b09d8a0f233aee44294e" }, "_id": "4925d997fb8282becc75631b", "lastModifiedBy": "aliquip labore veniam officia", "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" }, { "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": "sit dolore", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "bc669314e93bd3ce6c856879" }, "_id": "cc69f0e826b1b4bc4f7d3507", "lastModifiedBy": "velit et consequat officia culpa", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "1 hour" }, { "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" }, { "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 ut consequat aute", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "0ac34af3cd840d080e4403ef" }, "_id": "7ade180b218e4c35e5049fe5", "lastModifiedBy": "amet anim", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "1 hour" } ], "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": "elit irure proident tempor dolor", "imported": [ { "success": false, "message": "veniam irure qui culpa cillum", "original": { "_id": "f3e085fc72ce72a7c97adf9b", "name": "test", "data": { "gbac": { "write": [ "797fcdf58f93d17f360814a6" ], "read": [ "60b20569647c542ca5304fe6", "9679481e3c461fa1fbbbc2d6" ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "pariatur voluptate dolore", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "e70065aed16daff1eef1edd5" }, "lastModifiedBy": "elit", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "2 months" }, "created": { "_id": "f26d1b05eb7d0e423e93cd87", "name": "test", "data": { "gbac": { "write": [ "28884ee6176ac8a4363223b7", "179edc802898bbb3225f0590" ], "read": [ "2f1ce37e807d387ffcce689c" ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "nostrud elit adipisicing", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "e2363c95008bc9f147bf9097" }, "lastModifiedBy": "qui enim consectetur laborum", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "2 months" } } ] }
{ "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" } ] } } } } }