Documentation

TaskApi extends AbstractApi
in package

Create and assign tasks to get files translated or proofread by specific people.

You can set the due dates, split words between people, and receive notifications about the changes and updates on tasks. Tasks are project-specific, so you’ll have to create them within a project. Use API to create, modify, and delete specific tasks.

Table of Contents

Methods

addSettingsTemplate()  : TaskSettingsTemplate|null
Add Task Settings Template
create()  : Task|null
Add Task
delete()  : mixed
Delete Task
deleteSettingsTemplate()  : mixed
Delete Task Settings Template
exportStrings()  : DownloadFile|null
Export Task Strings
get()  : Task|null
Get Task
getSettingsTemplate()  : TaskSettingsTemplate|null
Get Task Settings template
list()  : ModelCollection
List Tasks
listSettingsTemplates()  : ModelCollection
List Task Settings template
listUserTasks()  : ModelCollection
List User Tasks
update()  : Task|null
Edit Task
updateSettingsTemplate()  : TaskSettingsTemplate|null
Update Task Settings Template
userTaskArchivedStatus()  : Task|null
Edit Task Archived Status

Methods

list()

List Tasks

public list(int $projectId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
$projectId : int
$params : array<string|int, mixed> = []

integer $params[limit] [ 1 .. 500 ] Default: 25
integer $params[offset] >= 0 Default: 0
string $params[status] Enum: "todo" "in_progress" "done" "closed" Example: status=done
integer $params[assigneeId]

Tags
link

API Documentation

link

API Documentation Enterprise

Return values
ModelCollection

listUserTasks()

List User Tasks

public listUserTasks([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
$params : array<string|int, mixed> = []

integer $params[limit] [ 1 .. 500 ] Default: 25
integer $params[offset] >= 0 Default: 25
string $params[status] Enum: "todo" "in_progress" "done" "closed" Example: status=done
string $params[isArchived] Default: 0 Default: 0 Example: isArchived=1

Tags
link

API Documentation Enterprise

Return values
ModelCollection

        
On this page

Search results