Documentation

Class

ProjectMilestones

ProjectMilestones(client)

Class corresponding to Aworks ProjectMilestones Endpoints.
Constructor

# new ProjectMilestones(client)

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

View Source endpoints/ProjectMilestones.js, line 10

Classes

ProjectMilestones

Methods

# async create(milestone) → {Promise.<ProjectMilestone>}

Creates a new project milestone. The user needs 'write' permissions of feature 'project-planning-data' to get the data.
Parameters:
Name Type Description
milestone ProjectMilestoneCreateModel The model to create a project milstone.

View Source endpoints/ProjectMilestones.js, line 46

>
Promise.<ProjectMilestone>

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

Deletes the project milestone with the specified id. The user needs 'write' permissions of feature 'project-planning-data' to get the data.
Parameters:
Name Type Description
milestoneId String The id of the project milestone.

View Source endpoints/ProjectMilestones.js, line 77

Promise.<void>

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

Returns all project milestones the user is allowed to see. The user only gets returned all milestones of projects he has 'read' permissions of feature 'project-planning-data' for.
Parameters:
Name Type Attributes Description
options ListOptions <optional>
 Pagination and filtering options.

View Source endpoints/ProjectMilestones.js, line 26

Promise.<Array.<ProjectMilestone>>

# async update(milestoneId, milestone) → {Promise.<ProjectMilestone>}

Updates the specified project milestone. The user needs 'write' permissions of feature 'project-planning-data' to get the data.
Parameters:
Name Type Description
milestoneId String The id of the project milestone.
milestone ProjectMilestoneUpdateModel The model to update a project milestone.

View Source endpoints/ProjectMilestones.js, line 65

Promise.<ProjectMilestone>