Creates a new automation for a given projecttemplate. | awork API

1 import requests 2 3 url = "https://api.awork.com/api/v1/projecttemplates/projectTemplateId/automations" 4 5 payload = { "type": "task-created" } 6 headers = { 7 "Authorization": "Bearer <token>", 8 "Content-Type": "application/json" 9 } 10 11 response = requests.post(url, json=payload, headers=headers) 12 13 print(response.json())

1 { 2 "id": "123e4567-e89b-12d3-a456-426614174000", 3 "createdBy": "123e4567-e89b-12d3-a456-426614174000", 4 "createdOn": "2024-01-15T09:30:00Z", 5 "updatedBy": "123e4567-e89b-12d3-a456-426614174000", 6 "updatedOn": "2024-01-15T09:30:00Z", 7 "triggerId": "123e4567-e89b-12d3-a456-426614174000", 8 "trigger": { 9 "updatedOn": "2024-01-15T09:30:00Z", 10 "type": "task-created", 11 "values": [ 12 { 13 "name": "name", 14 "value": "Design" 15 } 16 ] 17 }, 18 "enabled": true, 19 "state": "string", 20 "createdByProjectTemplate": false, 21 "projectId": "123e4567-e89b-12d3-a456-426614174000", 22 "projectTemplateId": "123e4567-e89b-12d3-a456-426614174000", 23 "actions": [ 24 { 25 "id": "123e4567-e89b-12d3-a456-426614174000", 26 "createdBy": "123e4567-e89b-12d3-a456-426614174000", 27 "createdOn": "2024-01-15T09:30:00Z", 28 "updatedBy": "123e4567-e89b-12d3-a456-426614174000", 29 "updatedOn": "2024-01-15T09:30:00Z", 30 "type": "tag-add-task", 31 "order": 2, 32 "values": [ 33 { 34 "name": "tag", 35 "value": "Design" 36 } 37 ] 38 } 39 ], 40 "failed": { 41 "code": "string", 42 "description": "string", 43 "link": "string", 44 "details": [ 45 "string" 46 ], 47 "validationErrors": [ 48 { 49 "property": "string", 50 "message": "string" 51 } 52 ], 53 "traceId": "string" 54 } 55 }

Creates a new automation of the projecttemplate with the specified id. To create the the automation the user needs to have ‘write’ permissions of the feature ‘project-manage-config’ globally.

Required Permissions

The user must be an admin or have project-manage-config:write permissions.

Creates a new automation of the projecttemplate with the specified id. To create the the automation the user needs to have 'write' permissions of the feature 'project-manage-config' globally. <Check title="Required Permissions">The user must be an admin or have project-manage-config:write permissions.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

projectTemplateIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.

typestringRequired>=1 character

The type of the trigger.

valueslist of objects or nullOptional

The values of the trigger.

Response

idstring or nullformat: "uuid"

The id of the automation.

createdBystring or nullformat: "uuid"

The id of the user who created the automation.

createdOnstring or nullformat: "date-time"

The date the automation was created.

updatedBystring or nullformat: "uuid"

The id of the user who updated the automation.

updatedOnstring or nullformat: "date-time"

The date the automation was updated.

triggerIdstring or nullformat: "uuid"

The id of the trigger which is related to the automation.

triggerobject or null

enabledboolean or null

Whether the automation is enabled.

statestring or null

The state of the automation. See AutomationsService.DAL.Models.AutomationState for the possible values.

createdByProjectTemplateboolean or null

Whether the automation was created from an automation template of a project template.

projectIdstring or nullformat: "uuid"

The id of the project which is related to the automation.

projectTemplateIdstring or nullformat: "uuid"

The id of the project template which is related to the automation.

actionslist of objects or null

The actions which is related to the automation.

failedobject or null