com.crowdin.client.workflows

Class WorkflowsApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.workflows.WorkflowsApi

public class WorkflowsApi
extends CrowdinApi

Field Summary

Fields inherited from class com.crowdin.client.core.CrowdinApi

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

Constructor and Description
WorkflowsApi(Credentials credentials)
WorkflowsApi(Credentials credentials, ClientConfig clientConfig)

Method Summary

Modifier and Type	Method and Description
ResponseObject<WorkflowStep>	getWorkflowStep(java.lang.Long projectId, java.lang.Long stepId)
ResponseObject<WorkflowTemplate>	getWorkflowTemplate(java.lang.Long templateId)
ResponseList<WorkflowStep>	listWorkflowSteps(java.lang.Long projectId)
ResponseList<SourceString>	listWorkflowStepStrings(java.lang.Long projectId, java.lang.Long stepId, java.lang.String languageIds, java.util.List<OrderByField> orderBy, java.lang.String status, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<WorkflowTemplate>	listWorkflowTemplates(java.lang.Long groupId, java.lang.Integer limit, java.lang.Integer offset)

Methods inherited from class com.crowdin.client.core.CrowdinApi

graphql, graphql

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowsApi

public WorkflowsApi(Credentials credentials)

WorkflowsApi

public WorkflowsApi(Credentials credentials,
                    ClientConfig clientConfig)

Method Detail

listWorkflowSteps

public ResponseList<WorkflowStep> listWorkflowSteps(java.lang.Long projectId)
                                             throws HttpException,
                                                    HttpBadRequestException

Parameters:

projectId - project identifier

Returns:

list of workflow steps

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

getWorkflowStep

public ResponseObject<WorkflowStep> getWorkflowStep(java.lang.Long projectId,
                                                    java.lang.Long stepId)
                                             throws HttpException,
                                                    HttpBadRequestException

Parameters:

projectId - project identifier

stepId - workflow step identifier

Returns:

workflow step

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

listWorkflowStepStrings

public ResponseList<SourceString> listWorkflowStepStrings(java.lang.Long projectId,
                                                          java.lang.Long stepId,
                                                          java.lang.String languageIds,
                                                          java.util.List<OrderByField> orderBy,
                                                          java.lang.String status,
                                                          java.lang.Integer limit,
                                                          java.lang.Integer offset)
                                                   throws HttpException,
                                                          HttpBadRequestException

Parameters:

projectId - project identifier

stepId - workflow step identifier

languageIds - filter progress by language identifiers

orderBy - ["id", "text", "identifier", "context", "createdAt", "updatedAt"]. List of OrderByField (default "id asc")

status - ["todo", "done", "pending", "incomplete", "need_review"]. String status on the workflow step

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

Returns:

list of project strings

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

listWorkflowTemplates

public ResponseList<WorkflowTemplate> listWorkflowTemplates(java.lang.Long groupId,
                                                            java.lang.Integer limit,
                                                            java.lang.Integer offset)
                                                     throws HttpException,
                                                            HttpBadRequestException

Parameters:

groupId - group identifier

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

Returns:

list of workflow templates

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

getWorkflowTemplate

public ResponseObject<WorkflowTemplate> getWorkflowTemplate(java.lang.Long templateId)
                                                     throws HttpException,
                                                            HttpBadRequestException

Parameters:

templateId - workflow template identifier

Returns:

workflow step

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation