/rest/v1/data-acquisition/data
Deletes the acquired data that consists of the acquired events and context. Roles required to execute this operation: - Global roles: PVTenantOperator
/rest/v1/data-acquisition/data
Usage
curl -X delete "https://bpmpvruntime.cfapps.sap.hana.ondemand.com/pv-service/rest/v1/data-acquisition/data?processDefinitionId=&processInstanceId=&eventType=&acquiredFrom=&acquiredUpto="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataAcquisitionApi;
import java.io.File;
import java.util.*;
public class DataAcquisitionApiExample {
public static void main(String[] args) {
DataAcquisitionApi apiInstance = new DataAcquisitionApi();
String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
String acceptLanguage = acceptLanguage_example; // String | User's language preference
String processDefinitionId = processDefinitionId_example; // String | ID of the process definition.
String processInstanceId = processInstanceId_example; // String | ID of the process instance.
String eventType = eventType_example; // String | Identifies the type of event that has occurred.
String acquiredFrom = acquiredFrom_example; // String | The start time (inclusive) of the time range when the event was acquired. It must be specified with 'acquiredUpto' parameter and be lesser than or equal to the value of the 'acquiredUpto' parameter. The supported date format is yyyy-MM-dd'T'HH:mm:ss'Z'.
String acquiredUpto = acquiredUpto_example; // String | The end time (inclusive) of the time range when the event was acquired. It must be specified with the 'acquiredFrom' parameter greater than or equal to the value of the 'acquiredFrom' parameter. The supported date format is yyyy-MM-dd'T'HH:mm:ss'Z'.
try {
apiInstance.restV1DataAcquisitionDataDelete(authorization, acceptLanguage, processDefinitionId, processInstanceId, eventType, acquiredFrom, acquiredUpto);
} catch (ApiException e) {
System.err.println("Exception when calling DataAcquisitionApi#restV1DataAcquisitionDataDelete");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DataAcquisitionApi;
public class DataAcquisitionApiExample {
public static void main(String[] args) {
DataAcquisitionApi apiInstance = new DataAcquisitionApi();
String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
String acceptLanguage = acceptLanguage_example; // String | User's language preference
String processDefinitionId = processDefinitionId_example; // String | ID of the process definition.
String processInstanceId = processInstanceId_example; // String | ID of the process instance.
String eventType = eventType_example; // String | Identifies the type of event that has occurred.
String acquiredFrom = acquiredFrom_example; // String | The start time (inclusive) of the time range when the event was acquired. It must be specified with 'acquiredUpto' parameter and be lesser than or equal to the value of the 'acquiredUpto' parameter. The supported date format is yyyy-MM-dd'T'HH:mm:ss'Z'.
String acquiredUpto = acquiredUpto_example; // String | The end time (inclusive) of the time range when the event was acquired. It must be specified with the 'acquiredFrom' parameter greater than or equal to the value of the 'acquiredFrom' parameter. The supported date format is yyyy-MM-dd'T'HH:mm:ss'Z'.
try {
apiInstance.restV1DataAcquisitionDataDelete(authorization, acceptLanguage, processDefinitionId, processInstanceId, eventType, acquiredFrom, acquiredUpto);
} catch (ApiException e) {
System.err.println("Exception when calling DataAcquisitionApi#restV1DataAcquisitionDataDelete");
e.printStackTrace();
}
}
}
String *authorization = authorization_example; // Valid access token(value = bearer {access token}).
String *acceptLanguage = acceptLanguage_example; // User's language preference (optional)
String *processDefinitionId = processDefinitionId_example; // ID of the process definition. (optional)
String *processInstanceId = processInstanceId_example; // ID of the process instance. (optional)
String *eventType = eventType_example; // Identifies the type of event that has occurred. (optional)
String *acquiredFrom = acquiredFrom_example; // The start time (inclusive) of the time range when the event was acquired. It must be specified with 'acquiredUpto' parameter and be lesser than or equal to the value of the 'acquiredUpto' parameter. The supported date format is yyyy-MM-dd'T'HH:mm:ss'Z'. (optional)
String *acquiredUpto = acquiredUpto_example; // The end time (inclusive) of the time range when the event was acquired. It must be specified with the 'acquiredFrom' parameter greater than or equal to the value of the 'acquiredFrom' parameter. The supported date format is yyyy-MM-dd'T'HH:mm:ss'Z'. (optional)
DataAcquisitionApi *apiInstance = [[DataAcquisitionApi alloc] init];
// Deletes the acquired data
[apiInstance restV1DataAcquisitionDataDeleteWith:authorization
acceptLanguage:acceptLanguage
processDefinitionId:processDefinitionId
processInstanceId:processInstanceId
eventType:eventType
acquiredFrom:acquiredFrom
acquiredUpto:acquiredUpto
completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
}];
var ProcessVisibility = require('process_visibility');
var api = new ProcessVisibility.DataAcquisitionApi()
var authorization = authorization_example; // {String} Valid access token(value = bearer {access token}).
var opts = {
'acceptLanguage': acceptLanguage_example, // {String} User's language preference
'processDefinitionId': processDefinitionId_example, // {String} ID of the process definition.
'processInstanceId': processInstanceId_example, // {String} ID of the process instance.
'eventType': eventType_example, // {String} Identifies the type of event that has occurred.
'acquiredFrom': acquiredFrom_example, // {String} The start time (inclusive) of the time range when the event was acquired. It must be specified with 'acquiredUpto' parameter and be lesser than or equal to the value of the 'acquiredUpto' parameter. The supported date format is yyyy-MM-dd'T'HH:mm:ss'Z'.
'acquiredUpto': acquiredUpto_example // {String} The end time (inclusive) of the time range when the event was acquired. It must be specified with the 'acquiredFrom' parameter greater than or equal to the value of the 'acquiredFrom' parameter. The supported date format is yyyy-MM-dd'T'HH:mm:ss'Z'.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.restV1DataAcquisitionDataDelete(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class restV1DataAcquisitionDataDeleteExample
{
public void main()
{
var apiInstance = new DataAcquisitionApi();
var authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
var acceptLanguage = acceptLanguage_example; // String | User's language preference (optional)
var processDefinitionId = processDefinitionId_example; // String | ID of the process definition. (optional)
var processInstanceId = processInstanceId_example; // String | ID of the process instance. (optional)
var eventType = eventType_example; // String | Identifies the type of event that has occurred. (optional)
var acquiredFrom = acquiredFrom_example; // String | The start time (inclusive) of the time range when the event was acquired. It must be specified with 'acquiredUpto' parameter and be lesser than or equal to the value of the 'acquiredUpto' parameter. The supported date format is yyyy-MM-dd'T'HH:mm:ss'Z'. (optional)
var acquiredUpto = acquiredUpto_example; // String | The end time (inclusive) of the time range when the event was acquired. It must be specified with the 'acquiredFrom' parameter greater than or equal to the value of the 'acquiredFrom' parameter. The supported date format is yyyy-MM-dd'T'HH:mm:ss'Z'. (optional)
try
{
// Deletes the acquired data
apiInstance.restV1DataAcquisitionDataDelete(authorization, acceptLanguage, processDefinitionId, processInstanceId, eventType, acquiredFrom, acquiredUpto);
}
catch (Exception e)
{
Debug.Print("Exception when calling DataAcquisitionApi.restV1DataAcquisitionDataDelete: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\DataAcquisitionApi();
$authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
$acceptLanguage = acceptLanguage_example; // String | User's language preference
$processDefinitionId = processDefinitionId_example; // String | ID of the process definition.
$processInstanceId = processInstanceId_example; // String | ID of the process instance.
$eventType = eventType_example; // String | Identifies the type of event that has occurred.
$acquiredFrom = acquiredFrom_example; // String | The start time (inclusive) of the time range when the event was acquired. It must be specified with 'acquiredUpto' parameter and be lesser than or equal to the value of the 'acquiredUpto' parameter. The supported date format is yyyy-MM-dd'T'HH:mm:ss'Z'.
$acquiredUpto = acquiredUpto_example; // String | The end time (inclusive) of the time range when the event was acquired. It must be specified with the 'acquiredFrom' parameter greater than or equal to the value of the 'acquiredFrom' parameter. The supported date format is yyyy-MM-dd'T'HH:mm:ss'Z'.
try {
$api_instance->restV1DataAcquisitionDataDelete($authorization, $acceptLanguage, $processDefinitionId, $processInstanceId, $eventType, $acquiredFrom, $acquiredUpto);
} catch (Exception $e) {
echo 'Exception when calling DataAcquisitionApi->restV1DataAcquisitionDataDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataAcquisitionApi;
my $api_instance = WWW::SwaggerClient::DataAcquisitionApi->new();
my $authorization = authorization_example; # String | Valid access token(value = bearer {access token}).
my $acceptLanguage = acceptLanguage_example; # String | User's language preference
my $processDefinitionId = processDefinitionId_example; # String | ID of the process definition.
my $processInstanceId = processInstanceId_example; # String | ID of the process instance.
my $eventType = eventType_example; # String | Identifies the type of event that has occurred.
my $acquiredFrom = acquiredFrom_example; # String | The start time (inclusive) of the time range when the event was acquired. It must be specified with 'acquiredUpto' parameter and be lesser than or equal to the value of the 'acquiredUpto' parameter. The supported date format is yyyy-MM-dd'T'HH:mm:ss'Z'.
my $acquiredUpto = acquiredUpto_example; # String | The end time (inclusive) of the time range when the event was acquired. It must be specified with the 'acquiredFrom' parameter greater than or equal to the value of the 'acquiredFrom' parameter. The supported date format is yyyy-MM-dd'T'HH:mm:ss'Z'.
eval {
$api_instance->restV1DataAcquisitionDataDelete(authorization => $authorization, acceptLanguage => $acceptLanguage, processDefinitionId => $processDefinitionId, processInstanceId => $processInstanceId, eventType => $eventType, acquiredFrom => $acquiredFrom, acquiredUpto => $acquiredUpto);
};
if ($@) {
warn "Exception when calling DataAcquisitionApi->restV1DataAcquisitionDataDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DataAcquisitionApi()
authorization = authorization_example # String | Valid access token(value = bearer {access token}).
acceptLanguage = acceptLanguage_example # String | User's language preference (optional)
processDefinitionId = processDefinitionId_example # String | ID of the process definition. (optional)
processInstanceId = processInstanceId_example # String | ID of the process instance. (optional)
eventType = eventType_example # String | Identifies the type of event that has occurred. (optional)
acquiredFrom = acquiredFrom_example # String | The start time (inclusive) of the time range when the event was acquired. It must be specified with 'acquiredUpto' parameter and be lesser than or equal to the value of the 'acquiredUpto' parameter. The supported date format is yyyy-MM-dd'T'HH:mm:ss'Z'. (optional)
acquiredUpto = acquiredUpto_example # String | The end time (inclusive) of the time range when the event was acquired. It must be specified with the 'acquiredFrom' parameter greater than or equal to the value of the 'acquiredFrom' parameter. The supported date format is yyyy-MM-dd'T'HH:mm:ss'Z'. (optional)
try:
# Deletes the acquired data
api_instance.restV1DataAcquisitionDataDelete(authorization, acceptLanguage=acceptLanguage, processDefinitionId=processDefinitionId, processInstanceId=processInstanceId, eventType=eventType, acquiredFrom=acquiredFrom, acquiredUpto=acquiredUpto)
except ApiException as e:
print("Exception when calling DataAcquisitionApi->restV1DataAcquisitionDataDelete: %s\n" % e)
Parameters
Name | Description |
---|---|
Accept-Language | |
Authorization* |
Name | Description |
---|---|
processDefinitionId | |
processInstanceId | |
eventType | |
acquiredFrom | |
acquiredUpto |
Responses
Status: 200 - Data has been deleted successfully.
Status: 204 - The server successfully processed the request, but is not returning any content.
Status: 400 - The syntax of the sent request is invalid. Required query parameters are missing.
Status: 401 - Unauthorized. The access token is invalid.
Status: 403 - Access forbidden. You do not have the required permissions to access the resource.
Status: 412 - Query Parameter Input has invalid characters.
{warning={code=bpm.pvs.data.acquisition.filter.input.details.invalid, message=Filter criteria should not contain '[$, {, }]'.}}
Status: 422 - Query parameter acquiredFrom or acquiredUpto is not supplied in the supported format.
Status: 500 - Internal server error. The operation you requested led to an error during execution.
{error={code=bpm.pvs.request.processing.error, message=Internal server error during execution of the request., details=[{severity=error, message=Internal server error. An error occurred while processing your request. Please contact the service provider.}]}}