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
addSettingsTemplate()
Add Task Settings Template
public
addSettingsTemplate(int $projectId, array<string|int, mixed> $data) : TaskSettingsTemplate|null
Parameters
- $projectId : int
- $data : array<string|int, mixed>
-
string $data[name] required
array $data[config] required
Tags
Return values
TaskSettingsTemplate|nullcreate()
Add Task
public
create(int $projectId, array<string|int, mixed> $data) : Task|null
Parameters
- $projectId : int
- $data : array<string|int, mixed>
Tags
Return values
Task|nulldelete()
Delete Task
public
delete(int $projectId, int $taskId) : mixed
Parameters
- $projectId : int
- $taskId : int
Tags
deleteSettingsTemplate()
Delete Task Settings Template
public
deleteSettingsTemplate(int $projectId, int $taskSettingsTemplateId) : mixed
Parameters
- $projectId : int
- $taskSettingsTemplateId : int
Tags
exportStrings()
Export Task Strings
public
exportStrings(int $projectId, int $taskId) : DownloadFile|null
Parameters
- $projectId : int
- $taskId : int
Tags
Return values
DownloadFile|nullget()
Get Task
public
get(int $projectId, int $taskId) : Task|null
Parameters
- $projectId : int
- $taskId : int
Tags
Return values
Task|nullgetSettingsTemplate()
Get Task Settings template
public
getSettingsTemplate(int $projectId, int $taskSettingsTemplateId) : TaskSettingsTemplate|null
Parameters
- $projectId : int
- $taskSettingsTemplateId : int
Tags
Return values
TaskSettingsTemplate|nulllist()
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
Return values
ModelCollectionlistSettingsTemplates()
List Task Settings template
public
listSettingsTemplates(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
Tags
Return values
ModelCollectionlistUserTasks()
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
Return values
ModelCollectionupdate()
Edit Task
public
update(TaskForUpdate|Task $task) : Task|null
Parameters
- $task : TaskForUpdate|Task
Tags
Return values
Task|nullupdateSettingsTemplate()
Update Task Settings Template
public
updateSettingsTemplate(int $projectId, TaskSettingsTemplate $taskSettingsTemplate) : TaskSettingsTemplate|null
Parameters
- $projectId : int
- $taskSettingsTemplate : TaskSettingsTemplate
Tags
Return values
TaskSettingsTemplate|nulluserTaskArchivedStatus()
Edit Task Archived Status
public
userTaskArchivedStatus(int $taskId, int $projectId[, bool $isArchived = true ]) : Task|null
Parameters
- $taskId : int
- $projectId : int
- $isArchived : bool = true