Sign in
projectAutomations

Updates the automation with the specified id.

Updates the automation with the specified id. The user needs to be the owner of the project or have 'write' permissions of the feature 'project-master-data' globally or in the project. If the automation was created from a workflow, only the Enabled flag can be changed.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

put/projects/{projectId}/automations/{automationId}

Path parameters

automationIdstring uuid required

The id of the automation.

projectIdstring uuid required

The id of the project.

Headers

Authorizationstring required

Bearer authentication

Request body

enabledboolean required

Whether the automation is enabled.

Response

OK

idstring uuid

The id of the automation.

createdBystring uuid

The id of the user who created the automation.

createdOnstring date-time

The date the automation was created.

updatedBystring uuid

The id of the user who updated the automation.

updatedOnstring date-time

The date the automation was updated.

triggerIdstring uuid

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

enabledboolean

Whether the automation is enabled.

statestring nullable

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

createdByProjectTemplateboolean

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

projectIdstring uuid nullable

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

projectTemplateIdstring uuid nullable

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

workflowIdstring uuid nullable

The workflow this automation belongs to, if any.

createdByAutomationIdFromWorkflowstring uuid nullable

The id of the workflow automation that served as the template for this automation.

Changes

Changed in 1 of the 5 revisions of this API.2

  • a13e7c7042622See the full diff
    • ▲

      the trigger/type request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the trigger/values/items/name request property's minLength was increased from 0 to 1

      request-property-min-length-increased