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" }, { "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": "proident", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "a5bde33202e48d04af5bb78f" }, "_id": "5b6fd2745aa352590bd30066", "lastModifiedBy": "occaecat", "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": "sit labore ipsum veniam laborum", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "7cf95553588ec9359b4306b5" }, "_id": "a0069b074833788a3d88869f", "lastModifiedBy": "enim velit exercitation sint in", "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": "minim laboris exercitation", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "516604317c394de90af1eb96" }, "_id": "7173e0015bc3a7768ff77c0b", "lastModifiedBy": "ullamco", "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": "sint Lorem reprehenderit officia", "imported": [ { "success": false, "message": "laborum do cupidatat minim ut", "original": { "_id": "32d53c852d8e31fb1dd2eb53", "name": "test", "data": { "gbac": { "write": [ "15171049dabbaaea59099eb4", "72536ea98250408b17e0196d", "8cc793b86d3b097e9c768fdf" ], "read": [ "ed6a58a4db94542bc53d6c6c" ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "nostrud ut voluptate irure aliqua", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "93d29543597d28bf1f684cd8" }, "lastModifiedBy": "Lorem incididunt deserunt sint", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "2 months", "migratedToOM": false, "correspondingOMAutomationId": "07b1fd7ed7132bde41519184" }, "created": null }, { "success": false, "message": "non nulla incididunt dolor", "original": { "_id": "b594a9f63085282d2462274b", "name": "test", "data": { "gbac": { "write": [ "d899bdae7ffc0c9cac3b32ec", "708f4ed4d8675594cd8304c2", "db0e720683d8588c511613a7", "2024502db59a9cf5366016b1", "22be4ba757d72026ab46b44d" ], "read": [ "5fd68db198df5be3422388ff", "17de52779bb370b4efb7c23e", "64e99897e663828919adc6e6" ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "aliquip", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "5d99d5ececbc7eb13d550ab2" }, "lastModifiedBy": "occaecat amet", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "1 hour", "migratedToOM": true, "correspondingOMAutomationId": "1f818ca91b64d64f43c9d880" }, "created": null }, { "success": true, "message": "est veniam velit", "original": { "_id": "a90e2d2b049370dacb58c716", "name": "test", "data": { "gbac": { "write": [ "addb512be718353a934dda68" ], "read": [ "dc747f5dee6a3748a10762ac", "eef926605727256f3dafeb1d", "38861d4ea156d0540a5fc8ad", "a73692b3c64a7906db6b8a48", "d8c589d163caf7ecce148991" ] }, "lastUpdated": "2019-11-25T22:51:39.201Z", "description": "in ut dolor culpa", "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a", "formId": "c8b8aaf9b9bee4ff4bcb3b62" }, "lastModifiedBy": "aliquip labore pariatur anim eu", "lastRunAt": "2019-11-25T22:51:39.201Z", "nextRunAt": "2019-11-25T22:51:39.201Z", "repeatInterval": "3 weeks", "migratedToOM": false, "correspondingOMAutomationId": "a55efc00c789a785d2323d1e" }, "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" } ] } } } } }