WorkflowDefinitionsApi (SAP Cloud SDK - Parent POM 3.30.0 API)

java.lang.Object
- com.sap.cloud.sdk.services.rest.core.AbstractRestService
- - com.sap.cloud.sdk.services.scp.workflow.cf.api.WorkflowDefinitionsApi

All Implemented Interfaces:

RestService
```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen")
 @Beta
public class WorkflowDefinitionsApi
extends AbstractRestService
```
Workflow API for Cloud Foundry in version v1. This API in the SAP Cloud SDK uses the SAP Cloud Platform Workflow service REST API. With the API, you can, for example, start new workflow instances and work with tasks.
For more information on how to obtain the necessary parameters, please see Determine Service Configuration Parameters in the documentation. The OAuth client you use must have extended scopes.
Note: The underlying REST APIs are designed for loosely coupled clients. This means:
- If workflow service adds fields to responses, the REST API version number does not increase. REST API clients must ignore new fields. These fields become available in the Workflow API in the SAP Cloud SDK only in new versions of the SDK.
- The order of fields in responses and of entries in arrays may change. This applies unless the API provides an explicit means to specify the desired order.

Field Summary
- Fields inherited from class com.sap.cloud.sdk.services.rest.core.AbstractRestService
  apiClient

Constructor Summary

Constructors
Constructor and Description
`WorkflowDefinitionsApi(ApiClient apiClient)` Instantiates this API class to invoke operations on the Workflow API for Cloud Foundry based on a given `ApiClient`.
`WorkflowDefinitionsApi(HttpDestinationProperties httpDestination)` Instantiates this API class to invoke operations on the Workflow API for Cloud Foundry.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SampleContext`	`getDefaultSampleContext(String definitionId)` Retrieve sample start context of workflow definition by ID
`SampleContext`	`getDefaultSampleContextForVersion(String definitionId, String versionNumber)` Retrieve sample start context of workflow definition by ID and version number
`WorkflowDefinition`	`getDefinition(String definitionId)` Retrieve workflow definition by ID
`WorkflowDefinitionVersion`	`getDefinitionVersion(String definitionId, String versionNumber)` Retrieve workflow definition by ID and version number
`List<WorkflowDefinitionVersion>`	`getDefinitionVersions(String definitionId)` Retrieve all versions of workflow definition by ID
`List<WorkflowDefinitionVersion>`	`getDefinitionVersions(String definitionId, String $orderby, Integer $skip, Integer $top, String $inlinecount)` Retrieve all versions of workflow definition by ID
`WorkflowModel`	`getModelForDefinition(String definitionId)` Retrieve workflow definition model by ID
`WorkflowModel`	`getModelForDefinitionVersion(String definitionId, String versionNumber)` Retrieve workflow definition model by ID and version number
`List<WorkflowDefinition>`	`queryDefinitions()` Retrieve all workflow definitions
`List<WorkflowDefinition>`	`queryDefinitions(String $orderby, Integer $skip, Integer $top, String $inlinecount)` Retrieve all workflow definitions
`RestResponse`	`undeployDefinition(String definitionId)` Delete workflow definition
`RestResponse`	`undeployDefinition(String definitionId, Boolean cascade)` Delete workflow definition

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WorkflowDefinitionsApi
```
public WorkflowDefinitionsApi(@Nonnull
                              HttpDestinationProperties httpDestination)
```
    Instantiates this API class to invoke operations on the Workflow API for Cloud Foundry.
    
    Parameters:
    
    httpDestination - The destination that API should be used with
  - WorkflowDefinitionsApi
```
@Beta
public WorkflowDefinitionsApi(@Nonnull
                                    ApiClient apiClient)
```
    Instantiates this API class to invoke operations on the Workflow API for Cloud Foundry based on a given ApiClient.
    
    Parameters:
    
    apiClient - ApiClient to invoke the API on
- Method Detail
  - getDefaultSampleContext
```
@Nullable
public SampleContext getDefaultSampleContext(@Nonnull
                                                       String definitionId)
                                                throws RestRequestException
```
    Retrieve sample start context of workflow definition by ID
    
    Retrieves the default start context of the latest version of the specified workflow definition. Roles permitted to execute this operation: - Global roles: WorkflowInitiator - Scope: WORKFLOW_DEFINITION_GET_SAMPLE_CONTEXT
    
    200 - Returns the default start context of the latest version of the workflow definition.
    401 - Unauthorized. You have not provided valid authentication credentials to access the resource.
    403 - Access forbidden. You have not the required permissions to access the resource.
    404 - Either the specified workflow definition or the default sample context within the definition was not found.
    429 - You have reached the usage limits that are configured for your tenant. You are performing too many requests or consume too many resources.
    500 - Internal server error. The operation you requested led to an error during execution.
    
    Parameters:
    
    definitionId - The workflow definition ID for which the default start context should be retrieved. The workflow definition ID is at most 64 characters long.
    
    Returns:
    
    SampleContext
    
    Throws:
    
    RestRequestException - if an error occurs while attempting to invoke the API
  - getDefaultSampleContextForVersion
```
@Nullable
public SampleContext getDefaultSampleContextForVersion(@Nonnull
                                                                 String definitionId,
                                                                 @Nonnull
                                                                 String versionNumber)
                                                          throws RestRequestException
```
    Retrieve sample start context of workflow definition by ID and version number
    
    Retrieves the default start context of the specified version of the specified workflow definition. Roles permitted to execute this operation: - Global roles: WorkflowInitiator - Scope: WORKFLOW_DEFINITION_GET_SAMPLE_CONTEXT
    
    200 - Returns the default start context of the specified version of the specified workflow definition.
    401 - Unauthorized. You have not provided valid authentication credentials to access the resource.
    403 - Access forbidden. You have not the required permissions to access the resource.
    404 - Either the specified workflow definition, the specified version within that definition or the default sample context within that definition version was not found.
    429 - You have reached the usage limits that are configured for your tenant. You are performing too many requests or consume too many resources.
    500 - Internal server error. The operation you requested led to an error during execution.
    
    Parameters:
    
    definitionId - The workflow definition ID for which the default start context should be retrieved. The workflow definition ID is at most 64 characters long.
    
    versionNumber - The version number for which the default start context should be retrieved. The version number consists of 1 - 10 digits.
    
    Returns:
    
    SampleContext
    
    Throws:
    
    RestRequestException - if an error occurs while attempting to invoke the API
  - getDefinition
```
@Nullable
public WorkflowDefinition getDefinition(@Nonnull
                                                  String definitionId)
                                           throws RestRequestException
```
    Retrieve workflow definition by ID
    
    Retrieves the latest version of the specified workflow definition. Roles permitted to execute this operation: - Global roles: WorkflowViewer, WorkflowAdmin, WorkflowDeveloper - Scope: WORKFLOW_DEFINITION_GET
    
    200 - Returns a single workflow definition version.
    401 - Unauthorized. You have not provided valid authentication credentials to access the resource.
    403 - Access forbidden. You have not the required permissions to access the resource.
    404 - Workflow definition not found. Either the payload does not contain a definitionId property or the specified ID is incorrect.
    429 - You have reached the usage limits that are configured for your tenant. You are performing too many requests or consume too many resources.
    500 - Internal server error. The operation you requested led to an error during execution.
    
    Parameters:
    
    definitionId - The ID of the workflow definition for which the latest version should be retrieved. The ID is at most 64 characters long.
    
    Returns:
    
    WorkflowDefinition
    
    Throws:
    
    RestRequestException - if an error occurs while attempting to invoke the API
  - getDefinitionVersion
```
@Nullable
public WorkflowDefinitionVersion getDefinitionVersion(@Nonnull
                                                                String definitionId,
                                                                @Nonnull
                                                                String versionNumber)
                                                         throws RestRequestException
```
    Retrieve workflow definition by ID and version number
    
    Retrieves the specified version of the specified workflow definition. Roles permitted to execute this operation: - Global roles: WorkflowViewer, WorkflowAdmin, WorkflowDeveloper - Scope: WORKFLOW_DEFINITION_GET
    
    200 - Returns a single workflow definition.
    401 - Unauthorized. You have not provided valid authentication credentials to access the resource.
    403 - Access forbidden. You have not the required permissions to access the resource.
    404 - Either the workflow definition or the specified version within that definition was not found.
    429 - You have reached the usage limits that are configured for your tenant. You are performing too many requests or consume too many resources.
    500 - Internal server error. The operation you requested led to an error during execution.
    
    Parameters:
    
    definitionId - The ID of the workflow definition which should be retrieved. The ID is at most 64 characters long.
    
    versionNumber - The version number of the workflow definition that should be retrieved. The version number consists of 1 - 10 digits.
    
    Returns:
    
    WorkflowDefinitionVersion
    
    Throws:
    
    RestRequestException - if an error occurs while attempting to invoke the API
  - getDefinitionVersions
```
@Nullable
public List<WorkflowDefinitionVersion> getDefinitionVersions(@Nonnull
                                                                       String definitionId,
                                                                       @Nullable
                                                                       String $orderby,
                                                                       @Nullable
                                                                       Integer $skip,
                                                                       @Nullable
                                                                       Integer $top,
                                                                       @Nullable
                                                                       String $inlinecount)
                                                                throws RestRequestException
```
    Retrieve all versions of workflow definition by ID
    
    Retrieves a list of all deployed versions of the specified workflow definition. Roles permitted to execute this operation: - Global roles: WorkflowViewer, WorkflowAdmin, WorkflowDeveloper - Scope: WORKFLOW_DEFINITION_GET
    
    200 - Returns a list of deployed workflow definitions.
    401 - Unauthorized. You have not provided valid authentication credentials to access the resource.
    403 - Access forbidden. You have not the required permissions to access the resource.
    404 - Workflow definition not found. Either the payload does not contain a definitionId property or the specified ID is incorrect.
    429 - You have reached the usage limits that are configured for your tenant. You are performing too many requests or consume too many resources.
    500 - Internal server error. The operation you requested led to an error during execution.
    
    Parameters:
    
    definitionId - (Required) The ID of the workflow definition for which all versions should be retrieved. The ID is at most 64 characters long.
    
    $orderby - (Optional, default to createdAt desc) Specify the attribute you want to sort by and the order separated by a space. If the order is omitted it is ascending by default. If not specified, the results are sorted by the 'createdAt' attribute in descending order.
    
    $skip - (Optional, default to 0) Specify the number of records you want to skip from the beginning. You can skip at most 4000 records. To indicate a result range that starts, for example, at 1001, combine the $skip with the $top parameter. If not specified, no records are skipped. Refer also to the $top parameter.
    
    $top - (Optional, default to 100) Specify the number of records you want to show. You can get at most 1000 records per API call. To indicate a result range that starts, for example, at 1001, combine the $top with the $skip parameter. If not specified, 100 records are returned. Refer also to the $skip parameter.
    
    $inlinecount - (Optional, default to none) Specify whether the total count of the workflow definition versions should be returned as the value of the X-Total-Count response header. To enable the header, use the 'allpages' setting. To disable the header, use the 'none' setting. The values are case-sensitive.
    
    Returns:
    
    List<WorkflowDefinitionVersion>
    
    Throws:
    
    RestRequestException - if an error occurs while attempting to invoke the API
  - getDefinitionVersions
```
@Nullable
public List<WorkflowDefinitionVersion> getDefinitionVersions(@Nonnull
                                                                       String definitionId)
                                                                throws RestRequestException
```
    Retrieve all versions of workflow definition by ID
    
    Retrieves a list of all deployed versions of the specified workflow definition. Roles permitted to execute this operation: - Global roles: WorkflowViewer, WorkflowAdmin, WorkflowDeveloper - Scope: WORKFLOW_DEFINITION_GET
    
    200 - Returns a list of deployed workflow definitions.
    401 - Unauthorized. You have not provided valid authentication credentials to access the resource.
    403 - Access forbidden. You have not the required permissions to access the resource.
    404 - Workflow definition not found. Either the payload does not contain a definitionId property or the specified ID is incorrect.
    429 - You have reached the usage limits that are configured for your tenant. You are performing too many requests or consume too many resources.
    500 - Internal server error. The operation you requested led to an error during execution.
    
    Parameters:
    
    definitionId - The ID of the workflow definition for which all versions should be retrieved. The ID is at most 64 characters long.
    
    Returns:
    
    List<WorkflowDefinitionVersion>
    
    Throws:
    
    RestRequestException - if an error occurs while attempting to invoke the API
  - getModelForDefinition
```
@Nullable
public WorkflowModel getModelForDefinition(@Nonnull
                                                     String definitionId)
                                              throws RestRequestException
```
    Retrieve workflow definition model by ID
    
    Retrieves the model of the latest version of the specified workflow definition. Roles permitted to execute this operation: - Global roles: WorkflowViewer, WorkflowAdmin, WorkflowDeveloper - Scope: WORKFLOW_DEFINITION_GET_MODEL
    
    200 - The deployed workflow model.
    401 - Unauthorized. You have not provided valid authentication credentials to access the resource.
    403 - Access forbidden. You have not the required permissions to access the resource.
    404 - Either the specified workflow definition or the JSON model for that definition was not found.
    429 - You have reached the usage limits that are configured for your tenant. You are performing too many requests or consume too many resources.
    500 - Internal server error. The operation you requested led to an error during execution.
    
    Parameters:
    
    definitionId - The workflow definition ID for which the latest model should be retrieved. The workflow definition ID is at most 64 characters long.
    
    Returns:
    
    WorkflowModel
    
    Throws:
    
    RestRequestException - if an error occurs while attempting to invoke the API
  - getModelForDefinitionVersion
```
@Nullable
public WorkflowModel getModelForDefinitionVersion(@Nonnull
                                                            String definitionId,
                                                            @Nonnull
                                                            String versionNumber)
                                                     throws RestRequestException
```
    Retrieve workflow definition model by ID and version number
    
    Retrieves the model of the specified version of the specified workflow definition. Roles permitted to execute this operation: - Global roles: WorkflowViewer, WorkflowAdmin, WorkflowDeveloper - Scope: WORKFLOW_DEFINITION_GET_MODEL
    
    200 - The deployed workflow model.
    401 - Unauthorized. You have not provided valid authentication credentials to access the resource.
    403 - Access forbidden. You have not the required permissions to access the resource.
    404 - Either the specified workflow definition, the specified version within that definition or the JSON model for that definition version was not found.
    429 - You have reached the usage limits that are configured for your tenant. You are performing too many requests or consume too many resources.
    500 - Internal server error. The operation you requested led to an error during execution.
    
    Parameters:
    
    definitionId - The workflow definition ID for which the model should be retrieved. The workflow definition ID is at most 64 characters long.
    
    versionNumber - The version number for which the model should be retrieved. The version number consists of 1 - 10 digits.
    
    Returns:
    
    WorkflowModel
    
    Throws:
    
    RestRequestException - if an error occurs while attempting to invoke the API
  - queryDefinitions
```
@Nullable
public List<WorkflowDefinition> queryDefinitions(@Nullable
                                                           String $orderby,
                                                           @Nullable
                                                           Integer $skip,
                                                           @Nullable
                                                           Integer $top,
                                                           @Nullable
                                                           String $inlinecount)
                                                    throws RestRequestException
```
    Retrieve all workflow definitions
    
    Retrieves a list of the latest version of each deployed workflow definition. The request can be parameterized. Roles permitted to execute this operation: - Global roles: WorkflowViewer, WorkflowAdmin, WorkflowDeveloper - Scope: WORKFLOW_DEFINITION_GET
    
    200 - Returns a list of deployed workflow definitions.
    401 - Unauthorized. You have not provided valid authentication credentials to access the resource.
    403 - Access forbidden. You have not the required permissions to access the resource.
    429 - You have reached the usage limits that are configured for your tenant. You are performing too many requests or consume too many resources.
    500 - Internal server error. The operation you requested led to an error during execution.
    
    Parameters:
    
    $orderby - (Optional, default to createdAt desc) Specify the attribute you want to sort by and the order separated by a space. If the order is omitted it is ascending by default. If not specified, the results are sorted by the 'createdAt' attribute in descending order.
    
    $skip - (Optional, default to 0) Specify the number of records you want to skip from the beginning. You can skip at most 4000 records. To indicate a result range that starts, for example, at 1001, combine the $skip with the $top parameter. If not specified, no records are skipped. Refer also to the $top parameter.
    
    $top - (Optional, default to 100) Specify the number of records you want to show. You can get at most 1000 records per API call. To indicate a result range that starts, for example, at 1001, combine the $top with the $skip parameter. If not specified, 100 records are returned. Refer also to the $skip parameter.
    
    $inlinecount - (Optional, default to none) Specify whether the total count of the workflow definitions should be returned as the value of the X-Total-Count response header. To enable the header, use the 'allpages' setting. To disable the header, use the 'none' setting. The values are case-sensitive.
    
    Returns:
    
    List<WorkflowDefinition>
    
    Throws:
    
    RestRequestException - if an error occurs while attempting to invoke the API
  - queryDefinitions
```
@Nullable
public List<WorkflowDefinition> queryDefinitions()
                                                    throws RestRequestException
```
    Retrieve all workflow definitions
    
    Retrieves a list of the latest version of each deployed workflow definition. The request can be parameterized. Roles permitted to execute this operation: - Global roles: WorkflowViewer, WorkflowAdmin, WorkflowDeveloper - Scope: WORKFLOW_DEFINITION_GET
    
    200 - Returns a list of deployed workflow definitions.
    401 - Unauthorized. You have not provided valid authentication credentials to access the resource.
    403 - Access forbidden. You have not the required permissions to access the resource.
    429 - You have reached the usage limits that are configured for your tenant. You are performing too many requests or consume too many resources.
    500 - Internal server error. The operation you requested led to an error during execution.
    
    Returns:
    
    List<WorkflowDefinition>
    
    Throws:
    
    RestRequestException - if an error occurs while attempting to invoke the API
  - undeployDefinition
```
@Nonnull
public RestResponse undeployDefinition(@Nonnull
                                                String definitionId,
                                                @Nullable
                                                Boolean cascade)
                                         throws RestRequestException
```
    Delete workflow definition
    
    Undeploys all versions of an existing workflow definition and deletes the corresponding workflow instances. Once the undeployment has started, you can no longer start a new workflow instance based on this workflow definition. Roles permitted to execute this operation: - Global roles: WorkflowTenantOperator - Scope: WORKFLOW_DEFINITION_UNDEPLOY
    
    202 - The undeployment of the workflow definition has been accepted, but will be executed asynchronously. The response will include the header 'Location' that points to a dedicated resource. You can use this resource to track the status of the undeployment.
    303 - Another undeployment of the workflow definition is already running. The response will include the header 'Location' that points to a job resource which you can use to track the status of the undeployment. Depending on your web client you may be automatically redirected to this resource and receive the status of the undeployment as the result of your request.
    401 - Unauthorized. You have not provided valid authentication credentials to access the resource.
    403 - Access forbidden. You have not the required permissions to access the resource.
    404 - Workflow definition not found. Either the payload does not contain a definitionId property or the specified ID is incorrect.
    412 - At least one version of the workflow definition has at least one RUNNING instance.
    429 - You have reached the usage limits that are configured for your tenant. You are performing too many requests or consume too many resources.
    500 - Internal server error. The operation you requested led to an error during execution.
    
    Parameters:
    
    definitionId - (Required) The ID of the workflow definition to be undeployed. The ID is at most 64 characters long.
    
    cascade - (Optional, default to false) Whether the undeployment of the workflow definition deletes active workflow instances. If the parameter is false or not specified and there are active workflow instances for the specified workflow definition, the undeployment is rejected. An instance is considered active if it is in status RUNNING, ERRONEOUS, or SUSPENDED.
    
    Returns:
    
    A RestResponse containing the status code of the HttpResponse.
    
    Throws:
    
    RestRequestException - if an error occurs while attempting to invoke the API
  - undeployDefinition
```
@Nonnull
public RestResponse undeployDefinition(@Nonnull
                                                String definitionId)
                                         throws RestRequestException
```
    Delete workflow definition
    
    Undeploys all versions of an existing workflow definition and deletes the corresponding workflow instances. Once the undeployment has started, you can no longer start a new workflow instance based on this workflow definition. Roles permitted to execute this operation: - Global roles: WorkflowTenantOperator - Scope: WORKFLOW_DEFINITION_UNDEPLOY
    
    202 - The undeployment of the workflow definition has been accepted, but will be executed asynchronously. The response will include the header 'Location' that points to a dedicated resource. You can use this resource to track the status of the undeployment.
    303 - Another undeployment of the workflow definition is already running. The response will include the header 'Location' that points to a job resource which you can use to track the status of the undeployment. Depending on your web client you may be automatically redirected to this resource and receive the status of the undeployment as the result of your request.
    401 - Unauthorized. You have not provided valid authentication credentials to access the resource.
    403 - Access forbidden. You have not the required permissions to access the resource.
    404 - Workflow definition not found. Either the payload does not contain a definitionId property or the specified ID is incorrect.
    412 - At least one version of the workflow definition has at least one RUNNING instance.
    429 - You have reached the usage limits that are configured for your tenant. You are performing too many requests or consume too many resources.
    500 - Internal server error. The operation you requested led to an error during execution.
    
    Parameters:
    
    definitionId - The ID of the workflow definition to be undeployed. The ID is at most 64 characters long.
    
    Returns:
    
    A RestResponse containing the status code of the HttpResponse.
    
    Throws:
    
    RestRequestException - if an error occurs while attempting to invoke the API

Class WorkflowDefinitionsApi

Field Summary

Fields inherited from class com.sap.cloud.sdk.services.rest.core.AbstractRestService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkflowDefinitionsApi

WorkflowDefinitionsApi

Method Detail

getDefaultSampleContext

getDefaultSampleContextForVersion

getDefinition

getDefinitionVersion

getDefinitionVersions

getDefinitionVersions

getModelForDefinition

getModelForDefinitionVersion

queryDefinitions

queryDefinitions

undeployDefinition

undeployDefinition