Documentation

Class

ProjectTemplateActions

ProjectTemplateActions(client, projectTemplateId, automationId)

Class corresponding to Aworks ProjectTemplateActions Endpoints
Constructor

# new ProjectTemplateActions(client, projectTemplateId, automationId)

Endpoint constructor
Parameters:
Name Type Description
client Client
projectTemplateId String The id of the project.
automationId String The id of the automation.
See:
  • [ProjectTemplateActions in Awork API Docs](https://openapi.awork.com/#/ProjectTemplateActions)

View Source endpoints/ProjectTemplateActions.js, line 9

Classes

ProjectTemplateActions

Methods

# async create(action) → {Promise.<Action>}

Creates an action for a specific automation of a projecttemplate including all its values. The user needs 'write' permissions of the feature 'project-manage-config' to create action data.
Parameters:
Name Type Description
action ActionCreateModel The model to create an action.

View Source endpoints/ProjectTemplateActions.js, line 65

Promise.<Action>

# async delete(actionId) → {Promise.<void>}

Deletes an action for a specific automation of a projecttemplate including all its values. The user needs 'write' permissions of the feature 'project-manage-config' to delete action data.
Parameters:
Name Type Description
actionId String The id of the action.

View Source endpoints/ProjectTemplateActions.js, line 93

Promise.<void>

# async get(actionId) → {Promise.<Action>}

Returns a specific action for a specific automation of a projecttemplate including all its values. The user needs 'read' permissions of the feature 'project-manage-config' to view action data.
Parameters:
Name Type Description
actionId String The id of the action.

View Source endpoints/ProjectTemplateActions.js, line 30

Promise.<Action>

# async list(optionsopt) → {Promise.<Array.<Action>>}

Returns all actions for a specific automation of a project template including all its values. The user needs 'read' permissions of the feature 'project-manage-config' to view action data.
Parameters:
Name Type Attributes Description
options ListOptions <optional>
 Pagination and filtering options.

View Source endpoints/ProjectTemplateActions.js, line 41

Promise.<Array.<Action>>

# async update(actionId, action) → {Promise.<Action>}

Updates a specifc action of an automation of a projecttemplate. Returns an updated action for a specific automation of a projecttemplate including all its values. The user needs 'write' permissions of the feature 'project-manage-config' to update action data.
Parameters:
Name Type Description
actionId String The id of the action.
action ActionUpdateModel The model to update an action.

View Source endpoints/ProjectTemplateActions.js, line 82

Promise.<Action>

# async updateOrder(actionId, order) → {Promise.<Action>}

Updates the order of a given action.
Parameters:
Name Type Description
actionId String The id of the action.
order Number The order of the automation within a list.

View Source endpoints/ProjectTemplateActions.js, line 103

Promise.<Action>