@Component(value="com.sap.cloud.sdk.services.scp.workflow.cf.api.PurgeApi") @Beta public class PurgeApi extends AbstractRestService
|Constructor and Description|
Instantiates this API class to invoke operations on the the Workflow API for Cloud Foundry.
@Nonnull public RestResponse purge() throws RestRequestException
Purge instances and definitions
Completely erases all workflow definitions, all workflow instances, and all form definitions. Roles permitted to execute this operation: - Global roles: WorkflowTenantOperator - Scope: DATA_PURGE
202 - The request is successful and the purge operation will be performed 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 purge operation.
303 - A purge operation 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 purge operation. Depending on your web client you may be automatically redirected to this resource and receive the status of the purge operation as the result of your request.
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.
RestRequestException- if an error occurs while attempting to invoke the API
Copyright © 2020 SAP SE. All rights reserved.