com.sap.cloud.sdk.services.scp.workflow.cf.api

Class TaskDefinitionsApi

java.lang.Object

com.sap.cloud.sdk.services.rest.core.AbstractRestService

com.sap.cloud.sdk.services.scp.workflow.cf.api.TaskDefinitionsApi

All Implemented Interfaces:

RestService

@Component(value="com.sap.cloud.sdk.services.scp.workflow.cf.api.TaskDefinitionsApi")
 @Beta
public class TaskDefinitionsApi
extends AbstractRestService

Workflow API for Cloud Foundry in version v1. This API in the 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 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
TaskDefinitionsApi(HttpDestinationProperties httpDestination) Instantiates this API class to invoke operations on the the Workflow API for Cloud Foundry.

Method Summary

Modifier and Type	Method and Description
List<Object>	queryDefinitions() Retrieve definitions by query parameters
List<Object>	queryDefinitions(Integer $skip, Integer $top, String $inlinecount, String $expand) Retrieve definitions by query parameters

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskDefinitionsApi

public TaskDefinitionsApi(@Nonnull
                          HttpDestinationProperties httpDestination)

Instantiates this API class to invoke operations on the the Workflow API for Cloud Foundry.

Parameters:

httpDestination - The destination that API should be used with

Method Detail

queryDefinitions

@Nullable
public List<Object> queryDefinitions(@Nullable
                                               Integer $skip,
                                               @Nullable
                                               Integer $top,
                                               @Nullable
                                               String $inlinecount,
                                               @Nullable
                                               String $expand)
                                        throws RestRequestException

Retrieve definitions by query parameters

Retrieves task definitions by query parameters. A task definition is identified by the ID of the respective activity within a workflow definition (for example, usertask1) and the workflow definition ID. The workflow definition ID is version independent. That means, this API assumes that task definitions are semantically the same if they span several workflow versions and therefore have the same identifier. The latest workflow definition version is expected to contain the leading property values of the task definition. At the moment, filtering is limited to the $skip and $top parameters for paging through the available task definitions. The returned task definitions are sorted in descending order of their creation time. Roles permitted to execute this operation: - Global roles: WorkflowViewer, WorkflowAdmin

200 - Returns a list of task definitions.

400 - Incorrect format or structure of the provided request body.

403 - Access forbidden. You do not have 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:

$skip - (Optional, default to 0) 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. You can use this parameter only once. Refer also to the $top parameter.

$top - (Optional, default to 100) 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. You can use this parameter only once. Refer also to the $skip parameter.

$inlinecount - (Optional, default to none) Specify whether the total count of the task definitions should be returned as a 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. You can use this parameter only once.

$expand - (Optional) You can request custom task attributes to become part of the task output by specifying the value 'attributeDefinitions' for the '$expand' parameter. Otherwise, if the '$expand' parameter is not specified, the 'attributeDefinitions' field is not included into the output. Note that labels as well as the order of the custom task attributes in which they are returned, are taken from the latest versions of the workflow definitions where the corresponding task definition exists.

Returns:

List<Object>

Throws:

RestRequestException - if an error occurs while attempting to invoke the API

queryDefinitions

@Nullable
public List<Object> queryDefinitions()
                                        throws RestRequestException

Retrieve definitions by query parameters

Retrieves task definitions by query parameters. A task definition is identified by the ID of the respective activity within a workflow definition (for example, usertask1) and the workflow definition ID. The workflow definition ID is version independent. That means, this API assumes that task definitions are semantically the same if they span several workflow versions and therefore have the same identifier. The latest workflow definition version is expected to contain the leading property values of the task definition. At the moment, filtering is limited to the $skip and $top parameters for paging through the available task definitions. The returned task definitions are sorted in descending order of their creation time. Roles permitted to execute this operation: - Global roles: WorkflowViewer, WorkflowAdmin

200 - Returns a list of task definitions.

400 - Incorrect format or structure of the provided request body.

403 - Access forbidden. You do not have 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<Object>

Throws:

RestRequestException - if an error occurs while attempting to invoke the API