Class

Autopilots

Autopilots(client)

Class corresponding to Aworks Autopilots Endpoints
Constructor

# new Autopilots(client)

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

View Source endpoints/Autopilots.js, line 9

Classes

Autopilots

Methods

# async availablealerts() → {Promise.<Array.<String>>}

Returns all available alerts for autopilots.

View Source endpoints/Autopilots.js, line 97

Promise.<Array.<String>>

# async create(autopilot) → {Promise.<Autopilot>}

Creates a new autopilot for the project with the specified id. Also creates and enables all alerts for the new autopilot. For this action, the user needs to be the owner of the project or must have 'read' permissions of the feature 'project-master-data' globally or in his project role.
Parameters:
Name Type Description
autopilot AutopilotCreateModel The model to create a autopilot for a specific project.

View Source endpoints/Autopilots.js, line 61

Promise.<Autopilot>

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

Deletes the autopilot of the project with the specified id. To access and modify the autopilot data the user needs to be the owner of the project or must have 'read' permissions of the feature 'project-master-data' globally or in his project role.

View Source endpoints/Autopilots.js, line 89

Promise.<void>

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

Returns the autopilot with the specified id of the project with the specified id. Returns NoContent if the project does not have an autopilot setup. To get the autopilot data the user needs to be the owner of the project or must have 'read' permissions of the feature 'project-master-data' globally or in his project role.

View Source endpoints/Autopilots.js, line 36

Promise.<Autopilot>

# async update(autopilot) → {Promise.<Autopilot>}

Updates the autopilot of the project with the specified id. To access and modify the autopilot data the user needs to be the owner of the project or must have 'read' permissions of the feature 'project-master-data' globally or in his project role.
Parameters:
Name Type Description
autopilot AutopilotUpdateModel The model to update a autopilot for a specific project.

View Source endpoints/Autopilots.js, line 79

Promise.<Autopilot>