Class

Awork

Awork(init)

Awork Class
Constructor

# new Awork(init)

Parameters:
Name Type Description
init Object

View Source index.js, line 67

Classes

Awork

Members

# absences

The Absence Endpoints allow you to manage Absences for users.

View Source index.js, line 80

# apiUsers

API users are required to create API keys. CHanges made by a client using API key are shown in the UI as the associated API user.

View Source index.js, line 88

# assignedTasks

The autopilot endpoints allow you to manage the awork autopilot for projects.

View Source index.js, line 96

# autopilot

The autopilot endpoint allow you to manage the awork autopilot for projects.

View Source index.js, line 104

# clientApplications

Client applications are important for the external login flow used by your applications. These endpoints allow you to manage the client applications registered by your workspace.

View Source index.js, line 112

# companies

The company endpoints allow you to add and manage companies and their details.

View Source index.js, line 120

# files

The file endpoints to get non shared and non temporary files.

View Source index.js, line 128

# projectMilestones

The project milestone endpoints allow you to work with the basic project milestone data.

View Source index.js, line 136

# projectRoles

The project roles endpoints allow you to define roles for your project members You can assign members to these roles on each project. If the roles are linked to the project types then the roles are available in every project using this type. When you want to delete a project role which is still in use, you are required to specify which role the currently assigned members should be assigned to instead.

View Source index.js, line 144

# projects

The projects endpoints allow you to work with the basic project data. When creating a project, we generate a unique key which will be used as part of the unique project task key of this project. If you don't assign a customer to the project, the project will be an internal project. In addition to the normal operation you can handle the project members and tags of the projects. When you assign a user to this project as a project member, you need to specify a project role for this project member. The available roles depend on the type of the project. You can also make one member responsible for the project, which means that we will notify this person if anything of interest happens in the project. The tags help you to add additional values to your projects and to find them faster. If you create new tags, they will be available for all other projects, too.

View Source index.js, line 192

# projectStatuses

The project status endpoints allow you to define statuses for projects. A status defines the current situation of a project. The statuses of a project type have an order which defines the flow the project typically goes through. Statuses can also be unlinked from the typical flow.

View Source index.js, line 152

# projectTemplates

The project templates endpoints allow you to define different templates for projects.

View Source index.js, line 160

# projectTypes

The project types endpoints allow you to define different types for projects. The project types contain the basic information of the project. This includes the project roles, statuses and status orders.

View Source index.js, line 168

# taskBundles

Task bundles allow users to define templates for tasks and lists that can be added to a project at any time. Task templates define the tasks that will be created, and task list template define the task lists that will be created. As with tasks, task templates can be in multiple task list templates.

View Source index.js, line 200

# taskDependencied

The task dependency endpoints allow you to get all task dependencies of a project or a task. Every Task can have multiple predeccessors and one successor

View Source index.js, line 176

# tasks

The Tasks endpoints can be used for general task operations and batch operations. The batch operations include changing the task status, assigning users and more.

View Source index.js, line 264

# taskViews

Task views are saved filters on project tasks. They can be stored by users and shared within the workspace. Users can subscribe to shared task views to use them.

View Source index.js, line 184

# teams

The teams endpoints are used to manage the details of your team.

View Source index.js, line 208

# temporaryFiles

The temporary file endpoints allow you to upload and update files that do not have a connection to any entity. The files can be linked to an entity later. They don’t show up in awork before they are either linked to a file or marked as a global file. Only the user who uploaded the file has access to the temporary file.

View Source index.js, line 216

# timeEntries

The endpoints can be used for general operations on existing time entries. A time entry can be linked to a task and / or project, although it can also be created for the user themselves without any entity link. If the time entry is linked to a project it is also indirectly linked to the company of that project. Similarly, the time entry is automatically linked to the project of the the task.

View Source index.js, line 224

# timeReports

The endpoints to manage the time reports.

View Source index.js, line 232

# typesOfWork

The type of work endpoints allow you to manage your types of work. They are helpful to describe the type of a task or a time entry.

View Source index.js, line 240

# users

The users endpoints allow you to manage the users of your workspace as well as their contact details.

View Source index.js, line 248

# webhooks

Webhooks can be used to get notified about events happening. These endpoints allow you to configure webhooks. Read more about webhooks in the developer documentation above.

View Source index.js, line 256