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" }, { "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": "Lorem in Duis exercitation", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "b4533855446751a191061882" }, "_id": "4fbf7d8b9e56018228d7e3df", "lastModifiedBy": "tempor eiusmod sed", "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" } ], "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": "Excepteur est", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "66703f33f63d1268827f2e3f" }, "_id": "2d388c0bb30f6f371b6b6c51", "lastModifiedBy": "cupidatat Excepteur nisi", "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" }, { "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": "elit velit eu aliqua", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "855cad6633e028e1120c7f18" }, "_id": "839819587adab88ddca7c7da", "lastModifiedBy": "fugiat ad consequat pariatur", "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" }, { "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": "dolor pariatur", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "149afc9beae08cb605be9259" }, "_id": "c274cc8423ddd8f32d1497b1", "lastModifiedBy": "ipsum velit ut 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": "ut", "imported": [ { "success": true, "message": "sit sed minim", "original": { "_id": "88f82d0b50c490f728361692", "name": "test", "data": { "gbac": { "write": [ "9c76c831ee1e45ebf901dd79" ], "read": [ "0a2c18f0aff3da7abb21c53e", "2859fc6a030df586a9ba006d", "f933c473ccd604266a0ae139", "63b0dc872c781292c351a8e5" ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "in", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "b5c34ace2dc75357b97769ae" }, "lastModifiedBy": "eu", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "2 months", "migratedToOM": true, "correspondingOMAutomationId": "75838437a05b6f5372bd4798" }, "created": null }, { "success": false, "message": "do magna enim", "original": { "_id": "6d39bf4b2a33266d17443c38", "name": "test", "data": { "gbac": { "write": [ "0a48374fce0301f7d498fa90", "d797b5fd384da94f10001e36", "66a10fc69f69c5c50fd209c0", "f82feb8aee9101b4390e1560" ], "read": [ "1bf6a3f0b0d0d11a4e53b618", "73591d5d7244c34220599618" ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "proident amet non", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "fe6cda1291984945d2f65b32" }, "lastModifiedBy": "Excepteur commodo mollit Lorem", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "3 weeks", "migratedToOM": true, "correspondingOMAutomationId": "01943d4ac57851e7cbdcfc20" }, "created": { "_id": "c638e4540fa473fd05eb1b06", "name": "test", "data": { "gbac": { "write": [ "1dc2e4ea7c1b9d78ab4797dd", "080636637153e82eb919337c", "519138a1fb94fa4ca631fd3d", "00ce69e663ffb54d6ace1a0c", "18e00cb4e8fae3d37c7dcdd3" ], "read": [ "59d1f27c6fac6b28071ae2c1" ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "in aliquip occaecat dolore", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "3636e192e168a218598465a0" }, "lastModifiedBy": "in", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "3 weeks", "migratedToOM": true, "correspondingOMAutomationId": "1d2f57f45e98025154992d84" } }, { "success": true, "message": "eiusmod ut", "original": { "_id": "425c9b2a78d5b3bdaad9f089", "name": "test", "data": { "gbac": { "write": [ "192b8a04a471a6201f9890fd" ], "read": [ "d0da3eac078c9c7f2f55caaf", "cdf645d805e114392f15982a", "e32ba95bd9c3255ebfc06c0f", "88d80230445d075294e1a4d9" ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "aliqua", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "bd5fdeeb3397876761da339f" }, "lastModifiedBy": "proident officia quis eiusmod", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "3 weeks", "migratedToOM": false, "correspondingOMAutomationId": "6706c8441256aef1c7261c9f" }, "created": { "_id": "0efc9bf5baac3eaed4032b12", "name": "test", "data": { "gbac": { "write": [ "e185f9a2b5aa078672e4af8f", "1d58da50531e89295f49e530", "ffa236d1d352a7db3ea50d2d" ], "read": [ "7e68000733894767aa843fe1" ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "commodo mollit Excepteur nisi", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "97c0a9c0f1f795ea0ae2398c" }, "lastModifiedBy": "nulla aute sunt", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "1 hour", "migratedToOM": true, "correspondingOMAutomationId": "1c7a22104df288b00c31158d" } } ] }
{ "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" } ] } } } } }