Class

ProjectTemplates

ProjectTemplates(client)

Class corresponding to Aworks ProjectTemplates Endpoints
Constructor

# new ProjectTemplates(client)

Endpoint constructor
Parameters:
Name Type Description
client Client
See:
  • [ProjectTemplates in Awork API Docs](https://openapi.awork.com/#/ProjectTemplates)

View Source endpoints/ProjectTemplates.js, line 14

Classes

ProjectTemplates

Methods

# automations(projectTemplateId) → {ProjectTemplateAutomations}

Returns the ProjectTemplateAutomations Endpoint with the specified project template Id.
Parameters:
Name Type Description
projectTemplateId String The id of the project template

View Source endpoints/ProjectTemplates.js, line 134

# async create(projectTemplate) → {Promise.<ProjectTemplate>}

Creates a new project template.
Parameters:
Name Type Description
projectTemplate ProjectTemplateCreateModel The model to create a project template.

View Source endpoints/ProjectTemplates.js, line 62

Promise.<ProjectTemplate>

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

Deletes the project template with the specified id.
Parameters:
Name Type Description
projectTemplateId String The id of the project template.

View Source endpoints/ProjectTemplates.js, line 89

Promise.<void>

# entityTags(projectTemplateId)

Returns the EntityTags Endpoint with the specified project tempate Id and name.
Parameters:
Name Type Description
projectTemplateId String The id of the project template.
Deprecated:
  • Yes

View Source endpoints/ProjectTemplates.js, line 171

# async get(projectTemplateId) → {Promise.<ProjectTemplate>}

Returns the project template with the specified id and the related statuses.
Parameters:
Name Type Description
projectTemplateId String The id of the project template.

View Source endpoints/ProjectTemplates.js, line 32

Promise.<ProjectTemplate>

# images(projectTemplateId) → {EntityImages}

Returns the EntityImages Endpoint with the specified project tempate Id.
Parameters:
Name Type Description
projectTemplateId String The id of the project template.

View Source endpoints/ProjectTemplates.js, line 143

EntityImages

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

Returns all existing project types.
Parameters:
Name Type Attributes Description
options ListOptions <optional>
Pagination and filtering options

View Source endpoints/ProjectTemplates.js, line 43

Promise.<Array.<ProjectTemplate>>

# projectStatus(projectTemplateId) → {ProjectTemplateProjectStatuses}

Returns the ProjectTemplateProjectStatuses Endpoint with the specified project template Id.
Parameters:
Name Type Description
projectTemplateId String The id of the project template

View Source endpoints/ProjectTemplates.js, line 125

# tags(projectTemplateId)

Returns the EntityTags Endpoint with the specified project tempate Id and name.
Parameters:
Name Type Description
projectTemplateId String The id of the project template.

View Source endpoints/ProjectTemplates.js, line 161

# async taskBundle(projectTemplateId) → {Promise.<String>}

Returns the task bundle id which is linked to the template.
Parameters:
Name Type Description
projectTemplateId String The id of the project template.

View Source endpoints/ProjectTemplates.js, line 115

Promise.<String>

# taskStatuses(projectTemplateId) → {ProjectTemplateTaskStatuses}

Returns the ProjectTemplateTaskStatuses Endpoint with the specified project tempate Id.
Parameters:
Name Type Description
projectTemplateId String The id of the project template.

View Source endpoints/ProjectTemplates.js, line 152

# async update(projectTemplateId, projectTemplate) → {Promise.<ProjectTemplate>}

Updates the project template with the specified id.
Parameters:
Name Type Description
projectTemplateId String The id of the project template.
projectTemplate ProjectTemplateUpdateModel The model to update a project template with.

View Source endpoints/ProjectTemplates.js, line 78

Promise.<ProjectTemplate>

# async updateProjectStatusOrder(projectTemplateId, projectStatusOrder) → {Promise.<void>}

Updates the order of a project status.
Parameters:
Name Type Description
projectTemplateId String The id of the project template.
projectStatusOrder ProjectStatusOrder The project status with updated order.

View Source endpoints/ProjectTemplates.js, line 105

Promise.<void>