Documentation

Class

ProjectActions

ProjectActions(client, projectId, automationId)

Class corresponding to Aworks ProjectActions Endpoints
Constructor

# new ProjectActions(client, projectId, automationId)

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

View Source endpoints/ProjectActions.js, line 9

Classes

ProjectActions

Methods

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

Creates a new action including its values for an automation. The user needs to be owner of the project or needs permission 'write' of the feature 'project-master-data' globally or in the project.
Parameters:
Name Type Description
action ActionCreateModel The model to create an action.

View Source endpoints/ProjectActions.js, line 65

Promise.<Action>

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

Deletes an action for an automation including all its values. The user needs to be owner of the project or needs permission 'write' of the feature 'project-master-data' globally or in the project.
Parameters:
Name Type Description
actionId String The id of the action.

View Source endpoints/ProjectActions.js, line 92

Promise.<void>

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

Get a specific action including its values of an automation. The user needs to be owner of the project or needs permission 'read' of the feature 'project-master-data' globally or in the project.
Parameters:
Name Type Description
actionId String The id of the action.

View Source endpoints/ProjectActions.js, line 30

Promise.<Action>

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

Gets all actions including their values of an automation. The user needs to be owner of the project or needs permission 'read' of the feature 'project-master-data' globally or in the project.
Parameters:
Name Type Attributes Description
options ListOptions <optional>
 Pagination and filtering options.

View Source endpoints/ProjectActions.js, line 41

Promise.<Array.<Action>>

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

Updates an exsting action including its values for an automation. The user needs to be owner of the project or needs permission 'write' of the feature 'project-master-data' globally or in the project.
Parameters:
Name Type Description
actionId String The id of the action.
action ActionUpdateModel The model to update an action.

View Source endpoints/ProjectActions.js, line 81

Promise.<Action>

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

Updates the order of a given action in the list of actions of the specific automation. If the order isn't changed, the order will not be updated.
Parameters:
Name Type Description
actionId String The id of the action.
order Number The order of the automation within a list.

View Source endpoints/ProjectActions.js, line 102

Promise.<Action>