public class WorkflowsApi extends Object
| Constructor and Description |
|---|
WorkflowsApi(org.everit.http.restclient.RestClient restClient) |
| Modifier and Type | Method and Description |
|---|---|
io.reactivex.Single<WorkflowIDs> |
createWorkflow(CreateWorkflowDetails createWorkflowDetails,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Deprecated.
|
io.reactivex.Single<WorkflowCreateResponse> |
createWorkflows(WorkflowCreateRequest workflowCreateRequest,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Bulk create workflows
Create workflows and related statuses.
|
io.reactivex.Completable |
deleteInactiveWorkflow(String entityId,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Delete inactive workflow
Deletes a workflow.
|
io.reactivex.Single<List<DeprecatedWorkflow>> |
getAllWorkflows(Optional<String> workflowName,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Deprecated.
|
io.reactivex.Single<PageBeanWorkflow> |
getWorkflowsPaginated(Optional<Long> startAt,
Optional<Integer> maxResults,
Optional<List<String>> workflowName,
Optional<String> expand,
Optional<String> queryString,
Optional<String> orderBy,
Optional<Boolean> isActive,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Get workflows paginated
Returns a [paginated](#pagination) list of published classic workflows.
|
io.reactivex.Single<WorkflowReadResponse> |
readWorkflows(WorkflowReadRequest workflowReadRequest,
Optional<String> expand,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Bulk get workflows
Returns a list of workflows and related statuses by providing workflow names, workflow IDs, or project and issue types.
|
io.reactivex.Single<WorkflowUpdateResponse> |
updateWorkflows(WorkflowUpdateRequest workflowUpdateRequest,
Optional<String> expand,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Bulk update workflows
Update workflows and related statuses.
|
io.reactivex.Single<WorkflowValidationErrorList> |
validateCreateWorkflows(WorkflowCreateValidateRequest workflowCreateValidateRequest,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Validate create workflows
Validate the payload for bulk create workflows.
|
io.reactivex.Single<WorkflowValidationErrorList> |
validateUpdateWorkflows(WorkflowUpdateValidateRequestBean workflowUpdateValidateRequestBean,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Validate update workflows
Validate the payload for bulk update workflows.
|
io.reactivex.Single<WorkflowCapabilities> |
workflowCapabilities(Optional<String> workflowId,
Optional<String> projectId,
Optional<String> issueTypeId,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Get available workflow capabilities
Get the list of workflow capabilities for a specific workflow using either the workflow ID, or the project and issue type ID pair.
|
public WorkflowsApi(org.everit.http.restclient.RestClient restClient)
@Deprecated public io.reactivex.Single<WorkflowIDs> createWorkflow(CreateWorkflowDetails createWorkflowDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
createWorkflowDetails - The workflow details. (required)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<WorkflowCreateResponse> createWorkflows(WorkflowCreateRequest workflowCreateRequest, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
workflowCreateRequest - (required)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Completable deleteInactiveWorkflow(String entityId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
entityId - The entity ID of the workflow. (required)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
@Deprecated public io.reactivex.Single<List<DeprecatedWorkflow>> getAllWorkflows(Optional<String> workflowName, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
workflowName - The name of the workflow to be returned. Only one workflow can be specified. (optional)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<PageBeanWorkflow> getWorkflowsPaginated(Optional<Long> startAt, Optional<Integer> maxResults, Optional<List<String>> workflowName, Optional<String> expand, Optional<String> queryString, Optional<String> orderBy, Optional<Boolean> isActive, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
startAt - The index of the first item to return in a page of results (page offset). (optional, default to 0l)maxResults - The maximum number of items to return per page. (optional, default to 50)workflowName - The name of a workflow to return. To include multiple workflows, provide an ampersand-separated list. For example, `workflowName=name1&workflowName=name2`. (optional, default to new ArrayList<>())expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `transitions` For each workflow, returns information about the transitions inside the workflow. * `transitions.rules` For each workflow transition, returns information about its rules. Transitions are included automatically if this expand is requested. * `transitions.properties` For each workflow transition, returns information about its properties. Transitions are included automatically if this expand is requested. * `statuses` For each workflow, returns information about the statuses inside the workflow. * `statuses.properties` For each workflow status, returns information about its properties. Statuses are included automatically if this expand is requested. * `default` For each workflow, returns information about whether this is the default workflow. * `schemes` For each workflow, returns information about the workflow schemes the workflow is assigned to. * `projects` For each workflow, returns information about the projects the workflow is assigned to, through workflow schemes. * `hasDraftWorkflow` For each workflow, returns information about whether the workflow has a draft version. * `operations` For each workflow, returns information about the actions that can be undertaken on the workflow. (optional)queryString - String used to perform a case-insensitive partial match with workflow name. (optional)orderBy - [Order](#ordering) the results by a field: * `name` Sorts by workflow name. * `created` Sorts by create time. * `updated` Sorts by update time. (optional)isActive - Filters active and inactive workflows. (optional)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<WorkflowReadResponse> readWorkflows(WorkflowReadRequest workflowReadRequest, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
workflowReadRequest - (required)expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `workflows.usages` Returns the project and issue types that each workflow is associated with. * `statuses.usages` Returns the project and issue types that each status is associated with. (optional)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<WorkflowUpdateResponse> updateWorkflows(WorkflowUpdateRequest workflowUpdateRequest, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
workflowUpdateRequest - (required)expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `workflows.usages` Returns the project and issue types that each workflow is associated with. * `statuses.usages` Returns the project and issue types that each status is associated with. (optional)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<WorkflowValidationErrorList> validateCreateWorkflows(WorkflowCreateValidateRequest workflowCreateValidateRequest, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
workflowCreateValidateRequest - (required)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<WorkflowValidationErrorList> validateUpdateWorkflows(WorkflowUpdateValidateRequestBean workflowUpdateValidateRequestBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
workflowUpdateValidateRequestBean - (required)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<WorkflowCapabilities> workflowCapabilities(Optional<String> workflowId, Optional<String> projectId, Optional<String> issueTypeId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
workflowId - (optional)projectId - (optional)issueTypeId - (optional)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
Copyright © 2011–2023 Everit Kft.. All rights reserved.