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" }, { "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": "velit ut dolor", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "3c49aaec2cd1fcf29d852efa" }, "_id": "5e71d7363ed8c37ef224801f", "lastModifiedBy": "tempor culpa", "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": "sint magna ut ullamco enim", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "1f9223330bc4f3f84c7c8875" }, "_id": "87fc268dc2534a29df92f85b", "lastModifiedBy": "consectetur", "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" } ], "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": "esse Lorem commodo incididunt", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "f195e5d9e9b442f014296a46" }, "_id": "8391b25902b2a224370bc560", "lastModifiedBy": "est mollit nulla quis", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "2 months" } ], "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": "sunt dolore in", "imported": [ { "success": true, "message": "laboris aute sunt dolor", "original": { "_id": "2f4168c29a53bf843e7980ae", "name": "test", "data": { "gbac": { "write": [ "e8f8f17c6caadaf098c06a38" ], "read": [ "81bb1906f56ba5c9d2cc770b", "adab127f27a73dd71b3ffc56", "df26cfc937b6c7c10139c31e" ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "velit nulla ex", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "06a24b714628bcf077e7db48" }, "lastModifiedBy": "aliquip eiusmod culpa ullamco", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "2 months", "migratedToOM": true, "correspondingOMAutomationId": "5e2956b082d8b83d998e9322" }, "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" } ] } } } } }