Module crowdin_api.api_resources.tasks.resource

Classes

class EnterpriseTasksResource (requester: APIRequester, project_id: Optional[int] = None, page_size=25)

Resource for Tasks.

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.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/Tasks

Ancestors

• TasksResource
• BaseResource

Methods

def add_general_by_string_ids_task(self, title: str, languageId: str, stringIds: Iterable[int], type: Optional[CrowdinGeneralTaskType] = None, workflowStepId: Optional[int] = None, projectId: Optional[int] = None, status: Optional[CrowdinTaskStatus] = None, description: Optional[str] = None, splitContent: Optional[bool] = None, skipAssignedStrings: Optional[bool] = None, includePreTranslatedStringsOnly: Optional[bool] = None, assignees: Optional[Iterable[CrowdinTaskAssignee]] = None, assignedTeams: Optional[Iterable[EnterpriseTaskAssignedTeams]] = None, deadline: Optional[datetime.datetime] = None, startedAt: Optional[datetime.datetime] = None, dateFrom: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None, batchId: Optional[int] = None, skipAssignedStringsScope: Optional[TaskSkipAssignedStringsScope] = None, translationsUpdatedDateFrom: Optional[datetime.datetime] = None, translationsUpdatedDateTo: Optional[datetime.datetime] = None, generateCostEstimate: Optional[bool] = None, generateTranslationCost: Optional[bool] = None, reportSettingsTemplateId: Optional[int] = None, fields: Optional[Dict[str, Any]] = None)

Add Task(Enterprise Task Create Form, Create By String Ids Form).

One of type or workflowStepId is required. status accepts todo or in_progress.

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.tasks.post

def add_general_task(self, title: str, languageId: str, fileIds: Optional[Iterable[int]], type: Optional[CrowdinGeneralTaskType], workflowStepId: Optional[int] = None, projectId: Optional[int] = None, status: Optional[CrowdinTaskStatus] = None, description: Optional[str] = None, splitContent: Optional[bool] = None, skipAssignedStrings: Optional[bool] = None, includePreTranslatedStringsOnly: Optional[bool] = None, labelIds: Optional[Iterable[int]] = None, excludeLabelIds: Optional[Iterable[int]] = None, assignees: Optional[Iterable[CrowdinTaskAssignee]] = None, assignedTeams: Optional[Iterable[EnterpriseTaskAssignedTeams]] = None, deadline: Optional[datetime.datetime] = None, startedAt: Optional[datetime.datetime] = None, dateFrom: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None, batchId: Optional[int] = None, directoryIds: Optional[Iterable[int]] = None, branchIds: Optional[Iterable[int]] = None, labelMatchRule: Optional[TaskLabelMatchRule] = None, excludeLabelMatchRule: Optional[TaskLabelMatchRule] = None, skipAssignedStringsScope: Optional[TaskSkipAssignedStringsScope] = None, translationsUpdatedDateFrom: Optional[datetime.datetime] = None, translationsUpdatedDateTo: Optional[datetime.datetime] = None, generateCostEstimate: Optional[bool] = None, generateTranslationCost: Optional[bool] = None, reportSettingsTemplateId: Optional[int] = None, fields: Optional[Dict[str, Any]] = None)

Add Task(Enterprise Task Create Form, Create By Source Ids Form).

One of fileIds, directoryIds or branchIds is required (pass fileIds=None when using directoryIds or branchIds). fileIds and directoryIds are file-based projects only. One of type or workflowStepId is required (pass type=None when using workflowStepId). status accepts todo or in_progress.

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.tasks.post

def add_pending_task(self, title: str, precedingTaskId: int, projectId: Optional[int] = None, description: Optional[str] = None, assignees: Optional[Iterable[CrowdinTaskAssignee]] = None, assignedTeams: Optional[Iterable[EnterpriseTaskAssignedTeams]] = None, deadline: Optional[datetime.datetime] = None, type: Optional[CrowdinTaskType] = None, workflowStepId: Optional[int] = None, vendor: Optional[str] = None)

Add Task(Enterprise Pending Task Create Form).

One of type or workflowStepId can be provided, not both. When neither is given, type defaults to CrowdinTaskType.PROOFREAD. vendor is required for CrowdinTaskType.PROOFREAD_BY_VENDOR.

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.tasks.post

def add_task_settings_template(self, name: str, config: EnterpriseTaskSettingsTemplateLanguages, projectId: Optional[int] = None)

Add Task Settings Template.

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.tasks.settings-templates.post

def add_vendor_by_string_ids_task(self, title: str, languageId: str, workflowStepId: int, stringIds: Iterable[int], projectId: Optional[int] = None, description: Optional[str] = None, skipAssignedStrings: Optional[bool] = None, includePreTranslatedStringsOnly: Optional[bool] = None, deadline: Optional[datetime.datetime] = None, startedAt: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None, labelIds: Optional[Iterable[int]] = None, labelMatchRule: Optional[TaskLabelMatchRule] = None, skipAssignedStringsScope: Optional[TaskSkipAssignedStringsScope] = None, translationsUpdatedDateFrom: Optional[datetime.datetime] = None, translationsUpdatedDateTo: Optional[datetime.datetime] = None, generateCostEstimate: Optional[bool] = None, generateTranslationCost: Optional[bool] = None, reportSettingsTemplateId: Optional[int] = None, fields: Optional[Dict[str, Any]] = None)

Add Task(Enterprise Vendor Task Create Form, Create By String Ids Form).

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.tasks.post

def add_vendor_task(self, title: str, languageId: str, workflowStepId: int, fileIds: Optional[Iterable[int]], projectId: Optional[int] = None, description: Optional[str] = None, skipAssignedStrings: Optional[bool] = None, includePreTranslatedStringsOnly: Optional[bool] = None, labelIds: Optional[Iterable[int]] = None, excludeLabelIds: Optional[Iterable[int]] = None, deadline: Optional[datetime.datetime] = None, startedAt: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None, directoryIds: Optional[Iterable[int]] = None, branchIds: Optional[Iterable[int]] = None, labelMatchRule: Optional[TaskLabelMatchRule] = None, excludeLabelMatchRule: Optional[TaskLabelMatchRule] = None, skipAssignedStringsScope: Optional[TaskSkipAssignedStringsScope] = None, translationsUpdatedDateFrom: Optional[datetime.datetime] = None, translationsUpdatedDateTo: Optional[datetime.datetime] = None, generateCostEstimate: Optional[bool] = None, generateTranslationCost: Optional[bool] = None, reportSettingsTemplateId: Optional[int] = None, fields: Optional[Dict[str, Any]] = None)

Add Task(Enterprise Vendor Task Create Form, Create By Source Ids Form).

One of fileIds, directoryIds or branchIds is required (pass fileIds=None when using directoryIds or branchIds). fileIds and directoryIds are file-based projects only.

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.tasks.post

def edit_task(self, taskId: int, data: Union[Iterable[EnterpriseTaskPatchRequest], Iterable[EnterpriseVendorTaskPatchRequest], Iterable[EnterpriseInterOrganizationalTaskPatchRequest], Iterable[EnterprisePendingTaskPatchRequest]], projectId: Optional[int] = None)

Edit Task.

The /splitFiles patch path is deprecated, use /splitContent instead.

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.tasks.patch

def list_organization_tasks(self, orderBy: Optional[Sorting] = None, status: Union[CrowdinTaskStatus, Iterable[CrowdinTaskStatus], None] = None, type: Union[CrowdinTaskType, Iterable[CrowdinTaskType], None] = None, projectIds: Optional[Iterable[int]] = None, groupIds: Optional[Iterable[int]] = None, assigneeIds: Optional[Iterable[int]] = None, creatorIds: Optional[Iterable[int]] = None, targetLanguageIds: Optional[Iterable[str]] = None, sourceLanguageIds: Optional[Iterable[str]] = None, createdAtFrom: Optional[datetime.datetime] = None, createdAtTo: Optional[datetime.datetime] = None, deadlineFrom: Optional[datetime.datetime] = None, deadlineTo: Optional[datetime.datetime] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None)

List Tasks (organization level).

status and type can be a single value or a list of values. projectIds cannot be used together with groupIds.

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.tasks.getMany

Inherited members

• TasksResource:
  • add_task
  • add_task_comment
  • add_vendor_pending_task
  • delete_task
  • delete_task_comment
  • delete_task_settings_template
  • edit_task_archived_status
  • edit_task_comment
  • edit_task_settings_template
  • export_task_strings
  • get_task
  • get_task_comment
  • get_task_settings_template
  • list_specific_user_tasks
  • list_task_comments
  • list_task_settings_templates
  • list_tasks
  • list_user_tasks

class TasksResource (requester: APIRequester, project_id: Optional[int] = None, page_size=25)

Resource for Tasks.

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.

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/Tasks

Ancestors

• BaseResource

Subclasses

• EnterpriseTasksResource

Methods

def add_general_by_string_ids_task(self, title: str, languageId: str, stringIds: Iterable[int], type: CrowdinGeneralTaskType, projectId: Optional[int] = None, status: Optional[CrowdinTaskStatus] = None, description: Optional[str] = None, splitContent: Optional[bool] = None, skipAssignedStrings: Optional[bool] = None, includePreTranslatedStringsOnly: Optional[bool] = None, assignees: Optional[Iterable[CrowdinTaskAssignee]] = None, deadline: Optional[datetime.datetime] = None, startedAt: Optional[datetime.datetime] = None, dateFrom: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None, batchId: Optional[int] = None, translationsUpdatedDateFrom: Optional[datetime.datetime] = None, translationsUpdatedDateTo: Optional[datetime.datetime] = None, generateCostEstimate: Optional[bool] = None, generateTranslationCost: Optional[bool] = None, reportSettingsTemplateId: Optional[int] = None)

Add Task(Crowdin Task Create Form, Create By String Ids Form).

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.post

def add_general_task(self, title: str, languageId: str, fileIds: Optional[Iterable[int]], type: CrowdinGeneralTaskType, projectId: Optional[int] = None, status: Optional[CrowdinTaskStatus] = None, description: Optional[str] = None, splitContent: Optional[bool] = None, skipAssignedStrings: Optional[bool] = None, includePreTranslatedStringsOnly: Optional[bool] = None, labelIds: Optional[Iterable[int]] = None, excludeLabelIds: Optional[Iterable[int]] = None, assignees: Optional[Iterable[CrowdinTaskAssignee]] = None, deadline: Optional[datetime.datetime] = None, startedAt: Optional[datetime.datetime] = None, dateFrom: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None, batchId: Optional[int] = None, directoryIds: Optional[Iterable[int]] = None, branchIds: Optional[Iterable[int]] = None, labelMatchRule: Optional[TaskLabelMatchRule] = None, excludeLabelMatchRule: Optional[TaskLabelMatchRule] = None, translationsUpdatedDateFrom: Optional[datetime.datetime] = None, translationsUpdatedDateTo: Optional[datetime.datetime] = None, generateCostEstimate: Optional[bool] = None, generateTranslationCost: Optional[bool] = None, reportSettingsTemplateId: Optional[int] = None)

Add Task(Crowdin Task Create Form, Create By Source Ids Form).

One of fileIds, directoryIds or branchIds is required (pass fileIds=None when using directoryIds or branchIds). fileIds and directoryIds are file-based projects only.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.post

def add_pending_task(self, title: str, precedingTaskId: int, projectId: Optional[int] = None, description: Optional[str] = None, assignees: Optional[Iterable[CrowdinTaskAssignee]] = None, deadline: Optional[datetime.datetime] = None)

Add Task(Crowdin Pending Task Create Form).

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.post

def add_task(self, request_data: Dict[~KT, ~VT], projectId: Optional[int] = None)

Add Task.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.post

def add_task_comment(self, text: str, taskId: int, projectId: Optional[int] = None, timeSpent: Optional[int] = None)

Add Task Comment.

timeSpent is the time spent on the task, in seconds.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.comments.post

def add_task_settings_template(self, name: str, config: TaskSettingsTemplateLanguages, projectId: Optional[int] = None)

Add Task Settings Template.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.settings-templates.post

def add_vendor_by_string_ids_task(self, title: str, languageId: str, stringIds: Iterable[int], type: CrowdinTaskType, vendor: str, projectId: Optional[int] = None, status: Optional[CrowdinTaskStatus] = None, description: Optional[str] = None, skipAssignedStrings: Optional[bool] = None, includePreTranslatedStringsOnly: Optional[bool] = None, deadline: Optional[datetime.datetime] = None, dateFrom: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None, labelIds: Optional[Iterable[int]] = None, labelMatchRule: Optional[TaskLabelMatchRule] = None, excludeLabelIds: Optional[Iterable[int]] = None, excludeLabelMatchRule: Optional[TaskLabelMatchRule] = None, translationsUpdatedDateFrom: Optional[datetime.datetime] = None, translationsUpdatedDateTo: Optional[datetime.datetime] = None, generateCostEstimate: Optional[bool] = None, generateTranslationCost: Optional[bool] = None, reportSettingsTemplateId: Optional[int] = None)

Add Task(Crowdin Vendor Task Create Form, Create By String Ids Form).

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.post

def add_vendor_pending_task(self, title: str, precedingTaskId: int, vendor: str, projectId: Optional[int] = None, description: Optional[str] = None, assignees: Optional[Iterable[CrowdinTaskAssignee]] = None, deadline: Optional[datetime.datetime] = None)

Add Task(Crowdin Vendor Pending Task Create Form).

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.post

def add_vendor_task(self, title: str, languageId: str, fileIds: Optional[Iterable[int]], type: CrowdinTaskType, vendor: str, projectId: Optional[int] = None, status: Optional[CrowdinTaskStatus] = None, description: Optional[str] = None, skipAssignedStrings: Optional[bool] = None, includePreTranslatedStringsOnly: Optional[bool] = None, labelIds: Optional[Iterable[int]] = None, excludeLabelIds: Optional[Iterable[int]] = None, deadline: Optional[datetime.datetime] = None, dateFrom: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None, directoryIds: Optional[Iterable[int]] = None, branchIds: Optional[Iterable[int]] = None, labelMatchRule: Optional[TaskLabelMatchRule] = None, excludeLabelMatchRule: Optional[TaskLabelMatchRule] = None, translationsUpdatedDateFrom: Optional[datetime.datetime] = None, translationsUpdatedDateTo: Optional[datetime.datetime] = None, generateCostEstimate: Optional[bool] = None, generateTranslationCost: Optional[bool] = None, reportSettingsTemplateId: Optional[int] = None)

Add Task(Crowdin Vendor Task Create Form, Create By Source Ids Form).

One of fileIds, directoryIds or branchIds is required (pass fileIds=None when using directoryIds or branchIds). fileIds and directoryIds are file-based projects only.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.post

def delete_task(self, taskId: int, projectId: Optional[int] = None)

Delete Task.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.delete

def delete_task_comment(self, taskCommentId: int, taskId: int, projectId: Optional[int] = None)

Delete Task Comment.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.comments.delete

def delete_task_settings_template(self, taskSettingsTemplateId: int, projectId: Optional[int] = None)

Delete Task Settings Template.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.settings-templates.delete

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.tasks.settings-templates.delete

def edit_task(self, taskId: int, data: Union[Iterable[VendorPatchRequest], Iterable[TaskPatchRequest], Iterable[PendingTaskPatchRequest], Iterable[VendorPendingTaskPatchRequest]], projectId: Optional[int] = None)

Edit Task.

The /splitFiles patch path is deprecated, use /splitContent instead.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.patch

def edit_task_archived_status(self, taskId: int, isArchived: bool = True, projectId: Optional[int] = None)

Edit Task Archived Status.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.user.tasks.patch

def edit_task_comment(self, taskCommentId: int, data: Iterable[TaskCommentPatchRequest], taskId: int, projectId: Optional[int] = None)

Edit Task Comment.

Supported patch paths: /text and /timeSpent (see TaskCommentPatchPath).

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.comments.patch

def edit_task_settings_template(self, taskSettingsTemplateId: int, data: Iterable[ConfigPatchRequest], projectId: Optional[int] = None)

Edit Task Settings Template.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.settings-templates.patch

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.tasks.settings-templates.patch

def export_task_strings(self, taskId: int, projectId: Optional[int] = None)

Export Task Strings.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.exports.post

def get_task(self, taskId: int, projectId: Optional[int] = None)

Get Task.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.get

def get_task_comment(self, taskCommentId: int, taskId: int, projectId: Optional[int] = None)

Get Task Comment.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.comments.get

def get_task_comments_path(self, projectId: int, taskId: int, taskCommentId: Optional[int] = None)

def get_task_settings_template(self, taskSettingsTemplateId: int, projectId: Optional[int] = None)

Get Task Settings Template.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.settings-templates.get

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.tasks.settings-templates.get

def get_task_settings_templates_path(self, projectId: int, taskSettingsTemplateId: Optional[int] = None)

def get_tasks_path(self, projectId: int, taskId: Optional[int] = None)

def list_specific_user_tasks(self, userId: int, orderBy: Optional[Sorting] = None, status: Union[CrowdinTaskStatus, Iterable[CrowdinTaskStatus], None] = None, type: Union[CrowdinTaskType, Iterable[CrowdinTaskType], None] = None, projectIds: Optional[Iterable[int]] = None, assigneeIds: Optional[Iterable[int]] = None, creatorIds: Optional[Iterable[int]] = None, targetLanguageIds: Optional[Iterable[str]] = None, sourceLanguageIds: Optional[Iterable[str]] = None, createdAtFrom: Optional[datetime.datetime] = None, createdAtTo: Optional[datetime.datetime] = None, deadlineFrom: Optional[datetime.datetime] = None, deadlineTo: Optional[datetime.datetime] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None)

List User Tasks (all of the specified user's project tasks).

Crowdin only. status and type can be a single value or a list of values.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.users.tasks.getMany

def list_task_comments(self, taskId: int, projectId: Optional[int] = None, orderBy: Optional[Sorting] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None)

List Task Comments.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.comments.getMany

def list_task_settings_templates(self, projectId: Optional[int] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None)

List Task Settings Templates.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.settings-templates.getMany

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.tasks.settings-templates.getMany

def list_tasks(self, projectId: Optional[int] = None, orderBy: Optional[Sorting] = None, assigneeId: Optional[int] = None, status: Union[CrowdinTaskStatus, Iterable[CrowdinTaskStatus], None] = None, batchId: Optional[int] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None)

List Tasks.

status can be a single status or a list of statuses. assigneeId is Crowdin only.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.getMany

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.tasks.getMany

def list_user_tasks(self, orderBy: Optional[Sorting] = None, status: Union[CrowdinTaskStatus, Iterable[CrowdinTaskStatus], None] = None, isArchived: Optional[bool] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None)

List User Tasks (tasks of the authorized user).

status can be a single status or a list of statuses.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.user.tasks.getMany

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.user.tasks.getMany