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

Class FormsApi

java.lang.Object

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

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

All Implemented Interfaces:

RestService

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen")
 @Beta
public class FormsApi
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
FormsApi(ApiClient apiClient) Instantiates this API class to invoke operations on the Workflow API for Cloud Foundry based on a given ApiClient.
FormsApi(HttpDestinationProperties httpDestination) Instantiates this API class to invoke operations on the Workflow API for Cloud Foundry.

Method Summary

Modifier and Type	Method and Description
List<FormMetadata>	getFormDefinitionsMetadata() Retrieve all form definitions
List<FormMetadata>	getFormDefinitionsMetadata(Integer $skip, Integer $top, String $inlinecount, String type) Retrieve all form definitions
FormModel	getModelByIdAndRevision(String formId, String revisionId) Retrieve form model by ID and revision.
FormModel	getModelByIdAndVersion(String formId, String versionNumber) Retrieve form model by ID and version number.
RestResponse	undeployForm(String formId) Delete a form.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormsApi

public FormsApi(@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

FormsApi

@Beta
public FormsApi(@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

getFormDefinitionsMetadata

@Nullable
public List<FormMetadata> getFormDefinitionsMetadata(@Nullable
                                                               Integer $skip,
                                                               @Nullable
                                                               Integer $top,
                                                               @Nullable
                                                               String $inlinecount,
                                                               @Nullable
                                                               String type)
                                                        throws RestRequestException

Retrieve all form definitions

Retrieves a list of the latest version of each revision of each deployed form definition. The request can be parameterized. The results are sorted by the 'createdAt' attribute in descending order. Roles permitted to execute this operation: - Global roles: WorkflowViewer, WorkflowAdmin, WorkflowDeveloper - Scope: FORM_DEFINITION_GET

200 - Returns a list of deployed form 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:

$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 form 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.

type - (Optional) Specify whether the response should be filtered by the form type. The values are case-sensitive.

Returns:

List<FormMetadata>

Throws:

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

getFormDefinitionsMetadata

@Nullable
public List<FormMetadata> getFormDefinitionsMetadata()
                                                        throws RestRequestException

Retrieve all form definitions

Retrieves a list of the latest version of each revision of each deployed form definition. The request can be parameterized. The results are sorted by the 'createdAt' attribute in descending order. Roles permitted to execute this operation: - Global roles: WorkflowViewer, WorkflowAdmin, WorkflowDeveloper - Scope: FORM_DEFINITION_GET

200 - Returns a list of deployed form 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<FormMetadata>

Throws:

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

getModelByIdAndRevision

@Nullable
public FormModel getModelByIdAndRevision(@Nonnull
                                                   String formId,
                                                   @Nonnull
                                                   String revisionId)
                                            throws RestRequestException

Retrieve form model by ID and revision.

Retrieves the form model with the specified form ID and revision. Roles permitted to execute this operation: - Global roles (retrieve start and task forms): WorkflowViewer, WorkflowAdmin, WorkflowDeveloper - Global roles (retrieve start forms only): WorkflowInitiator - Scope: FORM_DEFINITION_GET_MODEL

200 - The deployed form definition 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 form 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:

formId - The ID of the form for which the model should be retrieved.

revisionId - The revision of the form for which the model should be retrieved.

Returns:

FormModel

Throws:

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

getModelByIdAndVersion

@Nullable
public FormModel getModelByIdAndVersion(@Nonnull
                                                  String formId,
                                                  @Nonnull
                                                  String versionNumber)
                                           throws RestRequestException

Retrieve form model by ID and version number.

Retrieves the model of the specified version of the specified form definition. Roles permitted to execute this operation: - Global roles: WorkflowViewer, WorkflowAdmin, WorkflowDeveloper - Scope: FORM_DEFINITION_GET_MODEL

200 - The deployed form definition 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 form 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:

formId - The form ID for which the model should be retrieved. The form definition ID is at most 255 characters long.

versionNumber - The version number for which the model should be retrieved. The version number consists of 1 - 10 digits.

Returns:

FormModel

Throws:

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

undeployForm

@Nonnull
public RestResponse undeployForm(@Nonnull
                                          String formId)
                                   throws RestRequestException

Delete a form.

Undeploys all versions of an existing form. Roles permitted to execute this operation: - Global roles: WorkflowTenantOperator - Scope: FORM_DEFINITION_UNDEPLOY

204 - The request was successful and the form definition was deleted.

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 - Form definition not found. Either the payload did not contain a definitionId property or the specified ID was 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:

formId - The ID of the form you want to undeploy. The ID is at most 255 characters long.

Returns:

A RestResponse containing the status code of the HttpResponse.

Throws:

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