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 Project Task Settings Template
- create() : Task|null
- Add Project Task
- delete() : mixed
- Delete Project Task
- deleteSettingsTemplate() : mixed
- Delete Project Task Settings Template
- exportStrings() : DownloadFile|null
- Export Project Task Strings
- get() : Task|null
- Get Project Task
- getSettingsTemplate() : TaskSettingsTemplate|null
- Get Task Settings Template
- list() : ModelCollection
- List Project Tasks
- listSettingsTemplates() : ModelCollection
- List Project Task Settings Templates
- listTasks() : ModelCollection|null
- List Tasks
- listUserTasks() : ModelCollection|null
- List User Tasks
- update() : Task|null
- Edit Project Task
- updateSettingsTemplate() : TaskSettingsTemplate|null
- Update Project Task Settings Template
- userTaskArchivedStatus() : Task|null
- Edit Task Archived Status
Methods
addSettingsTemplate()
Add Project 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 Project 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 Project Task
public
delete(int $projectId, int $taskId) : mixed
Parameters
- $projectId : int
- $taskId : int
Tags
deleteSettingsTemplate()
Delete Project Task Settings Template
public
deleteSettingsTemplate(int $projectId, int $taskSettingsTemplateId) : mixed
Parameters
- $projectId : int
- $taskSettingsTemplateId : int
Tags
exportStrings()
Export Project Task Strings
public
exportStrings(int $projectId, int $taskId) : DownloadFile|null
Parameters
- $projectId : int
- $taskId : int
Tags
Return values
DownloadFile|nullget()
Get Project 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 Project Tasks
public
list(int $projectId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $projectId : int
- $params : array<string|int, mixed> = []
-
string $params[orderBy]
integer $params[limit] [1 .. 500] Default: 25
integer $params[offset] >= 0 Default: 0
string $params[status] Enum: "todo" "in_progress" "done" "closed"
integer $params[assigneeId]
Tags
Return values
ModelCollectionlistSettingsTemplates()
List Project Task Settings Templates
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
ModelCollectionlistTasks()
List Tasks
public
listTasks(int $userId[, array<string|int, mixed> $params = [] ]) : ModelCollection|null
Parameters
- $userId : int
- $params : array<string|int, mixed> = []
-
string $params[orderBy]
integer $params[limit] [1 .. 500] Default: 25
integer $params[offset] >= 0 Default: 0
string $params[status] Enum: "todo" "in_progress" "done" "closed"
string $params[type] Enum: 0 1 2 3
string $params[projectIds]
string $params[assigneeIds]
string $params[creatorIds]
string $params[targetLanguageIds]
string $params[sourceLanguageIds]
string $params[createdAtFrom]
string $params[createdAtTo]
string $params[deadlineFrom]
string $params[deadlineTo]
Tags
Return values
ModelCollection|nulllistUserTasks()
List User Tasks
public
listUserTasks([array<string|int, mixed> $params = [] ]) : ModelCollection|null
Parameters
- $params : array<string|int, mixed> = []
-
string $params[orderBy]
integer $params[limit] [1 .. 500] Default: 25
integer $params[offset] >= 0 Default: 0
string $params[status] Enum: "todo" "in_progress" "done" "closed"
string $params[isArchived] Enum: "0" "1"
Tags
Return values
ModelCollection|nullupdate()
Edit Project Task
public
update(TaskForUpdate|Task $task) : Task|null
Parameters
- $task : TaskForUpdate|Task
Tags
Return values
Task|nullupdateSettingsTemplate()
Update Project 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