Class

TaskBundleTaskListTemplatesTaskTemplates

TaskBundleTaskListTemplatesTaskTemplates(client, taskBundleId, taskListTemplateId)

Class corresponding to Aworks tasktemplates related part of the TaskBundles - TaskListTemplate Endpoints
Constructor

# new TaskBundleTaskListTemplatesTaskTemplates(client, taskBundleId, taskListTemplateId)

Endpoint constructor
Parameters:
Name Type Description
client Client
taskBundleId String The id of the task bundle.
taskListTemplateId String The id of the task list template.
See:
  • [TaskBundles in Awork API Docs](https://openapi.awork.com/#/TaskBundles)

View Source endpoints/TaskBundleTaskListTemplatesTaskTemplates.js, line 9

Classes

TaskBundleTaskListTemplatesTaskTemplates

Methods

# async addTaskTemplates(taskTemplatesToAdd) → {Promise.<Array.<Object>>}

Adds the task templates to the task list template with the specified id.
Parameters:
Name Type Description
taskTemplatesToAdd TaskTemplatesToAdd The ids of the task templates to add to the list.

View Source endpoints/TaskBundleTaskListTemplatesTaskTemplates.js, line 68

Promise.<Array.<Object>>

# async get(taskTemplateId) → {Promise.<TaskTemplate>}

Returns the task template with the specified id in the specified task list template.
Parameters:
Name Type Description
taskTemplateId String The id of the task.

View Source endpoints/TaskBundleTaskListTemplatesTaskTemplates.js, line 30

Promise.<TaskTemplate>

# async list(options) → {Promise.<Array.<TaskTemplate>>}

Returns the task templates in the specified task list template.
Parameters:
Name Type Description
options ListOptions Pagination and filtering options.

View Source endpoints/TaskBundleTaskListTemplatesTaskTemplates.js, line 41

Promise.<Array.<TaskTemplate>>

# async removeTaskTemplates(taskTemplatesToRemove) → {Promise.<void>}

Removes the task templates from the task list template with the specified id.
Parameters:
Name Type Description
taskTemplatesToRemove Array.<String> The ids of the tasks to remove from the list.

View Source endpoints/TaskBundleTaskListTemplatesTaskTemplates.js, line 78

Promise.<void>

# async updateOrder(taskTemplateId, order) → {Promise.<void>}

To update the order of tasks in a project task list, the user needs manage permissions on the project-planning-data feature.
Parameters:
Name Type Description
taskTemplateId String The id of the task.
order Number The order of the task in the list.

View Source endpoints/TaskBundleTaskListTemplatesTaskTemplates.js, line 53

Promise.<void>