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" }, { "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": "quis sunt pariatur aliqua", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "ac47b0a008d65ad0d4e278e4" }, "_id": "972d068a18ee068dc05ce58c", "lastModifiedBy": "adipisicing laboris", "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" } ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "mollit", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "72a53fcff1634d41c684fe21" }, "_id": "867540eb2330820fbf8ccfba", "lastModifiedBy": "id laboris ipsum dolore cupidatat", "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": "quis laboris", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "81784a289671996642f1297b" }, "_id": "048224cd021f75a3c1f14ed5", "lastModifiedBy": "qui sunt anim eiusmod cupidatat", "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": "ut ipsum reprehenderit elit", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "f823b6c40ef3a11c2d701328" }, "_id": "dd514a84fd290514e81d52eb", "lastModifiedBy": "ut", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "1 day" } ], "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": "id et in", "imported": [ { "success": true, "message": "ut ipsum", "original": { "_id": "e997b5ba0024e6e12285605c", "name": "test", "data": { "gbac": { "write": [ "14bf1575c32963f28d3da53b", "a2a0f6d2081d56ee60db5ac7", "0e8fe4ffa6a63677b5903254" ], "read": [ "f2dfdba0d51015f66670fa6f", "74fbe4643b59619cb79ef534", "d975af6a0dcb3d9d8afe0a84" ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "sit voluptate id consequat veniam", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "1badf3c61dd223a27febdc6c" }, "lastModifiedBy": "commodo cupidatat in aliquip consectetur", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "1 day" }, "created": { "_id": "17d07f9c70a383de80cea204", "name": "test", "data": { "gbac": { "write": [ "3e0ffd1309bd88beda384fa8", "fcf8d7441aa4455de4ecfb86", "07fbe7baf53cfe39bc3b9676", "5db7d8f8d512b3775ec19063" ], "read": [ "cf2ac23274db3880f2ed5bb9", "d3d46b52d4a5ad434fbed91e", "3dcfe17e816867f9c02270f0", "03ad71b66145f32930656073" ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "proident labore fugiat ut", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "e73f4fe62dc5a9755a8e4d67" }, "lastModifiedBy": "tempor dolor sint sed", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "1 day" } }, { "success": true, "message": "incididunt fugiat", "original": { "_id": "9271b33a0312b06e4e4b288e", "name": "test", "data": { "gbac": { "write": [ "76a8f8ffa146901e421d009b", "5a0886da1058f07a0057501c" ], "read": [ "724b9f9c9239dc9b9b7eef48" ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "magna incididunt", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "ed4078994648488dff351e54" }, "lastModifiedBy": "aute aliqua nostrud", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "1 day" }, "created": null }, { "success": false, "message": "est dolor enim", "original": { "_id": "6f35e6f3d2350f478e35e0f5", "name": "test", "data": { "gbac": { "write": [ "16bd43c4577f6efeaf070c2b" ], "read": [ "6fad408f3cc9a147d5880593", "2270b351fb1c5fa4f7ec1fa0", "9b3060f678aeaae52c446688", "0413538beca6c26254f1867c" ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "ullamco ut eiusmod officia", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "5cf305b3dcfbf4287a3de218" }, "lastModifiedBy": "exercitation labore proident Excepteur", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "1 hour" }, "created": null }, { "success": false, "message": "in ipsum est anim", "original": { "_id": "9ecde90ca3437ae7d2c35ec5", "name": "test", "data": { "gbac": { "write": [ "344927df8b938b813c53d050", "e50df16b1f9a75f687f2401e", "54b7380855397de8f06f4aeb", "9c1a3ac3ae8a2d73e9a45dd7", "74b61ed649e18ecf75352de4" ], "read": [ "8ce92ed26841e319a94d7ae9", "2263c92893def50e0253bdde" ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "Excepteur", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "da3cd2477d796ddf148b0f0d" }, "lastModifiedBy": "ut esse ad Duis", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "1 hour" }, "created": null }, { "success": false, "message": "aute dolor", "original": { "_id": "08cce95e4312f32914733f21", "name": "test", "data": { "gbac": { "write": [ "e8cc38edecb2ac54d8442cad", "a0e3737d7a5da8aaac8ade65", "05b478349f98f395ee380e1b" ], "read": [ "b0e6989dfb0e3d61537e3f68", "40989acd95f25f21236f1981" ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "sint eiusmod voluptate pariatur", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "a4eead756ffe703fc9688e29" }, "lastModifiedBy": "commodo ex", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "1 day" }, "created": { "_id": "96d33def288e1dd9377f1206", "name": "test", "data": { "gbac": { "write": [ "ad96fc98b56386852aaa6a16", "797d2f2907add5f2842a0dac", "b0b75349c574c8d12ff450bf", "3f47ac406b643b6404b12938", "58442010a6483ef0e16b44ed" ], "read": [ "3d1e37212da5879aae9f3b2b" ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "fugiat", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "a84388c7050d1836e3b093cf" }, "lastModifiedBy": "in ullamco cupidatat cillum", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "1 day" } } ] }
{ "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" } ] } } } } }