Module crowdin_api.api_resources.workflows.resource

Classes

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

Resource for Workflows.

Workflows are the sequences of steps that content in your project should go through (e.g. pre-translation, translation, proofreading). You can use a default template or create the one that works best for you and assign it to the needed projects.

Use API to get the list of workflow templates available in your organization and to check the details of a specific template.

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

Ancestors

• BaseResource

Methods

def get_workflow_step(self, stepId: int, projectId: Optional[int] = None)

Get Workflow Step.

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.workflow-steps.get

def get_workflow_step_strings_path(self, projectId: int, stepId: int)

def get_workflow_steps_path(self, projectId: int, stepId: Optional[int] = None)

def get_workflow_template(self, templateId: int)

Get Workflow Template.

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.workflow-templates.get

def get_workflow_templates_path(self, templateId: Optional[int] = None)

def list_workflow_step_strings(self, projectId: Optional[int], stepId: int, languageIds: Optional[str] = None, orderBy: Optional[Sorting] = None, status: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None)

List Strings on the Workflow Step.

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.workflow-steps.strings.getMany

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

List Workflow Steps.

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.workflow-steps.getMany

def list_workflow_templates(self, groupId: Optional[int] = None, limit: Optional[int] = None, offset: Optional[int] = None)

List Workflow Templates.

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.workflow-templates.getMany