Summary
Creates an automation
Description
Creates an automation with optional description. An automation's root structure is based off the agendajs library, with any custom data falling into the 'data' array
Route
POST /automation_catalog/automations
Roles
admin
other
apiread
Parameters
Details Example Schema
Name
Type
Required
Description
name
string
yes
Unique name of the automation
description
string
yes
Short description of the automation.
Copied to Clipboard
{
"name": "My fancy automation name",
"description": "commodo eiusmod occaecat"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"name": {
"title": "name",
"type": "string",
"minLength": 1,
"examples": [
"My fancy automation name"
],
"description": "Name of the automation. Two automations may not share the same name."
},
"description": {
"title": "description",
"type": "string",
"example": [
"My optional description"
]
}
},
"required": [
"name",
"description"
],
"additionalProperties": false
}
Return
Details Example Schema
Name
Type
Description
result
object
Automation document that was created by the request
Copied to Clipboard
{
"_id": "193a326e536cecb87d86b410",
"name": "test",
"data": {
"gbac": {
"write": [
"c26ee6ba76c4a4a218591a4b",
"f123a124705b007eaa247619",
"d6b29beb55e859eb5499263e"
],
"read": [
"2753f8a3ecd4bee22e225d47",
"b698b2956a6f6abf8a702707"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "sed dolore laborum labore",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "e172feecd7b58e5ec0fd3c59"
},
"lastModifiedBy": "nulla fugiat elit consequat labore",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "1 day",
"migratedToOM": false,
"correspondingOMAutomationId": "e2d89aba0bffc40553e23647"
}
