Process Visibility

DataAcquisition

/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

Header parameters
Name Description
Accept-Language
Authorization*
Query parameters
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.}]}}

/rest/v1/data-acquisition/data

Fetches the events that have been acquired by the service. Roles required to execute this operation: - Global roles: PVAdmin, PVTenantOperator


/rest/v1/data-acquisition/data

Usage

curl -X get "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. 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. 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 {
            ProcessEventsList result = apiInstance.restV1DataAcquisitionDataGet(authorization, acceptLanguage, processDefinitionId, processInstanceId, eventType, acquiredFrom, acquiredUpto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAcquisitionApi#restV1DataAcquisitionDataGet");
            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. 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. 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 {
            ProcessEventsList result = apiInstance.restV1DataAcquisitionDataGet(authorization, acceptLanguage, processDefinitionId, processInstanceId, eventType, acquiredFrom, acquiredUpto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAcquisitionApi#restV1DataAcquisitionDataGet");
            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. 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. 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];

// Fetches the acquired events
[apiInstance restV1DataAcquisitionDataGetWith:authorization
    acceptLanguage:acceptLanguage
    processDefinitionId:processDefinitionId
    processInstanceId:processInstanceId
    eventType:eventType
    acquiredFrom:acquiredFrom
    acquiredUpto:acquiredUpto
              completionHandler: ^(ProcessEventsList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            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. 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. 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. Returned data: ' + data);
  }
};
api.restV1DataAcquisitionDataGet(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class restV1DataAcquisitionDataGetExample
    {
        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. 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. 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
            {
                // Fetches the acquired events
                ProcessEventsList result = apiInstance.restV1DataAcquisitionDataGet(authorization, acceptLanguage, processDefinitionId, processInstanceId, eventType, acquiredFrom, acquiredUpto);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataAcquisitionApi.restV1DataAcquisitionDataGet: " + 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. 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. 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 {
    $result = $api_instance->restV1DataAcquisitionDataGet($authorization, $acceptLanguage, $processDefinitionId, $processInstanceId, $eventType, $acquiredFrom, $acquiredUpto);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataAcquisitionApi->restV1DataAcquisitionDataGet: ', $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. 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. 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 { 
    my $result = $api_instance->restV1DataAcquisitionDataGet(authorization => $authorization, acceptLanguage => $acceptLanguage, processDefinitionId => $processDefinitionId, processInstanceId => $processInstanceId, eventType => $eventType, acquiredFrom => $acquiredFrom, acquiredUpto => $acquiredUpto);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataAcquisitionApi->restV1DataAcquisitionDataGet: $@\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. 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. 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: 
    # Fetches the acquired events
    api_response = api_instance.restV1DataAcquisitionDataGet(authorization, acceptLanguage=acceptLanguage, processDefinitionId=processDefinitionId, processInstanceId=processInstanceId, eventType=eventType, acquiredFrom=acquiredFrom, acquiredUpto=acquiredUpto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataAcquisitionApi->restV1DataAcquisitionDataGet: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
Authorization*
Query parameters
Name Description
processDefinitionId
processInstanceId
eventType
acquiredFrom
acquiredUpto

Responses

Status: 200 - Returns a list of acquired events.

[{processDefintionId=DESIGN, processInstanceId=DESIGN_Instance_1, eventType=Project Created, timestamp=2018-09-29T02:07:42Z, eventId=project_created, activityDefinitionId=PROJECT_START, activityInstanceId=PROJECT_START_INSTANCE_1, processVersionId=1, userDisplayName=abc, userId=D1234, insertedTime=2018-09-29T02:07:42Z}, {processDefinitionId=MANUFACTURE, processInstanceId=MANUFACTURE_Instance_1, eventType=Production Finished, timestamp=2018-09-30T02:07:42Z, eventId=production_finished, activityDefinitionId=PRODUCTION_END, activityInstanceId=PRODUCTION_END_INSTANCE_1, processVersionId=1, userDisplayName=abc, userId=D1234, insertedTime=2018-09-30T02:07:42Z}]

Status: 400 - Syntax of the sent request is invalid. The 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 provided 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.}]}}

/rest/v1/data-acquisition/data

Push events to the service. Roles required to execute this operation: - Global roles: PVEventSender


/rest/v1/data-acquisition/data

Usage

curl -X post "https://bpmpvruntime.cfapps.sap.hana.ondemand.com/pv-service/rest/v1/data-acquisition/data"
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();
        MessageQueueEventList events = ; // MessageQueueEventList | JSON payload defining multiple events as an array or single event object as per the event definition.
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            apiInstance.restV1DataAcquisitionDataPost(events, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAcquisitionApi#restV1DataAcquisitionDataPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataAcquisitionApi;

public class DataAcquisitionApiExample {

    public static void main(String[] args) {
        DataAcquisitionApi apiInstance = new DataAcquisitionApi();
        MessageQueueEventList events = ; // MessageQueueEventList | JSON payload defining multiple events as an array or single event object as per the event definition.
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            apiInstance.restV1DataAcquisitionDataPost(events, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAcquisitionApi#restV1DataAcquisitionDataPost");
            e.printStackTrace();
        }
    }
}
MessageQueueEventList *events = ; // JSON payload defining multiple events as an array or single event object as per the event definition.
String *acceptLanguage = acceptLanguage_example; // User's language preference (optional)

DataAcquisitionApi *apiInstance = [[DataAcquisitionApi alloc] init];

// Push events
[apiInstance restV1DataAcquisitionDataPostWith:events
    acceptLanguage:acceptLanguage
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProcessVisibility = require('process_visibility');

var api = new ProcessVisibility.DataAcquisitionApi()

var events = ; // {MessageQueueEventList} JSON payload defining multiple events as an array or single event object as per the event definition.

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} User's language preference
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.restV1DataAcquisitionDataPost(events, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class restV1DataAcquisitionDataPostExample
    {
        public void main()
        {
            
            var apiInstance = new DataAcquisitionApi();
            var events = new MessageQueueEventList(); // MessageQueueEventList | JSON payload defining multiple events as an array or single event object as per the event definition.
            var acceptLanguage = acceptLanguage_example;  // String | User's language preference (optional) 

            try
            {
                // Push events
                apiInstance.restV1DataAcquisitionDataPost(events, acceptLanguage);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataAcquisitionApi.restV1DataAcquisitionDataPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DataAcquisitionApi();
$events = ; // MessageQueueEventList | JSON payload defining multiple events as an array or single event object as per the event definition.
$acceptLanguage = acceptLanguage_example; // String | User's language preference

try {
    $api_instance->restV1DataAcquisitionDataPost($events, $acceptLanguage);
} catch (Exception $e) {
    echo 'Exception when calling DataAcquisitionApi->restV1DataAcquisitionDataPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataAcquisitionApi;

my $api_instance = WWW::SwaggerClient::DataAcquisitionApi->new();
my $events = WWW::SwaggerClient::Object::MessageQueueEventList->new(); # MessageQueueEventList | JSON payload defining multiple events as an array or single event object as per the event definition.
my $acceptLanguage = acceptLanguage_example; # String | User's language preference

eval { 
    $api_instance->restV1DataAcquisitionDataPost(events => $events, acceptLanguage => $acceptLanguage);
};
if ($@) {
    warn "Exception when calling DataAcquisitionApi->restV1DataAcquisitionDataPost: $@\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()
events =  # MessageQueueEventList | JSON payload defining multiple events as an array or single event object as per the event definition.
acceptLanguage = acceptLanguage_example # String | User's language preference (optional)

try: 
    # Push events
    api_instance.restV1DataAcquisitionDataPost(events, acceptLanguage=acceptLanguage)
except ApiException as e:
    print("Exception when calling DataAcquisitionApi->restV1DataAcquisitionDataPost: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
Body parameters
Name Description
events *

JSON payload defining multiple events as an array or single event object as per the event definition.

Responses

Status: 204 - Data has been acquired successfully.

Status: 400 - The request payload is missing or invalid.

Status: 401 - Unauthorized. The access token is invalid.

Status: 403 - Access forbidden. You do not have the required permissions to access the resource.

Status: 413 - Payload size must not exceed 512 KB for the LITE plan.

Status: 422 - Unprocessable entity. There are validaiton errors.

{error={logId=f37bd507-bd9c-428e-ad81-b2df616ce6a8, code=bpm.pvs.data.acquisition.event.message.invalid, message=Invalid message received. Please check data acquisition error logs for more details., details=[{severity=error, code=bpm.pvs.data.acquisition.timestamp.format.invalid, message=Timestamp does not comply to the required format yyyy-MM-dd'T'HH:mm:ss'Z' (ISO 8601 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.}]}}

/rest/v1/data-acquisition/error-messages

Fetches the error messages occurred during data acquisition. Roles required to execute this operation: - Global roles: PVAdmin


/rest/v1/data-acquisition/error-messages

Usage

curl -X get "https://bpmpvruntime.cfapps.sap.hana.ondemand.com/pv-service/rest/v1/data-acquisition/error-messages"
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
        try {
            apiInstance.restV1DataAcquisitionErrorMessagesGet(authorization, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAcquisitionApi#restV1DataAcquisitionErrorMessagesGet");
            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
        try {
            apiInstance.restV1DataAcquisitionErrorMessagesGet(authorization, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAcquisitionApi#restV1DataAcquisitionErrorMessagesGet");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Valid access token(value = bearer {access token}).
String *acceptLanguage = acceptLanguage_example; // User's language preference (optional)

DataAcquisitionApi *apiInstance = [[DataAcquisitionApi alloc] init];

// Fetches the error messages occurred during data acqusition
[apiInstance restV1DataAcquisitionErrorMessagesGetWith:authorization
    acceptLanguage:acceptLanguage
              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
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.restV1DataAcquisitionErrorMessagesGet(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class restV1DataAcquisitionErrorMessagesGetExample
    {
        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) 

            try
            {
                // Fetches the error messages occurred during data acqusition
                apiInstance.restV1DataAcquisitionErrorMessagesGet(authorization, acceptLanguage);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataAcquisitionApi.restV1DataAcquisitionErrorMessagesGet: " + 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

try {
    $api_instance->restV1DataAcquisitionErrorMessagesGet($authorization, $acceptLanguage);
} catch (Exception $e) {
    echo 'Exception when calling DataAcquisitionApi->restV1DataAcquisitionErrorMessagesGet: ', $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

eval { 
    $api_instance->restV1DataAcquisitionErrorMessagesGet(authorization => $authorization, acceptLanguage => $acceptLanguage);
};
if ($@) {
    warn "Exception when calling DataAcquisitionApi->restV1DataAcquisitionErrorMessagesGet: $@\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)

try: 
    # Fetches the error messages occurred during data acqusition
    api_instance.restV1DataAcquisitionErrorMessagesGet(authorization, acceptLanguage=acceptLanguage)
except ApiException as e:
    print("Exception when calling DataAcquisitionApi->restV1DataAcquisitionErrorMessagesGet: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
Authorization*

Responses

Status: 200 - Error messages are successfully retrieved.

Status: 401 - Unauthorized. The access token is invalid.

Status: 403 - Access forbidden. You do not have the required permissions to access the resource.

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.}]}}

Processing

/rest/v1/scenario-definitions/{scenarioId}/data

Clears all the processed data for the given scenario, without deleting the scenario model. Roles required to execute this operation: - Global roles: PVAdmin


/rest/v1/scenario-definitions/{scenarioId}/data

Usage

curl -X delete "https://bpmpvruntime.cfapps.sap.hana.ondemand.com/pv-service/rest/v1/scenario-definitions/{scenarioId}/data"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProcessingApi;

import java.io.File;
import java.util.*;

public class ProcessingApiExample {

    public static void main(String[] args) {
        
        ProcessingApi apiInstance = new ProcessingApi();
        String scenarioId = scenarioId_example; // String | ID of the scenario.
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            apiInstance.restV1ScenarioDefinitionsScenarioIdDataDelete(scenarioId, authorization, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessingApi#restV1ScenarioDefinitionsScenarioIdDataDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProcessingApi;

public class ProcessingApiExample {

    public static void main(String[] args) {
        ProcessingApi apiInstance = new ProcessingApi();
        String scenarioId = scenarioId_example; // String | ID of the scenario.
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            apiInstance.restV1ScenarioDefinitionsScenarioIdDataDelete(scenarioId, authorization, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessingApi#restV1ScenarioDefinitionsScenarioIdDataDelete");
            e.printStackTrace();
        }
    }
}
String *scenarioId = scenarioId_example; // ID of the scenario.
String *authorization = authorization_example; // Valid access token(value = bearer {access token}).
String *acceptLanguage = acceptLanguage_example; // User's language preference (optional)

ProcessingApi *apiInstance = [[ProcessingApi alloc] init];

// Clears the processed data for the given scenario definition
[apiInstance restV1ScenarioDefinitionsScenarioIdDataDeleteWith:scenarioId
    authorization:authorization
    acceptLanguage:acceptLanguage
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProcessVisibility = require('process_visibility');

var api = new ProcessVisibility.ProcessingApi()

var scenarioId = scenarioId_example; // {String} ID of the scenario.

var authorization = authorization_example; // {String} Valid access token(value = bearer {access token}).

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} User's language preference
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.restV1ScenarioDefinitionsScenarioIdDataDelete(scenarioId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class restV1ScenarioDefinitionsScenarioIdDataDeleteExample
    {
        public void main()
        {
            
            var apiInstance = new ProcessingApi();
            var scenarioId = scenarioId_example;  // String | ID of the scenario.
            var authorization = authorization_example;  // String | Valid access token(value = bearer {access token}).
            var acceptLanguage = acceptLanguage_example;  // String | User's language preference (optional) 

            try
            {
                // Clears the processed data for the given scenario definition
                apiInstance.restV1ScenarioDefinitionsScenarioIdDataDelete(scenarioId, authorization, acceptLanguage);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessingApi.restV1ScenarioDefinitionsScenarioIdDataDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProcessingApi();
$scenarioId = scenarioId_example; // String | ID of the scenario.
$authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
$acceptLanguage = acceptLanguage_example; // String | User's language preference

try {
    $api_instance->restV1ScenarioDefinitionsScenarioIdDataDelete($scenarioId, $authorization, $acceptLanguage);
} catch (Exception $e) {
    echo 'Exception when calling ProcessingApi->restV1ScenarioDefinitionsScenarioIdDataDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProcessingApi;

my $api_instance = WWW::SwaggerClient::ProcessingApi->new();
my $scenarioId = scenarioId_example; # String | ID of the scenario.
my $authorization = authorization_example; # String | Valid access token(value = bearer {access token}).
my $acceptLanguage = acceptLanguage_example; # String | User's language preference

eval { 
    $api_instance->restV1ScenarioDefinitionsScenarioIdDataDelete(scenarioId => $scenarioId, authorization => $authorization, acceptLanguage => $acceptLanguage);
};
if ($@) {
    warn "Exception when calling ProcessingApi->restV1ScenarioDefinitionsScenarioIdDataDelete: $@\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.ProcessingApi()
scenarioId = scenarioId_example # String | ID of the scenario.
authorization = authorization_example # String | Valid access token(value = bearer {access token}).
acceptLanguage = acceptLanguage_example # String | User's language preference (optional)

try: 
    # Clears the processed data for the given scenario definition
    api_instance.restV1ScenarioDefinitionsScenarioIdDataDelete(scenarioId, authorization, acceptLanguage=acceptLanguage)
except ApiException as e:
    print("Exception when calling ProcessingApi->restV1ScenarioDefinitionsScenarioIdDataDelete: %s\n" % e)

Parameters

Path parameters
Name Description
scenarioId*
Header parameters
Name Description
Accept-Language
Authorization*

Responses

Status: 200 - Processed data successfully deleted for the given scenario definition.

Status: 401 - Unauthorized. The access token is invalid.

Status: 403 - Access forbidden. You do not have the required permissions to access the resource.

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.}]}}

/rest/v1/scenario-definitions/{scenarioId}/data-executions

Fetches the 20 most recent process data execution logs for the given scenario definition. Roles required to execute this operation: - Global roles: PVAdmin


/rest/v1/scenario-definitions/{scenarioId}/data-executions

Usage

curl -X get "https://bpmpvruntime.cfapps.sap.hana.ondemand.com/pv-service/rest/v1/scenario-definitions/{scenarioId}/data-executions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProcessingApi;

import java.io.File;
import java.util.*;

public class ProcessingApiExample {

    public static void main(String[] args) {
        
        ProcessingApi apiInstance = new ProcessingApi();
        String scenarioId = scenarioId_example; // String | ID of the scenario.
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            DataExecutionLogList result = apiInstance.restV1ScenarioDefinitionsScenarioIdDataExecutionsGet(scenarioId, authorization, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessingApi#restV1ScenarioDefinitionsScenarioIdDataExecutionsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProcessingApi;

public class ProcessingApiExample {

    public static void main(String[] args) {
        ProcessingApi apiInstance = new ProcessingApi();
        String scenarioId = scenarioId_example; // String | ID of the scenario.
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            DataExecutionLogList result = apiInstance.restV1ScenarioDefinitionsScenarioIdDataExecutionsGet(scenarioId, authorization, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessingApi#restV1ScenarioDefinitionsScenarioIdDataExecutionsGet");
            e.printStackTrace();
        }
    }
}
String *scenarioId = scenarioId_example; // ID of the scenario.
String *authorization = authorization_example; // Valid access token(value = bearer {access token}).
String *acceptLanguage = acceptLanguage_example; // User's language preference (optional)

ProcessingApi *apiInstance = [[ProcessingApi alloc] init];

// Fetches the process data execution logs for the given scenario definition
[apiInstance restV1ScenarioDefinitionsScenarioIdDataExecutionsGetWith:scenarioId
    authorization:authorization
    acceptLanguage:acceptLanguage
              completionHandler: ^(DataExecutionLogList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProcessVisibility = require('process_visibility');

var api = new ProcessVisibility.ProcessingApi()

var scenarioId = scenarioId_example; // {String} ID of the scenario.

var authorization = authorization_example; // {String} Valid access token(value = bearer {access token}).

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} User's language preference
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.restV1ScenarioDefinitionsScenarioIdDataExecutionsGet(scenarioId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class restV1ScenarioDefinitionsScenarioIdDataExecutionsGetExample
    {
        public void main()
        {
            
            var apiInstance = new ProcessingApi();
            var scenarioId = scenarioId_example;  // String | ID of the scenario.
            var authorization = authorization_example;  // String | Valid access token(value = bearer {access token}).
            var acceptLanguage = acceptLanguage_example;  // String | User's language preference (optional) 

            try
            {
                // Fetches the process data execution logs for the given scenario definition
                DataExecutionLogList result = apiInstance.restV1ScenarioDefinitionsScenarioIdDataExecutionsGet(scenarioId, authorization, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessingApi.restV1ScenarioDefinitionsScenarioIdDataExecutionsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProcessingApi();
$scenarioId = scenarioId_example; // String | ID of the scenario.
$authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
$acceptLanguage = acceptLanguage_example; // String | User's language preference

try {
    $result = $api_instance->restV1ScenarioDefinitionsScenarioIdDataExecutionsGet($scenarioId, $authorization, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessingApi->restV1ScenarioDefinitionsScenarioIdDataExecutionsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProcessingApi;

my $api_instance = WWW::SwaggerClient::ProcessingApi->new();
my $scenarioId = scenarioId_example; # String | ID of the scenario.
my $authorization = authorization_example; # String | Valid access token(value = bearer {access token}).
my $acceptLanguage = acceptLanguage_example; # String | User's language preference

eval { 
    my $result = $api_instance->restV1ScenarioDefinitionsScenarioIdDataExecutionsGet(scenarioId => $scenarioId, authorization => $authorization, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProcessingApi->restV1ScenarioDefinitionsScenarioIdDataExecutionsGet: $@\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.ProcessingApi()
scenarioId = scenarioId_example # String | ID of the scenario.
authorization = authorization_example # String | Valid access token(value = bearer {access token}).
acceptLanguage = acceptLanguage_example # String | User's language preference (optional)

try: 
    # Fetches the process data execution logs for the given scenario definition
    api_response = api_instance.restV1ScenarioDefinitionsScenarioIdDataExecutionsGet(scenarioId, authorization, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessingApi->restV1ScenarioDefinitionsScenarioIdDataExecutionsGet: %s\n" % e)

Parameters

Path parameters
Name Description
scenarioId*
Header parameters
Name Description
Accept-Language
Authorization*

Responses

Status: 200 - Data execution logs have been successfully fetched.

[{startTime=2019-06-20 14:35:44.747, status=COMPLETED, noOfEventsInBuffer=0, noOfInstanceProcessed=0, noOfEventsProcessed=0}]

Status: 401 - Unauthorized. The access token is invalid.

Status: 403 - Access forbidden. You do not have the required permissions to access the resource.

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.}]}}

/rest/v1/scenario-definitions/{scenarioId}/data-executions

Processes the attributes and other visibility patterns defined in the scenario model. Roles required to execute this operation: - Global roles: PVAdmin


/rest/v1/scenario-definitions/{scenarioId}/data-executions

Usage

curl -X post "https://bpmpvruntime.cfapps.sap.hana.ondemand.com/pv-service/rest/v1/scenario-definitions/{scenarioId}/data-executions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProcessingApi;

import java.io.File;
import java.util.*;

public class ProcessingApiExample {

    public static void main(String[] args) {
        
        ProcessingApi apiInstance = new ProcessingApi();
        String scenarioId = scenarioId_example; // String | ID of the scenario.
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            apiInstance.restV1ScenarioDefinitionsScenarioIdDataExecutionsPost(scenarioId, authorization, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessingApi#restV1ScenarioDefinitionsScenarioIdDataExecutionsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProcessingApi;

public class ProcessingApiExample {

    public static void main(String[] args) {
        ProcessingApi apiInstance = new ProcessingApi();
        String scenarioId = scenarioId_example; // String | ID of the scenario.
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            apiInstance.restV1ScenarioDefinitionsScenarioIdDataExecutionsPost(scenarioId, authorization, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessingApi#restV1ScenarioDefinitionsScenarioIdDataExecutionsPost");
            e.printStackTrace();
        }
    }
}
String *scenarioId = scenarioId_example; // ID of the scenario.
String *authorization = authorization_example; // Valid access token(value = bearer {access token}).
String *acceptLanguage = acceptLanguage_example; // User's language preference (optional)

ProcessingApi *apiInstance = [[ProcessingApi alloc] init];

// Trigger a processing execution for the given scenario definition
[apiInstance restV1ScenarioDefinitionsScenarioIdDataExecutionsPostWith:scenarioId
    authorization:authorization
    acceptLanguage:acceptLanguage
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProcessVisibility = require('process_visibility');

var api = new ProcessVisibility.ProcessingApi()

var scenarioId = scenarioId_example; // {String} ID of the scenario.

var authorization = authorization_example; // {String} Valid access token(value = bearer {access token}).

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} User's language preference
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.restV1ScenarioDefinitionsScenarioIdDataExecutionsPost(scenarioId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class restV1ScenarioDefinitionsScenarioIdDataExecutionsPostExample
    {
        public void main()
        {
            
            var apiInstance = new ProcessingApi();
            var scenarioId = scenarioId_example;  // String | ID of the scenario.
            var authorization = authorization_example;  // String | Valid access token(value = bearer {access token}).
            var acceptLanguage = acceptLanguage_example;  // String | User's language preference (optional) 

            try
            {
                // Trigger a processing execution for the given scenario definition
                apiInstance.restV1ScenarioDefinitionsScenarioIdDataExecutionsPost(scenarioId, authorization, acceptLanguage);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessingApi.restV1ScenarioDefinitionsScenarioIdDataExecutionsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProcessingApi();
$scenarioId = scenarioId_example; // String | ID of the scenario.
$authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
$acceptLanguage = acceptLanguage_example; // String | User's language preference

try {
    $api_instance->restV1ScenarioDefinitionsScenarioIdDataExecutionsPost($scenarioId, $authorization, $acceptLanguage);
} catch (Exception $e) {
    echo 'Exception when calling ProcessingApi->restV1ScenarioDefinitionsScenarioIdDataExecutionsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProcessingApi;

my $api_instance = WWW::SwaggerClient::ProcessingApi->new();
my $scenarioId = scenarioId_example; # String | ID of the scenario.
my $authorization = authorization_example; # String | Valid access token(value = bearer {access token}).
my $acceptLanguage = acceptLanguage_example; # String | User's language preference

eval { 
    $api_instance->restV1ScenarioDefinitionsScenarioIdDataExecutionsPost(scenarioId => $scenarioId, authorization => $authorization, acceptLanguage => $acceptLanguage);
};
if ($@) {
    warn "Exception when calling ProcessingApi->restV1ScenarioDefinitionsScenarioIdDataExecutionsPost: $@\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.ProcessingApi()
scenarioId = scenarioId_example # String | ID of the scenario.
authorization = authorization_example # String | Valid access token(value = bearer {access token}).
acceptLanguage = acceptLanguage_example # String | User's language preference (optional)

try: 
    # Trigger a processing execution for the given scenario definition
    api_instance.restV1ScenarioDefinitionsScenarioIdDataExecutionsPost(scenarioId, authorization, acceptLanguage=acceptLanguage)
except ApiException as e:
    print("Exception when calling ProcessingApi->restV1ScenarioDefinitionsScenarioIdDataExecutionsPost: %s\n" % e)

Parameters

Path parameters
Name Description
scenarioId*
Header parameters
Name Description
Accept-Language
Authorization*

Responses

Status: 202 - The request has been accepted for processing, but processing has not been completed.

Status: 401 - Unauthorized. The access token is invalid.

Status: 403 - Access forbidden. You do not have the required permissions to access the resource.

Status: 404 - Unable to find the scenario for the given scenario ID in the system.

{error={code=bpm.pvs.scenario.not.found, message=Scenario not found with the given scenario ID, SCENARIO1234.}}

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.}]}}

ScenarioDefinitions

/rest/v1/scenario-definitions

Retrieves a list of all deployed scenario definitions. Roles required to execute this operation: - Global roles: PVAdmin


/rest/v1/scenario-definitions

Usage

curl -X get "https://bpmpvruntime.cfapps.sap.hana.ondemand.com/pv-service/rest/v1/scenario-definitions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScenarioDefinitionsApi;

import java.io.File;
import java.util.*;

public class ScenarioDefinitionsApiExample {

    public static void main(String[] args) {
        
        ScenarioDefinitionsApi apiInstance = new ScenarioDefinitionsApi();
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            ScenarioDefinitionList result = apiInstance.restV1ScenarioDefinitionsGet(authorization, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioDefinitionsApi#restV1ScenarioDefinitionsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScenarioDefinitionsApi;

public class ScenarioDefinitionsApiExample {

    public static void main(String[] args) {
        ScenarioDefinitionsApi apiInstance = new ScenarioDefinitionsApi();
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            ScenarioDefinitionList result = apiInstance.restV1ScenarioDefinitionsGet(authorization, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioDefinitionsApi#restV1ScenarioDefinitionsGet");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Valid access token(value = bearer {access token}).
String *acceptLanguage = acceptLanguage_example; // User's language preference (optional)

ScenarioDefinitionsApi *apiInstance = [[ScenarioDefinitionsApi alloc] init];

// Retrieve all scenario definitions
[apiInstance restV1ScenarioDefinitionsGetWith:authorization
    acceptLanguage:acceptLanguage
              completionHandler: ^(ScenarioDefinitionList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProcessVisibility = require('process_visibility');

var api = new ProcessVisibility.ScenarioDefinitionsApi()

var authorization = authorization_example; // {String} Valid access token(value = bearer {access token}).

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} User's language preference
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.restV1ScenarioDefinitionsGet(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class restV1ScenarioDefinitionsGetExample
    {
        public void main()
        {
            
            var apiInstance = new ScenarioDefinitionsApi();
            var authorization = authorization_example;  // String | Valid access token(value = bearer {access token}).
            var acceptLanguage = acceptLanguage_example;  // String | User's language preference (optional) 

            try
            {
                // Retrieve all scenario definitions
                ScenarioDefinitionList result = apiInstance.restV1ScenarioDefinitionsGet(authorization, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScenarioDefinitionsApi.restV1ScenarioDefinitionsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ScenarioDefinitionsApi();
$authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
$acceptLanguage = acceptLanguage_example; // String | User's language preference

try {
    $result = $api_instance->restV1ScenarioDefinitionsGet($authorization, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScenarioDefinitionsApi->restV1ScenarioDefinitionsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScenarioDefinitionsApi;

my $api_instance = WWW::SwaggerClient::ScenarioDefinitionsApi->new();
my $authorization = authorization_example; # String | Valid access token(value = bearer {access token}).
my $acceptLanguage = acceptLanguage_example; # String | User's language preference

eval { 
    my $result = $api_instance->restV1ScenarioDefinitionsGet(authorization => $authorization, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScenarioDefinitionsApi->restV1ScenarioDefinitionsGet: $@\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.ScenarioDefinitionsApi()
authorization = authorization_example # String | Valid access token(value = bearer {access token}).
acceptLanguage = acceptLanguage_example # String | User's language preference (optional)

try: 
    # Retrieve all scenario definitions
    api_response = api_instance.restV1ScenarioDefinitionsGet(authorization, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScenarioDefinitionsApi->restV1ScenarioDefinitionsGet: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
Authorization*

Responses

Status: 200 - Returns a list of deployed scenario definitions.

[{scenarioId=ONBOARDING, name=Onboarding Scenario, createdBy=abc.def@sap.com, createdAt=2018-10-23T18:13:52.804+0000}, {scenarioId=D2O, name=Design to Operate Scenario, createdBy=ghi.klm@sap.com, createdAt=2018-10-25T20:12:12.204+0000}]

Status: 401 - Unauthorized. The access token is invalid.

Status: 403 - Access forbidden. You do not have the required permissions to access the resource.

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.}]}}

/rest/v1/scenario-definitions

Deploys a scenario definition with the given scenario model. If the scenario definition already exists, then it updates the scenario model. Roles required to execute this operation: - Global roles: PVDeveloper, PVAdmin


/rest/v1/scenario-definitions

Usage

curl -X post "https://bpmpvruntime.cfapps.sap.hana.ondemand.com/pv-service/rest/v1/scenario-definitions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScenarioDefinitionsApi;

import java.io.File;
import java.util.*;

public class ScenarioDefinitionsApiExample {

    public static void main(String[] args) {
        
        ScenarioDefinitionsApi apiInstance = new ScenarioDefinitionsApi();
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        ScenarioModel body = ; // ScenarioModel | Specify the request body according to the given schema.
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            apiInstance.restV1ScenarioDefinitionsPost(authorization, body, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioDefinitionsApi#restV1ScenarioDefinitionsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScenarioDefinitionsApi;

public class ScenarioDefinitionsApiExample {

    public static void main(String[] args) {
        ScenarioDefinitionsApi apiInstance = new ScenarioDefinitionsApi();
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        ScenarioModel body = ; // ScenarioModel | Specify the request body according to the given schema.
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            apiInstance.restV1ScenarioDefinitionsPost(authorization, body, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioDefinitionsApi#restV1ScenarioDefinitionsPost");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Valid access token(value = bearer {access token}).
ScenarioModel *body = ; // Specify the request body according to the given schema.
String *acceptLanguage = acceptLanguage_example; // User's language preference (optional)

ScenarioDefinitionsApi *apiInstance = [[ScenarioDefinitionsApi alloc] init];

// Create new scenario definition or update existing scenario definition.
[apiInstance restV1ScenarioDefinitionsPostWith:authorization
    body:body
    acceptLanguage:acceptLanguage
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProcessVisibility = require('process_visibility');

var api = new ProcessVisibility.ScenarioDefinitionsApi()

var authorization = authorization_example; // {String} Valid access token(value = bearer {access token}).

var body = ; // {ScenarioModel} Specify the request body according to the given schema.

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} User's language preference
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.restV1ScenarioDefinitionsPost(authorization, body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class restV1ScenarioDefinitionsPostExample
    {
        public void main()
        {
            
            var apiInstance = new ScenarioDefinitionsApi();
            var authorization = authorization_example;  // String | Valid access token(value = bearer {access token}).
            var body = new ScenarioModel(); // ScenarioModel | Specify the request body according to the given schema.
            var acceptLanguage = acceptLanguage_example;  // String | User's language preference (optional) 

            try
            {
                // Create new scenario definition or update existing scenario definition.
                apiInstance.restV1ScenarioDefinitionsPost(authorization, body, acceptLanguage);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScenarioDefinitionsApi.restV1ScenarioDefinitionsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ScenarioDefinitionsApi();
$authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
$body = ; // ScenarioModel | Specify the request body according to the given schema.
$acceptLanguage = acceptLanguage_example; // String | User's language preference

try {
    $api_instance->restV1ScenarioDefinitionsPost($authorization, $body, $acceptLanguage);
} catch (Exception $e) {
    echo 'Exception when calling ScenarioDefinitionsApi->restV1ScenarioDefinitionsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScenarioDefinitionsApi;

my $api_instance = WWW::SwaggerClient::ScenarioDefinitionsApi->new();
my $authorization = authorization_example; # String | Valid access token(value = bearer {access token}).
my $body = WWW::SwaggerClient::Object::ScenarioModel->new(); # ScenarioModel | Specify the request body according to the given schema.
my $acceptLanguage = acceptLanguage_example; # String | User's language preference

eval { 
    $api_instance->restV1ScenarioDefinitionsPost(authorization => $authorization, body => $body, acceptLanguage => $acceptLanguage);
};
if ($@) {
    warn "Exception when calling ScenarioDefinitionsApi->restV1ScenarioDefinitionsPost: $@\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.ScenarioDefinitionsApi()
authorization = authorization_example # String | Valid access token(value = bearer {access token}).
body =  # ScenarioModel | Specify the request body according to the given schema.
acceptLanguage = acceptLanguage_example # String | User's language preference (optional)

try: 
    # Create new scenario definition or update existing scenario definition.
    api_instance.restV1ScenarioDefinitionsPost(authorization, body, acceptLanguage=acceptLanguage)
except ApiException as e:
    print("Exception when calling ScenarioDefinitionsApi->restV1ScenarioDefinitionsPost: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
Authorization*
Body parameters
Name Description
body *

Specify the request body according to the given schema.

Responses

Status: 201 - Scenario model has been successfully deployed.

Status: 400 - Unable to parse the scenario model.

{error={code=bpm.pvs.payload.invalid, message=The payload is not valid., details=[{severity=error, message=Unexpected end-of-input: expected close marker for Object (start marker at [Source: (PushbackInputStream); line: 1, column: 1]). Syntax error at Line No. 1 Column No. 3}]}}

Status: 401 - Unauthorized. The access token is invalid.

Status: 403 - Access forbidden. You do not have the required permissions to access the resource.

Status: 422 - Invalid scenario model

{error={code=bpm.pvs.scenario.schema.validation.error, message=An error occurred while consuming the scenario model as it is not compliant with the required schema definition., details=[{severity=error, message=Process Definition Id 'O2C_AG1' defined for event 'event3' is invalid}]}}

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.}]}}

/rest/v1/scenario-definitions/{scenarioId}

Deletes the existing scenario definition. This also deletes the corresponding scenario instances. Roles required to execute this operation: - Global roles: PVTenantOperator, PVAdmin


/rest/v1/scenario-definitions/{scenarioId}

Usage

curl -X delete "https://bpmpvruntime.cfapps.sap.hana.ondemand.com/pv-service/rest/v1/scenario-definitions/{scenarioId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScenarioDefinitionsApi;

import java.io.File;
import java.util.*;

public class ScenarioDefinitionsApiExample {

    public static void main(String[] args) {
        
        ScenarioDefinitionsApi apiInstance = new ScenarioDefinitionsApi();
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String scenarioId = scenarioId_example; // String | The ID of the scenario.
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            apiInstance.restV1ScenarioDefinitionsScenarioIdDelete(authorization, scenarioId, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioDefinitionsApi#restV1ScenarioDefinitionsScenarioIdDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScenarioDefinitionsApi;

public class ScenarioDefinitionsApiExample {

    public static void main(String[] args) {
        ScenarioDefinitionsApi apiInstance = new ScenarioDefinitionsApi();
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String scenarioId = scenarioId_example; // String | The ID of the scenario.
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            apiInstance.restV1ScenarioDefinitionsScenarioIdDelete(authorization, scenarioId, acceptLanguage);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioDefinitionsApi#restV1ScenarioDefinitionsScenarioIdDelete");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Valid access token(value = bearer {access token}).
String *scenarioId = scenarioId_example; // The ID of the scenario.
String *acceptLanguage = acceptLanguage_example; // User's language preference (optional)

ScenarioDefinitionsApi *apiInstance = [[ScenarioDefinitionsApi alloc] init];

// Delete scenario definition
[apiInstance restV1ScenarioDefinitionsScenarioIdDeleteWith:authorization
    scenarioId:scenarioId
    acceptLanguage:acceptLanguage
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProcessVisibility = require('process_visibility');

var api = new ProcessVisibility.ScenarioDefinitionsApi()

var authorization = authorization_example; // {String} Valid access token(value = bearer {access token}).

var scenarioId = scenarioId_example; // {String} The ID of the scenario.

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} User's language preference
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.restV1ScenarioDefinitionsScenarioIdDelete(authorization, scenarioId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class restV1ScenarioDefinitionsScenarioIdDeleteExample
    {
        public void main()
        {
            
            var apiInstance = new ScenarioDefinitionsApi();
            var authorization = authorization_example;  // String | Valid access token(value = bearer {access token}).
            var scenarioId = scenarioId_example;  // String | The ID of the scenario.
            var acceptLanguage = acceptLanguage_example;  // String | User's language preference (optional) 

            try
            {
                // Delete scenario definition
                apiInstance.restV1ScenarioDefinitionsScenarioIdDelete(authorization, scenarioId, acceptLanguage);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScenarioDefinitionsApi.restV1ScenarioDefinitionsScenarioIdDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ScenarioDefinitionsApi();
$authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
$scenarioId = scenarioId_example; // String | The ID of the scenario.
$acceptLanguage = acceptLanguage_example; // String | User's language preference

try {
    $api_instance->restV1ScenarioDefinitionsScenarioIdDelete($authorization, $scenarioId, $acceptLanguage);
} catch (Exception $e) {
    echo 'Exception when calling ScenarioDefinitionsApi->restV1ScenarioDefinitionsScenarioIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScenarioDefinitionsApi;

my $api_instance = WWW::SwaggerClient::ScenarioDefinitionsApi->new();
my $authorization = authorization_example; # String | Valid access token(value = bearer {access token}).
my $scenarioId = scenarioId_example; # String | The ID of the scenario.
my $acceptLanguage = acceptLanguage_example; # String | User's language preference

eval { 
    $api_instance->restV1ScenarioDefinitionsScenarioIdDelete(authorization => $authorization, scenarioId => $scenarioId, acceptLanguage => $acceptLanguage);
};
if ($@) {
    warn "Exception when calling ScenarioDefinitionsApi->restV1ScenarioDefinitionsScenarioIdDelete: $@\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.ScenarioDefinitionsApi()
authorization = authorization_example # String | Valid access token(value = bearer {access token}).
scenarioId = scenarioId_example # String | The ID of the scenario.
acceptLanguage = acceptLanguage_example # String | User's language preference (optional)

try: 
    # Delete scenario definition
    api_instance.restV1ScenarioDefinitionsScenarioIdDelete(authorization, scenarioId, acceptLanguage=acceptLanguage)
except ApiException as e:
    print("Exception when calling ScenarioDefinitionsApi->restV1ScenarioDefinitionsScenarioIdDelete: %s\n" % e)

Parameters

Path parameters
Name Description
scenarioId*
Header parameters
Name Description
Accept-Language
Authorization*

Responses

Status: 200 - Successfully deleted the scenario definition.

Status: 401 - Unauthorized. The access token is invalid.

Status: 403 - Access forbidden. You do not have the required permissions to access the resource.

Status: 404 - Unable to find the scenario for the given scenario ID in the system.

{error={code=bpm.pvs.scenario.not.found, message=Scenario not found with the given scenario ID, SCENARIO1234.}}

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.}]}}

/rest/v1/scenario-definitions/{scenarioId}

Retrieves the specified deployed scenario definition. Roles required to execute this operation: - Global roles: PVAdmin


/rest/v1/scenario-definitions/{scenarioId}

Usage

curl -X get "https://bpmpvruntime.cfapps.sap.hana.ondemand.com/pv-service/rest/v1/scenario-definitions/{scenarioId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScenarioDefinitionsApi;

import java.io.File;
import java.util.*;

public class ScenarioDefinitionsApiExample {

    public static void main(String[] args) {
        
        ScenarioDefinitionsApi apiInstance = new ScenarioDefinitionsApi();
        String scenarioId = scenarioId_example; // String | ID of the scenario.
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            ScenarioDefinition result = apiInstance.restV1ScenarioDefinitionsScenarioIdGet(scenarioId, authorization, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioDefinitionsApi#restV1ScenarioDefinitionsScenarioIdGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScenarioDefinitionsApi;

public class ScenarioDefinitionsApiExample {

    public static void main(String[] args) {
        ScenarioDefinitionsApi apiInstance = new ScenarioDefinitionsApi();
        String scenarioId = scenarioId_example; // String | ID of the scenario.
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            ScenarioDefinition result = apiInstance.restV1ScenarioDefinitionsScenarioIdGet(scenarioId, authorization, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioDefinitionsApi#restV1ScenarioDefinitionsScenarioIdGet");
            e.printStackTrace();
        }
    }
}
String *scenarioId = scenarioId_example; // ID of the scenario.
String *authorization = authorization_example; // Valid access token(value = bearer {access token}).
String *acceptLanguage = acceptLanguage_example; // User's language preference (optional)

ScenarioDefinitionsApi *apiInstance = [[ScenarioDefinitionsApi alloc] init];

// Retrieve scenario definition by ID
[apiInstance restV1ScenarioDefinitionsScenarioIdGetWith:scenarioId
    authorization:authorization
    acceptLanguage:acceptLanguage
              completionHandler: ^(ScenarioDefinition output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProcessVisibility = require('process_visibility');

var api = new ProcessVisibility.ScenarioDefinitionsApi()

var scenarioId = scenarioId_example; // {String} ID of the scenario.

var authorization = authorization_example; // {String} Valid access token(value = bearer {access token}).

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} User's language preference
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.restV1ScenarioDefinitionsScenarioIdGet(scenarioId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class restV1ScenarioDefinitionsScenarioIdGetExample
    {
        public void main()
        {
            
            var apiInstance = new ScenarioDefinitionsApi();
            var scenarioId = scenarioId_example;  // String | ID of the scenario.
            var authorization = authorization_example;  // String | Valid access token(value = bearer {access token}).
            var acceptLanguage = acceptLanguage_example;  // String | User's language preference (optional) 

            try
            {
                // Retrieve scenario definition by ID
                ScenarioDefinition result = apiInstance.restV1ScenarioDefinitionsScenarioIdGet(scenarioId, authorization, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScenarioDefinitionsApi.restV1ScenarioDefinitionsScenarioIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ScenarioDefinitionsApi();
$scenarioId = scenarioId_example; // String | ID of the scenario.
$authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
$acceptLanguage = acceptLanguage_example; // String | User's language preference

try {
    $result = $api_instance->restV1ScenarioDefinitionsScenarioIdGet($scenarioId, $authorization, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScenarioDefinitionsApi->restV1ScenarioDefinitionsScenarioIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScenarioDefinitionsApi;

my $api_instance = WWW::SwaggerClient::ScenarioDefinitionsApi->new();
my $scenarioId = scenarioId_example; # String | ID of the scenario.
my $authorization = authorization_example; # String | Valid access token(value = bearer {access token}).
my $acceptLanguage = acceptLanguage_example; # String | User's language preference

eval { 
    my $result = $api_instance->restV1ScenarioDefinitionsScenarioIdGet(scenarioId => $scenarioId, authorization => $authorization, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScenarioDefinitionsApi->restV1ScenarioDefinitionsScenarioIdGet: $@\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.ScenarioDefinitionsApi()
scenarioId = scenarioId_example # String | ID of the scenario.
authorization = authorization_example # String | Valid access token(value = bearer {access token}).
acceptLanguage = acceptLanguage_example # String | User's language preference (optional)

try: 
    # Retrieve scenario definition by ID
    api_response = api_instance.restV1ScenarioDefinitionsScenarioIdGet(scenarioId, authorization, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScenarioDefinitionsApi->restV1ScenarioDefinitionsScenarioIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
scenarioId*
Header parameters
Name Description
Accept-Language
Authorization*

Responses

Status: 200 - Returns scenario definition.

{scenarioId=ONBOARDING, name=Onboarding Scenario, createdBy=abc.def@sap.com, createdAt=2018-10-23T18:13:52.804+0000}

Status: 401 - Unauthorized. The access token is invalid.

Status: 403 - Access forbidden. You do not have the required permissions to access the resource.

Status: 404 - Unable to find the scenario for the given scenario ID in the system.

{error={code=bpm.pvs.scenario.not.found, message=Scenario not found with the given scenario ID, SCENARIO1234.}}

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.}]}}

/rest/v1/scenario-definitions/{scenarioId}/model

Retrieves the specified scenario definition model that is deployed. Roles required to execute this operation: - Global roles: PVAdmin


/rest/v1/scenario-definitions/{scenarioId}/model

Usage

curl -X get "https://bpmpvruntime.cfapps.sap.hana.ondemand.com/pv-service/rest/v1/scenario-definitions/{scenarioId}/model"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScenarioDefinitionsApi;

import java.io.File;
import java.util.*;

public class ScenarioDefinitionsApiExample {

    public static void main(String[] args) {
        
        ScenarioDefinitionsApi apiInstance = new ScenarioDefinitionsApi();
        String scenarioId = scenarioId_example; // String | ID of the scenario.
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            ScenarioModel result = apiInstance.restV1ScenarioDefinitionsScenarioIdModelGet(scenarioId, authorization, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioDefinitionsApi#restV1ScenarioDefinitionsScenarioIdModelGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScenarioDefinitionsApi;

public class ScenarioDefinitionsApiExample {

    public static void main(String[] args) {
        ScenarioDefinitionsApi apiInstance = new ScenarioDefinitionsApi();
        String scenarioId = scenarioId_example; // String | ID of the scenario.
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            ScenarioModel result = apiInstance.restV1ScenarioDefinitionsScenarioIdModelGet(scenarioId, authorization, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioDefinitionsApi#restV1ScenarioDefinitionsScenarioIdModelGet");
            e.printStackTrace();
        }
    }
}
String *scenarioId = scenarioId_example; // ID of the scenario.
String *authorization = authorization_example; // Valid access token(value = bearer {access token}).
String *acceptLanguage = acceptLanguage_example; // User's language preference (optional)

ScenarioDefinitionsApi *apiInstance = [[ScenarioDefinitionsApi alloc] init];

// Retrieve scenario definition model by ID
[apiInstance restV1ScenarioDefinitionsScenarioIdModelGetWith:scenarioId
    authorization:authorization
    acceptLanguage:acceptLanguage
              completionHandler: ^(ScenarioModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProcessVisibility = require('process_visibility');

var api = new ProcessVisibility.ScenarioDefinitionsApi()

var scenarioId = scenarioId_example; // {String} ID of the scenario.

var authorization = authorization_example; // {String} Valid access token(value = bearer {access token}).

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} User's language preference
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.restV1ScenarioDefinitionsScenarioIdModelGet(scenarioId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class restV1ScenarioDefinitionsScenarioIdModelGetExample
    {
        public void main()
        {
            
            var apiInstance = new ScenarioDefinitionsApi();
            var scenarioId = scenarioId_example;  // String | ID of the scenario.
            var authorization = authorization_example;  // String | Valid access token(value = bearer {access token}).
            var acceptLanguage = acceptLanguage_example;  // String | User's language preference (optional) 

            try
            {
                // Retrieve scenario definition model by ID
                ScenarioModel result = apiInstance.restV1ScenarioDefinitionsScenarioIdModelGet(scenarioId, authorization, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScenarioDefinitionsApi.restV1ScenarioDefinitionsScenarioIdModelGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ScenarioDefinitionsApi();
$scenarioId = scenarioId_example; // String | ID of the scenario.
$authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
$acceptLanguage = acceptLanguage_example; // String | User's language preference

try {
    $result = $api_instance->restV1ScenarioDefinitionsScenarioIdModelGet($scenarioId, $authorization, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScenarioDefinitionsApi->restV1ScenarioDefinitionsScenarioIdModelGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScenarioDefinitionsApi;

my $api_instance = WWW::SwaggerClient::ScenarioDefinitionsApi->new();
my $scenarioId = scenarioId_example; # String | ID of the scenario.
my $authorization = authorization_example; # String | Valid access token(value = bearer {access token}).
my $acceptLanguage = acceptLanguage_example; # String | User's language preference

eval { 
    my $result = $api_instance->restV1ScenarioDefinitionsScenarioIdModelGet(scenarioId => $scenarioId, authorization => $authorization, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScenarioDefinitionsApi->restV1ScenarioDefinitionsScenarioIdModelGet: $@\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.ScenarioDefinitionsApi()
scenarioId = scenarioId_example # String | ID of the scenario.
authorization = authorization_example # String | Valid access token(value = bearer {access token}).
acceptLanguage = acceptLanguage_example # String | User's language preference (optional)

try: 
    # Retrieve scenario definition model by ID
    api_response = api_instance.restV1ScenarioDefinitionsScenarioIdModelGet(scenarioId, authorization, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScenarioDefinitionsApi->restV1ScenarioDefinitionsScenarioIdModelGet: %s\n" % e)

Parameters

Path parameters
Name Description
scenarioId*
Header parameters
Name Description
Accept-Language
Authorization*

Responses

Status: 200 - Scenario model is successfully retrieved.

{
    "scenarioId": "D2O_DEMO",
    "scenarioName": "Design to Operate",
    "scenarioDescription": "Design to Operate",
    "processDefinitions": [
        {
            "id": "DESIGN",
            "name": "Design"
        },
        {
            "id": "MANUFACTURE",
            "name": "Manufacture"
        },
        {
            "id": "DELIVER",
            "name": "Deliver"
        }
    ],
    "events": [
        {
            "id": "ProjectCreated",
            "eventType": "Project Created",
            "processDefinitionId": "DESIGN",
            "eventName": "Project Created"
        },
        {
            "id": "ImpactEvaluationStarted",
            "eventType": "Impact Evaluation Started",
            "processDefinitionId": "DESIGN",
            "eventName": "Impact Evaluation Started"
        },
        {
            "id": "ImpactEvaluationOverdue",
            "eventType": "Impact Evaluation Overdue",
            "processDefinitionId": "DESIGN",
            "eventName": "Impact Evaluation Overdue"
        },
        {
            "id": "EvaluationRequestRejected",
            "eventType": "Evaluation Request Rejected",
            "processDefinitionId": "DESIGN",
            "eventName": "Evaluation Request Rejected"
        },
        {
            "id": "EvalueRequestApprovalOverdue",
            "eventType": "Evalue Request Approval Overdue",
            "processDefinitionId": "DESIGN",
            "eventName": "Evalue Request Approval Overdue"
        },
        {
            "id": "ReworkImpactEvaluationRequest",
            "eventType": "Rework Impact Evaluation Request",
            "processDefinitionId": "DESIGN",
            "eventName": "Rework Impact Evaluation Request"
        },
        {
            "id": "ProductionReleased",
            "eventType": "Production Released",
            "processDefinitionId": "DESIGN",
            "eventName": "Production Released"
        },
        {
            "id": "OrderCancelled",
            "eventType": "Order Cancelled",
            "processDefinitionId": "MANUFACTURE",
            "eventName": "Order Cancelled"
        },
        {
            "id": "ProductionFinished",
            "eventType": "Production Finished",
            "processDefinitionId": "MANUFACTURE",
            "eventName": "Production Finished"
        },
        {
            "id": "ShipmentFinished",
            "eventType": "Shipment Finished",
            "processDefinitionId": "DELIVER",
            "eventName": "Shipment Finished"
        }
    ],
    "scenarioLifeCycleConfiguration": {
        "endEvents": [
            "ShipmentFinished"
        ],
        "abruptEndEvents": [
            "EvaluationRequestRejected",
            "OrderCancelled"
        ]
    },
    "scenarioStatusDefinitions": [
        {
            "id": "CRITICAL",
            "name": "Critical",
            "priority": 1,
            "type": "CRITICAL",
            "subStatusDefinitions": [
                {
                    "id": "EvaluationOverdue",
                    "name": "Evaluation Overdue",
                    "priority": 1,
                    "type": "EXPRESSION_BASED",
                    "expressionDefinition": {
                        "expressionTemplate": "IS_LATEST_OCCURRED_EVENT",
                        "expression": {
                            "sourceEvent": "ImpactEvaluationOverdue"
                        }
                    }
                },
                {
                    "id": "OVERDUE",
                    "name": "Overdue",
                    "priority": 2,
                    "type": "OVERDUE"
                }
            ]
        },
        {
            "id": "AT_RISK",
            "name": "At Risk",
            "priority": 2,
            "type": "AT_RISK",
            "subStatusDefinitions": [
                {
                    "id": "ApprovalOverdue",
                    "name": "Approval Overdue",
                    "priority": 1,
                    "type": "EXPRESSION_BASED",
                    "expressionDefinition": {
                        "expressionTemplate": "IS_LATEST_OCCURRED_EVENT",
                        "expression": {
                            "sourceEvent": "EvalueRequestApprovalOverdue"
                        }
                    }
                },
                {
                    "id": "Rework",
                    "name": "Rework",
                    "priority": 2,
                    "type": "EXPRESSION_BASED",
                    "expressionDefinition": {
                        "expressionTemplate": "IS_LATEST_OCCURRED_EVENT",
                        "expression": {
                            "sourceEvent": "ReworkImpactEvaluationRequest"
                        }
                    }
                },
                {
                    "id": "THRESHOLD_VIOLATION",
                    "name": "Threshold Violation",
                    "priority": 3,
                    "type": "THRESHOLD_VIOLATION"
                }
            ]
        },
        {
            "id": "ON_TRACK",
            "name": "On Track",
            "priority": 3,
            "type": "ON_TRACK",
            "subStatusDefinitions": [
                {
                    "id": "IN_PROGRESS",
                    "name": "On Time",
                    "priority": 1,
                    "type": "IN_PROGRESS"
                }
            ]
        },
        {
            "id": "COMPLETED_WITHOUT_VIOLATIONS",
            "name": "Completed without violation",
            "priority": 5,
            "type": "COMPLETED_WITHOUT_VIOLATIONS",
            "subStatusDefinitions": [
                {
                    "id": "COMPLETED",
                    "name": "Completed on time",
                    "priority": 1,
                    "type": "COMPLETED"
                }
            ]
        },
        {
            "id": "COMPLETED_WITH_VIOLATIONS",
            "name": "Completed with violations",
            "priority": 4,
            "type": "COMPLETED_WITH_VIOLATIONS",
            "subStatusDefinitions": [
                {
                    "id": "COMPLETED_WITH_TIME_VIOLATIONS",
                    "name": "Completed with time violations",
                    "priority": 1,
                    "type": "COMPLETED_WITH_TIME_VIOLATIONS"
                }
            ]
        }
    ],
    "scenarioTargetConfiguration": {
        "targetDefinition": {
            "type": "CONSTANT",
            "target": {
                "value": 1987200
            }
        },
        "threshold": 80
    },
    "correlation": [
        {
            "sourceProcessDefinitionId": "DESIGN",
            "sourceContextPath": "CollaborationID",
            "operator": "EQ",
            "targetProcessDefinitionId": "MANUFACTURE",
            "targetContextPath": "CollaborationID"
        },
        {
            "sourceProcessDefinitionId": "MANUFACTURE",
            "sourceContextPath": "CollaborationID",
            "operator": "EQ",
            "targetProcessDefinitionId": "DELIVER",
            "targetContextPath": "CollaborationID"
        }
    ],
    "attributes": {
        "context": [
            {
                "id": "CollaborationID",
                "processDefinitionId": "DESIGN",
                "attributePath": "CollaborationID",
                "attributeName": "Collaboration ID",
                "aggregationRole": "DIMENSION",
                "aggregationType": null,
                "referencedAttributes": null,
                "dataType": "String"
            },
            {
                "id": "Product",
                "processDefinitionId": "DESIGN",
                "attributePath": "Product",
                "attributeName": "Product",
                "aggregationRole": "DIMENSION",
                "aggregationType": null,
                "referencedAttributes": null,
                "dataType": "String"
            },
            {
                "id": "SalesOrganization",
                "processDefinitionId": "DESIGN",
                "attributePath": "SalesOrganization",
                "attributeName": "Sales Organization",
                "aggregationRole": "DIMENSION",
                "aggregationType": null,
                "referencedAttributes": null,
                "dataType": "String"
            },
            {
                "id": "ProductCategory",
                "processDefinitionId": "DESIGN",
                "attributePath": "ProductCategory",
                "attributeName": "Product Category",
                "aggregationRole": "DIMENSION",
                "aggregationType": null,
                "referencedAttributes": null,
                "dataType": "String"
            },
            {
                "id": "OrderCategory",
                "processDefinitionId": "DESIGN",
                "attributePath": "OrderCategory",
                "attributeName": "Order Category",
                "aggregationRole": "DIMENSION",
                "aggregationType": null,
                "referencedAttributes": null,
                "dataType": "String"
            },
            {
                "id": "CustomerName",
                "processDefinitionId": "DESIGN",
                "attributePath": "CustomerName",
                "attributeName": "Customer Name",
                "aggregationRole": "DIMENSION",
                "aggregationType": null,
                "referencedAttributes": null,
                "dataType": "String"
            }
        ],
        "default": [
            {
                "id": "SC_Active_Phases",
                "processDefinitionId": null,
                "attributePath": "activePhases",
                "attributeName": "Active Phases",
                "aggregationRole": "DIMENSION",
                "aggregationType": null,
                "referencedAttributes": null,
                "dataType": "String"
            },
            {
                "id": "SC_State",
                "processDefinitionId": null,
                "attributePath": "state",
                "attributeName": "State",
                "aggregationRole": "DIMENSION",
                "aggregationType": null,
                "referencedAttributes": null,
                "dataType": "String"
            },
            {
                "id": "SC_Status",
                "processDefinitionId": null,
                "attributePath": "status",
                "attributeName": "Status",
                "aggregationRole": "DIMENSION",
                "aggregationType": null,
                "referencedAttributes": [
                    "SC_State",
                    "SC_Start_Time",
                    "SC_End_Time",
                    "SC_Elapsed_Time"
                ],
                "dataType": "String"
            },
            {
                "id": "SC_SubStatus",
                "processDefinitionId": null,
                "attributePath": "subStatus",
                "attributeName": "SubStatus",
                "aggregationRole": "DIMENSION",
                "aggregationType": null,
                "referencedAttributes": [
                    "SC_Status"
                ],
                "dataType": "String"
            },
            {
                "id": "SC_Number_Of_Instances",
                "processDefinitionId": null,
                "attributePath": "noOfInstances",
                "attributeName": "Number of Instances",
                "aggregationRole": "MEASURE",
                "aggregationType": "SUM",
                "referencedAttributes": null,
                "dataType": "Integer"
            },
            {
                "id": "SC_Start_Time",
                "processDefinitionId": null,
                "attributePath": "startTime",
                "attributeName": "Start Time",
                "aggregationRole": "DIMENSION",
                "aggregationType": null,
                "referencedAttributes": null,
                "dataType": "Timestamp"
            },
            {
                "id": "SC_End_Time",
                "processDefinitionId": null,
                "attributePath": "endTime",
                "attributeName": "End Time",
                "aggregationRole": "DIMENSION",
                "aggregationType": null,
                "referencedAttributes": null,
                "dataType": "Timestamp"
            },
            {
                "id": "SC_Elapsed_Time",
                "processDefinitionId": null,
                "attributePath": "elapsedTime",
                "attributeName": "Elapsed Time",
                "aggregationRole": "MEASURE",
                "aggregationType": "AVG",
                "referencedAttributes": [
                    "SC_Start_Time",
                    "SC_End_Time"
                ],
                "dataType": "Duration",
                "unitDefinition": {
                   "type": "CONSTANT",
                   "unit": {
                      "value": "Days"
                    }
                  }
            }
        ],
        "calculated": [
            {
                "id": "IsRework",
                "processDefinitionId": null,
                "attributePath": "IsRework",
                "attributeName": "Rework",
                "aggregationRole": "MEASURE",
                "aggregationType": "SUM",
                "referencedAttributes": null,
                "dataType": "Integer",
                "expressionDefinition": {
                    "expressionTemplate": "IS_EVENT_OCCURRED",
                    "expression": {
                        "sourceEvent": "ReworkImpactEvaluationRequest"
                    }
                }
            },
            {
                "id": "CRWithoutDesign",
                "processDefinitionId": null,
                "attributePath": "CRWithoutDesign",
                "attributeName": "Change Request without Design",
                "aggregationRole": "MEASURE",
                "aggregationType": "SUM",
                "referencedAttributes": null,
                "dataType": "Integer",
                "expressionDefinition": {
                    "expressionTemplate": "EVENTA_AND_NOT_EVENTB",
                    "expression": {
                        "eventA": "ProductionReleased",
                        "eventB": "ProjectCreated"
                    }
                }
            },
            {
                "id": "NoImpactEvaluation",
                "processDefinitionId": null,
                "attributePath": "NoImpactEvaluation",
                "attributeName": "No Impact Evaluation",
                "aggregationRole": "MEASURE",
                "aggregationType": "SUM",
                "referencedAttributes": null,
                "dataType": "Integer",
                "expressionDefinition": {
                    "expressionTemplate": "EVENTA_AND_NOT_EVENTB",
                    "expression": {
                        "eventA": "ProductionReleased",
                        "eventB": "ImpactEvaluationStarted"
                    }
                }
            }
        ]
    },
    "phases": [
        {
            "id": "Design",
            "name": "Design and Development",
            "order": 1,
            "lifeCycleConfiguration": {
                "startEvents": [
                    "ProjectCreated"
                ],
                "endEvents": [
                    "ProductionReleased"
                ]
            }
        },
        {
            "id": "Production",
            "name": "Production",
            "order": 2,
            "lifeCycleConfiguration": {
                "startEvents": [
                    "ProductionReleased"
                ],
                "endEvents": [
                    "ProductionFinished"
                ]
            }
        },
        {
            "id": "Delivery",
            "name": "Delivery",
            "order": 3,
            "lifeCycleConfiguration": {
                "startEvents": [
                    "ProductionFinished"
                ],
                "endEvents": [
                    "ShipmentFinished"
                ]
            }
        }
    ],
    "uiConfiguration": {
        "attributes": [
            {
                "id": "SC_State",
                "showInListView": false,
                "order": 1
            },
            {
                "id": "SC_Status",
                "showInListView": true,
                "order": 2
            },
            {
                "id": "CustomerName",
                "showInListView": true,
                "order": 3
            },
            {
                "id": "OrderCategory",
                "showInListView": true,
                "order": 4
            },
            {
                "id": "Product",
                "showInListView": true,
                "order": 5
            },
            {
                "id": "ProductCategory",
                "showInListView": true,
                "order": 5
            },
            {
                "id": "SalesOrganization",
                "showInListView": false,
                "order": 6
            }
        ],
        "ppis": [
            {
                "id": "OpenOrdersByStatus",
                "title": "Open Orders By Status",
                "measure": "SC_Number_Of_Instances",
                "dimensions": [
                    "SC_Status"
                ],
                "cardType": "LIST",
                "chartType": "BAR",
                "filter": [
                    {
                        "attribute": "SC_State",
                        "operator": "EQ",
                        "value": "OPEN"
                    }
                ]
            },
            {
                "id": "OpenOrdersByPhase",
                "title": "Open Orders By Phase",
                "measure": "SC_Number_Of_Instances",
                "dimensions": [
                    "SC_Active_Phases"
                ],
                "cardType": "LIST",
                "chartType": "BAR",
                "filter": [
                    {
                        "attribute": "SC_State",
                        "operator": "EQ",
                        "value": "OPEN"
                    }
                ]
            },
            {
                "id": "OrderswithDesignRework",
                "title": "Orders with Design Rework",
                "subTitle": "by Order Category",
                "measure": "SC_Number_Of_Instances",
                "dimensions": [
                    "OrderCategory"
                ],
                "cardType": "ANALYTICAL",
                "chartType": "COLUMN",
                "filter": [
                    {
                        "attribute": "IsRework",
                        "operator": "EQ",
                        "value": "1"
                    }
                ]
            },
            {
                "id": "CycleTime",
                "title": "Cycle Time",
                "subTitle": "by Product Category",
                "measure": "SC_Elapsed_Time",
                "dimensions": [
                    "ProductCategory"
                ],
                "cardType": "ANALYTICAL",
                "chartType": "DONUT",
                "filter": [
                    {
                        "attribute": "SC_State",
                        "operator": "EQ",
                        "value": "Completed"
                    }
                ]
            },
            {
                "id": "CycleTimewithDesignRework",
                "title": "CycleTime with Design Rework",
                "measure": "SC_Elapsed_Time",
                "cardType": "ANALYTICAL",
                "filter": [
                    {
                        "attribute": "IsRework",
                        "operator": "EQ",
                        "value": "1"
                    }
                ]
            },
            {
                "id": "CompletedOrders",
                "title": "Completed Orders",
                "subTitle": "by Status",
                "measure": "SC_Number_Of_Instances",
                "dimensions": [
                    "SC_Status"
                ],
                "cardType": "ANALYTICAL",
                "chartType": "DONUT",
                "filter": [
                    {
                        "attribute": "SC_State",
                        "operator": "NE",
                        "value": "Open"
                    }
                ]
            },
            {
                "id": "OrderswithoutDesignEvaluation",
                "title": "Orders without Design Evaluation",
                "measure": "SC_Number_Of_Instances",
                "cardType": "ANALYTICAL",
                "filter": [
                    {
                        "attribute": "NoImpactEvaluation",
                        "operator": "EQ",
                        "value": "0"
                    }
                ]
            },
            {
                "id": "CycleTimewithoutDesignEvaluation",
                "title": "CycleTime without Design Evaluation",
                "measure": "SC_Elapsed_Time",
                "cardType": "ANALYTICAL",
                "filter": [
                    {
                        "attribute": "NoImpactEvaluation",
                        "operator": "EQ",
                        "value": "0"
                    }
                ]
            },
            {
                "id": "OrdersRequiringAttention",
                "title": "Orders Requiring Attention",
                "dimensions": [
                    "SC_SubStatus",
                    "SC_Number_Of_Instances",
                    "SC_Elapsed_Time"
                ],
                "cardType": "TABLE",
                "chartType": "BAR",
                "filter": [
                    {
                        "attribute": "SC_Status",
                        "operator": "EQ",
                        "value": "Critical"
                    },
                    {
                        "attribute": "SC_Status",
                        "operator": "EQ",
                        "value": "At Risk"
                    }
                ]
            }
        ]
    }
}

Status: 401 - Unauthorized. The access token is invalid.

Status: 403 - Access forbidden. You do not have the required permissions to access the resource.

Status: 404 - Unable to find the scenario for the given scenario ID in the system.

{error={code=bpm.pvs.scenario.not.found, message=Scenario not found with the given scenario ID, SCENARIO1234.}}

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.}]}}

ScenarioInstances

/odata/v1/metadata/Scenarios

Retrieves metdata of scenarios that can be accessed by the user. Roles required to execute this operation: - Global roles: PVOperator, PVRestrictedOperator


/odata/v1/metadata/Scenarios

Usage

curl -X get "https://bpmpvruntime.cfapps.sap.hana.ondemand.com/pv-service/odata/v1/metadata/Scenarios?$select="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScenarioInstancesApi;

import java.io.File;
import java.util.*;

public class ScenarioInstancesApiExample {

    public static void main(String[] args) {
        
        ScenarioInstancesApi apiInstance = new ScenarioInstancesApi();
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        String $select = $select_example; // String | Specify the attributes you want to show for each of the scenario (for example: 'scenarioId,scenarioName'). 
        try {
            Scenarios result = apiInstance.odataV1MetadataScenariosGet(authorization, acceptLanguage, $select);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioInstancesApi#odataV1MetadataScenariosGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScenarioInstancesApi;

public class ScenarioInstancesApiExample {

    public static void main(String[] args) {
        ScenarioInstancesApi apiInstance = new ScenarioInstancesApi();
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        String $select = $select_example; // String | Specify the attributes you want to show for each of the scenario (for example: 'scenarioId,scenarioName'). 
        try {
            Scenarios result = apiInstance.odataV1MetadataScenariosGet(authorization, acceptLanguage, $select);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioInstancesApi#odataV1MetadataScenariosGet");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Valid access token(value = bearer {access token}).
String *acceptLanguage = acceptLanguage_example; // User's language preference (optional)
String *$select = $select_example; // Specify the attributes you want to show for each of the scenario (for example: 'scenarioId,scenarioName').  (optional)

ScenarioInstancesApi *apiInstance = [[ScenarioInstancesApi alloc] init];

// Retrives scenarios
[apiInstance odataV1MetadataScenariosGetWith:authorization
    acceptLanguage:acceptLanguage
    $select:$select
              completionHandler: ^(Scenarios output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProcessVisibility = require('process_visibility');

var api = new ProcessVisibility.ScenarioInstancesApi()

var authorization = authorization_example; // {String} Valid access token(value = bearer {access token}).

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} User's language preference
  '$select': $select_example // {String} Specify the attributes you want to show for each of the scenario (for example: 'scenarioId,scenarioName'). 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.odataV1MetadataScenariosGet(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class odataV1MetadataScenariosGetExample
    {
        public void main()
        {
            
            var apiInstance = new ScenarioInstancesApi();
            var authorization = authorization_example;  // String | Valid access token(value = bearer {access token}).
            var acceptLanguage = acceptLanguage_example;  // String | User's language preference (optional) 
            var $select = $select_example;  // String | Specify the attributes you want to show for each of the scenario (for example: 'scenarioId,scenarioName').  (optional) 

            try
            {
                // Retrives scenarios
                Scenarios result = apiInstance.odataV1MetadataScenariosGet(authorization, acceptLanguage, $select);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScenarioInstancesApi.odataV1MetadataScenariosGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ScenarioInstancesApi();
$authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
$acceptLanguage = acceptLanguage_example; // String | User's language preference
$$select = $select_example; // String | Specify the attributes you want to show for each of the scenario (for example: 'scenarioId,scenarioName'). 

try {
    $result = $api_instance->odataV1MetadataScenariosGet($authorization, $acceptLanguage, $$select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScenarioInstancesApi->odataV1MetadataScenariosGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScenarioInstancesApi;

my $api_instance = WWW::SwaggerClient::ScenarioInstancesApi->new();
my $authorization = authorization_example; # String | Valid access token(value = bearer {access token}).
my $acceptLanguage = acceptLanguage_example; # String | User's language preference
my $$select = $select_example; # String | Specify the attributes you want to show for each of the scenario (for example: 'scenarioId,scenarioName'). 

eval { 
    my $result = $api_instance->odataV1MetadataScenariosGet(authorization => $authorization, acceptLanguage => $acceptLanguage, $select => $$select);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScenarioInstancesApi->odataV1MetadataScenariosGet: $@\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.ScenarioInstancesApi()
authorization = authorization_example # String | Valid access token(value = bearer {access token}).
acceptLanguage = acceptLanguage_example # String | User's language preference (optional)
$select = $select_example # String | Specify the attributes you want to show for each of the scenario (for example: 'scenarioId,scenarioName').  (optional)

try: 
    # Retrives scenarios
    api_response = api_instance.odataV1MetadataScenariosGet(authorization, acceptLanguage=acceptLanguage, $select=$select)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScenarioInstancesApi->odataV1MetadataScenariosGet: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
Authorization*
Query parameters
Name Description
$select

Responses

Status: 200 - Returns all the scenarios.

"d": { "results": [ { "scenarioId": "Scenario1", "scenarioName": "Design to Operate", "scenarioDescription": "Design to Operate" }, { "scenarioId": "Scenario2", "scenarioName": "Lead to Cash", "scenarioDescription": "Lead to Cash" } }

Status: 403 - Access forbidden. You do not have the required permissions to access the resource.

Status: 500 - Internal server error. The operation you requested led to an error during execution.

{error={code=Internal Server Error, message={lang=en, value=Internal server error during execution of the request.}}}

/odata/v1/{scenarioId}/Instances

Retrieves instances of the scenario. Roles required to execute this operation: - Global roles: PVOperator, PVRestrictedOperator


/odata/v1/{scenarioId}/Instances

Usage

curl -X get "https://bpmpvruntime.cfapps.sap.hana.ondemand.com/pv-service/odata/v1/{scenarioId}/Instances?$select=&$top=&$skip=&$filter=&$orderby=&$expand=&$inlinecount=&$format=&search="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScenarioInstancesApi;

import java.io.File;
import java.util.*;

public class ScenarioInstancesApiExample {

    public static void main(String[] args) {
        
        ScenarioInstancesApi apiInstance = new ScenarioInstancesApi();
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        String $select = $select_example; // String | Specify the attributes you want to show for each of the instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
        Integer $top = 56; // Integer | Specify the number of records you want to show. Used only in conjunction with $skip.
Combine the $top with the $skip parameter to fetch records within a range.Refer also to the $skip parameter.
        Integer $skip = 56; // Integer | Specify the number of records you want to skip from the beginning. Used only in conjunction with $top.
Combine the $top with the $skip parameter to fetch records within a range.Refer also to the $top parameter.  
        String $filter = $filter_example; // String | Specify the filter attribute for intances using the following format: $filter=attribute eq 'value'. 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'CRITICAL' and CATEGORY eq 'Silver'`) or 'or' (for example: `Status eq 'CRITICAL' or Status eq 'AT_RISK'`)
        String $orderby = $orderby_example; // String | Specify the attribute you want to sort by and the order separated by a space (for example: 'attribute1 desc,attribute2 desc'). 
By default the order is ascending.
Results are sorted in the given sequence. 
        String $expand = $expand_example; // String | Specify the associated entity set you want to show for each of the instance (for example: 'Phases').
We can also access associated entity set attribute values using $select query parameter. (for example: $expand=AssociatedEntitySet&$select=AssociatedEntitySet/attributeId)
        String $inlinecount = $inlinecount_example; // String | Specify whether to return the number of results in the result body. When the value is 'allpages', the number of results is returned in the '__count' attribute of the response body.
        String $format = $format_example; // String | Specify the format of the result. 
        String search = search_example; // String | Use this parameter to search for a text in attributes of pv-aggregation-role as dimension. (for example: `search='Silver'`) 
        try {
            Instances result = apiInstance.odataV1ScenarioIdInstancesGet(authorization, acceptLanguage, $select, $top, $skip, $filter, $orderby, $expand, $inlinecount, $format, search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioInstancesApi#odataV1ScenarioIdInstancesGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScenarioInstancesApi;

public class ScenarioInstancesApiExample {

    public static void main(String[] args) {
        ScenarioInstancesApi apiInstance = new ScenarioInstancesApi();
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        String $select = $select_example; // String | Specify the attributes you want to show for each of the instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
        Integer $top = 56; // Integer | Specify the number of records you want to show. Used only in conjunction with $skip.
Combine the $top with the $skip parameter to fetch records within a range.Refer also to the $skip parameter.
        Integer $skip = 56; // Integer | Specify the number of records you want to skip from the beginning. Used only in conjunction with $top.
Combine the $top with the $skip parameter to fetch records within a range.Refer also to the $top parameter.  
        String $filter = $filter_example; // String | Specify the filter attribute for intances using the following format: $filter=attribute eq 'value'. 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'CRITICAL' and CATEGORY eq 'Silver'`) or 'or' (for example: `Status eq 'CRITICAL' or Status eq 'AT_RISK'`)
        String $orderby = $orderby_example; // String | Specify the attribute you want to sort by and the order separated by a space (for example: 'attribute1 desc,attribute2 desc'). 
By default the order is ascending.
Results are sorted in the given sequence. 
        String $expand = $expand_example; // String | Specify the associated entity set you want to show for each of the instance (for example: 'Phases').
We can also access associated entity set attribute values using $select query parameter. (for example: $expand=AssociatedEntitySet&$select=AssociatedEntitySet/attributeId)
        String $inlinecount = $inlinecount_example; // String | Specify whether to return the number of results in the result body. When the value is 'allpages', the number of results is returned in the '__count' attribute of the response body.
        String $format = $format_example; // String | Specify the format of the result. 
        String search = search_example; // String | Use this parameter to search for a text in attributes of pv-aggregation-role as dimension. (for example: `search='Silver'`) 
        try {
            Instances result = apiInstance.odataV1ScenarioIdInstancesGet(authorization, acceptLanguage, $select, $top, $skip, $filter, $orderby, $expand, $inlinecount, $format, search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioInstancesApi#odataV1ScenarioIdInstancesGet");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Valid access token(value = bearer {access token}).
String *acceptLanguage = acceptLanguage_example; // User's language preference (optional)
String *$select = $select_example; // Specify the attributes you want to show for each of the instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2. (optional)
Integer *$top = 56; // Specify the number of records you want to show. Used only in conjunction with $skip.
Combine the $top with the $skip parameter to fetch records within a range.Refer also to the $skip parameter. (optional)
Integer *$skip = 56; // Specify the number of records you want to skip from the beginning. Used only in conjunction with $top.
Combine the $top with the $skip parameter to fetch records within a range.Refer also to the $top parameter.   (optional)
String *$filter = $filter_example; // Specify the filter attribute for intances using the following format: $filter=attribute eq 'value'. 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'CRITICAL' and CATEGORY eq 'Silver'`) or 'or' (for example: `Status eq 'CRITICAL' or Status eq 'AT_RISK'`) (optional)
String *$orderby = $orderby_example; // Specify the attribute you want to sort by and the order separated by a space (for example: 'attribute1 desc,attribute2 desc'). 
By default the order is ascending.
Results are sorted in the given sequence.  (optional)
String *$expand = $expand_example; // Specify the associated entity set you want to show for each of the instance (for example: 'Phases').
We can also access associated entity set attribute values using $select query parameter. (for example: $expand=AssociatedEntitySet&$select=AssociatedEntitySet/attributeId) (optional)
String *$inlinecount = $inlinecount_example; // Specify whether to return the number of results in the result body. When the value is 'allpages', the number of results is returned in the '__count' attribute of the response body. (optional)
String *$format = $format_example; // Specify the format of the result.  (optional) (default to xml)
String *search = search_example; // Use this parameter to search for a text in attributes of pv-aggregation-role as dimension. (for example: `search='Silver'`)  (optional)

ScenarioInstancesApi *apiInstance = [[ScenarioInstancesApi alloc] init];

// Retrieves instances of the scenario.
[apiInstance odataV1ScenarioIdInstancesGetWith:authorization
    acceptLanguage:acceptLanguage
    $select:$select
    $top:$top
    $skip:$skip
    $filter:$filter
    $orderby:$orderby
    $expand:$expand
    $inlinecount:$inlinecount
    $format:$format
    search:search
              completionHandler: ^(Instances output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProcessVisibility = require('process_visibility');

var api = new ProcessVisibility.ScenarioInstancesApi()

var authorization = authorization_example; // {String} Valid access token(value = bearer {access token}).

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} User's language preference
  '$select': $select_example, // {String} Specify the attributes you want to show for each of the instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
  '$top': 56, // {Integer} Specify the number of records you want to show. Used only in conjunction with $skip.
Combine the $top with the $skip parameter to fetch records within a range.Refer also to the $skip parameter.
  '$skip': 56, // {Integer} Specify the number of records you want to skip from the beginning. Used only in conjunction with $top.
Combine the $top with the $skip parameter to fetch records within a range.Refer also to the $top parameter.  
  '$filter': $filter_example, // {String} Specify the filter attribute for intances using the following format: $filter=attribute eq 'value'. 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'CRITICAL' and CATEGORY eq 'Silver'`) or 'or' (for example: `Status eq 'CRITICAL' or Status eq 'AT_RISK'`)
  '$orderby': $orderby_example, // {String} Specify the attribute you want to sort by and the order separated by a space (for example: 'attribute1 desc,attribute2 desc'). 
By default the order is ascending.
Results are sorted in the given sequence. 
  '$expand': $expand_example, // {String} Specify the associated entity set you want to show for each of the instance (for example: 'Phases').
We can also access associated entity set attribute values using $select query parameter. (for example: $expand=AssociatedEntitySet&$select=AssociatedEntitySet/attributeId)
  '$inlinecount': $inlinecount_example, // {String} Specify whether to return the number of results in the result body. When the value is 'allpages', the number of results is returned in the '__count' attribute of the response body.
  '$format': $format_example, // {String} Specify the format of the result. 
  'search': search_example // {String} Use this parameter to search for a text in attributes of pv-aggregation-role as dimension. (for example: `search='Silver'`) 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.odataV1ScenarioIdInstancesGet(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class odataV1ScenarioIdInstancesGetExample
    {
        public void main()
        {
            
            var apiInstance = new ScenarioInstancesApi();
            var authorization = authorization_example;  // String | Valid access token(value = bearer {access token}).
            var acceptLanguage = acceptLanguage_example;  // String | User's language preference (optional) 
            var $select = $select_example;  // String | Specify the attributes you want to show for each of the instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2. (optional) 
            var $top = 56;  // Integer | Specify the number of records you want to show. Used only in conjunction with $skip.
Combine the $top with the $skip parameter to fetch records within a range.Refer also to the $skip parameter. (optional) 
            var $skip = 56;  // Integer | Specify the number of records you want to skip from the beginning. Used only in conjunction with $top.
Combine the $top with the $skip parameter to fetch records within a range.Refer also to the $top parameter.   (optional) 
            var $filter = $filter_example;  // String | Specify the filter attribute for intances using the following format: $filter=attribute eq 'value'. 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'CRITICAL' and CATEGORY eq 'Silver'`) or 'or' (for example: `Status eq 'CRITICAL' or Status eq 'AT_RISK'`) (optional) 
            var $orderby = $orderby_example;  // String | Specify the attribute you want to sort by and the order separated by a space (for example: 'attribute1 desc,attribute2 desc'). 
By default the order is ascending.
Results are sorted in the given sequence.  (optional) 
            var $expand = $expand_example;  // String | Specify the associated entity set you want to show for each of the instance (for example: 'Phases').
We can also access associated entity set attribute values using $select query parameter. (for example: $expand=AssociatedEntitySet&$select=AssociatedEntitySet/attributeId) (optional) 
            var $inlinecount = $inlinecount_example;  // String | Specify whether to return the number of results in the result body. When the value is 'allpages', the number of results is returned in the '__count' attribute of the response body. (optional) 
            var $format = $format_example;  // String | Specify the format of the result.  (optional)  (default to xml)
            var search = search_example;  // String | Use this parameter to search for a text in attributes of pv-aggregation-role as dimension. (for example: `search='Silver'`)  (optional) 

            try
            {
                // Retrieves instances of the scenario.
                Instances result = apiInstance.odataV1ScenarioIdInstancesGet(authorization, acceptLanguage, $select, $top, $skip, $filter, $orderby, $expand, $inlinecount, $format, search);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScenarioInstancesApi.odataV1ScenarioIdInstancesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ScenarioInstancesApi();
$authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
$acceptLanguage = acceptLanguage_example; // String | User's language preference
$$select = $select_example; // String | Specify the attributes you want to show for each of the instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
$$top = 56; // Integer | Specify the number of records you want to show. Used only in conjunction with $skip.
Combine the $top with the $skip parameter to fetch records within a range.Refer also to the $skip parameter.
$$skip = 56; // Integer | Specify the number of records you want to skip from the beginning. Used only in conjunction with $top.
Combine the $top with the $skip parameter to fetch records within a range.Refer also to the $top parameter.  
$$filter = $filter_example; // String | Specify the filter attribute for intances using the following format: $filter=attribute eq 'value'. 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'CRITICAL' and CATEGORY eq 'Silver'`) or 'or' (for example: `Status eq 'CRITICAL' or Status eq 'AT_RISK'`)
$$orderby = $orderby_example; // String | Specify the attribute you want to sort by and the order separated by a space (for example: 'attribute1 desc,attribute2 desc'). 
By default the order is ascending.
Results are sorted in the given sequence. 
$$expand = $expand_example; // String | Specify the associated entity set you want to show for each of the instance (for example: 'Phases').
We can also access associated entity set attribute values using $select query parameter. (for example: $expand=AssociatedEntitySet&$select=AssociatedEntitySet/attributeId)
$$inlinecount = $inlinecount_example; // String | Specify whether to return the number of results in the result body. When the value is 'allpages', the number of results is returned in the '__count' attribute of the response body.
$$format = $format_example; // String | Specify the format of the result. 
$search = search_example; // String | Use this parameter to search for a text in attributes of pv-aggregation-role as dimension. (for example: `search='Silver'`) 

try {
    $result = $api_instance->odataV1ScenarioIdInstancesGet($authorization, $acceptLanguage, $$select, $$top, $$skip, $$filter, $$orderby, $$expand, $$inlinecount, $$format, $search);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScenarioInstancesApi->odataV1ScenarioIdInstancesGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScenarioInstancesApi;

my $api_instance = WWW::SwaggerClient::ScenarioInstancesApi->new();
my $authorization = authorization_example; # String | Valid access token(value = bearer {access token}).
my $acceptLanguage = acceptLanguage_example; # String | User's language preference
my $$select = $select_example; # String | Specify the attributes you want to show for each of the instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
my $$top = 56; # Integer | Specify the number of records you want to show. Used only in conjunction with $skip.
Combine the $top with the $skip parameter to fetch records within a range.Refer also to the $skip parameter.
my $$skip = 56; # Integer | Specify the number of records you want to skip from the beginning. Used only in conjunction with $top.
Combine the $top with the $skip parameter to fetch records within a range.Refer also to the $top parameter.  
my $$filter = $filter_example; # String | Specify the filter attribute for intances using the following format: $filter=attribute eq 'value'. 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'CRITICAL' and CATEGORY eq 'Silver'`) or 'or' (for example: `Status eq 'CRITICAL' or Status eq 'AT_RISK'`)
my $$orderby = $orderby_example; # String | Specify the attribute you want to sort by and the order separated by a space (for example: 'attribute1 desc,attribute2 desc'). 
By default the order is ascending.
Results are sorted in the given sequence. 
my $$expand = $expand_example; # String | Specify the associated entity set you want to show for each of the instance (for example: 'Phases').
We can also access associated entity set attribute values using $select query parameter. (for example: $expand=AssociatedEntitySet&$select=AssociatedEntitySet/attributeId)
my $$inlinecount = $inlinecount_example; # String | Specify whether to return the number of results in the result body. When the value is 'allpages', the number of results is returned in the '__count' attribute of the response body.
my $$format = $format_example; # String | Specify the format of the result. 
my $search = search_example; # String | Use this parameter to search for a text in attributes of pv-aggregation-role as dimension. (for example: `search='Silver'`) 

eval { 
    my $result = $api_instance->odataV1ScenarioIdInstancesGet(authorization => $authorization, acceptLanguage => $acceptLanguage, $select => $$select, $top => $$top, $skip => $$skip, $filter => $$filter, $orderby => $$orderby, $expand => $$expand, $inlinecount => $$inlinecount, $format => $$format, search => $search);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScenarioInstancesApi->odataV1ScenarioIdInstancesGet: $@\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.ScenarioInstancesApi()
authorization = authorization_example # String | Valid access token(value = bearer {access token}).
acceptLanguage = acceptLanguage_example # String | User's language preference (optional)
$select = $select_example # String | Specify the attributes you want to show for each of the instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2. (optional)
$top = 56 # Integer | Specify the number of records you want to show. Used only in conjunction with $skip.
Combine the $top with the $skip parameter to fetch records within a range.Refer also to the $skip parameter. (optional)
$skip = 56 # Integer | Specify the number of records you want to skip from the beginning. Used only in conjunction with $top.
Combine the $top with the $skip parameter to fetch records within a range.Refer also to the $top parameter.   (optional)
$filter = $filter_example # String | Specify the filter attribute for intances using the following format: $filter=attribute eq 'value'. 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'CRITICAL' and CATEGORY eq 'Silver'`) or 'or' (for example: `Status eq 'CRITICAL' or Status eq 'AT_RISK'`) (optional)
$orderby = $orderby_example # String | Specify the attribute you want to sort by and the order separated by a space (for example: 'attribute1 desc,attribute2 desc'). 
By default the order is ascending.
Results are sorted in the given sequence.  (optional)
$expand = $expand_example # String | Specify the associated entity set you want to show for each of the instance (for example: 'Phases').
We can also access associated entity set attribute values using $select query parameter. (for example: $expand=AssociatedEntitySet&$select=AssociatedEntitySet/attributeId) (optional)
$inlinecount = $inlinecount_example # String | Specify whether to return the number of results in the result body. When the value is 'allpages', the number of results is returned in the '__count' attribute of the response body. (optional)
$format = $format_example # String | Specify the format of the result.  (optional) (default to xml)
search = search_example # String | Use this parameter to search for a text in attributes of pv-aggregation-role as dimension. (for example: `search='Silver'`)  (optional)

try: 
    # Retrieves instances of the scenario.
    api_response = api_instance.odataV1ScenarioIdInstancesGet(authorization, acceptLanguage=acceptLanguage, $select=$select, $top=$top, $skip=$skip, $filter=$filter, $orderby=$orderby, $expand=$expand, $inlinecount=$inlinecount, $format=$format, search=search)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScenarioInstancesApi->odataV1ScenarioIdInstancesGet: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
Authorization*
Query parameters
Name Description
$select
$top
$skip
$filter
$orderby
$expand
$inlinecount
$format
search

Responses

Status: 200 - Returns instances of the scenario

"d": { "results": [ { "scenarioInstanceId": “Instance1”, "Attribute1": “Value1”, "Attribute2”: “Value2”, "Attribute3”: “Value3” }, { "scenarioInstanceId": “Instance2”, "Attribute1": “Value4”, "Attribute2”: “Value5”, "Attribute3”: “Value6” } }

Status: 400 - The syntax of the sent request is invalid.

{error={code=null, message={lang=en, value=Invalid filter expression: 'not endswith(Description,'milk')'}}}

Status: 403 - Access forbidden. You do not have the required permissions to access the resource.

Status: 404 - Scenario not found in the system with the given scenario ID.

{error={code=The requested scenario is not found with scenario ID :  SCENARIO1234, message={lang=en, value=Requested entity could not be found.}}}

Status: 500 - Internal server error. The operation you requested led to an error during execution.

{error={code=Internal Server Error, message={lang=en, value=Internal server error during execution of the request.}}}

/odata/v1/{scenarioId}/Instances('{scenarioInstanceId}')/Paths

Retrieves the path (path segments) details of a scenario instance. Roles required to execute this operation: - Global roles: PVOperator, PVRestrictedOperator


/odata/v1/{scenarioId}/Instances('{scenarioInstanceId}')/Paths

Usage

curl -X get "https://bpmpvruntime.cfapps.sap.hana.ondemand.com/pv-service/odata/v1/{scenarioId}/Instances('{scenarioInstanceId}')/Paths?$select="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScenarioInstancesApi;

import java.io.File;
import java.util.*;

public class ScenarioInstancesApiExample {

    public static void main(String[] args) {
        
        ScenarioInstancesApi apiInstance = new ScenarioInstancesApi();
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        String $select = $select_example; // String | Specify the attributes you want to show as part of path details of a scenario instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
 
        try {
            Paths result = apiInstance.odataV1ScenarioIdInstancesScenarioInstanceIdPathsGet(authorization, acceptLanguage, $select);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioInstancesApi#odataV1ScenarioIdInstancesScenarioInstanceIdPathsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScenarioInstancesApi;

public class ScenarioInstancesApiExample {

    public static void main(String[] args) {
        ScenarioInstancesApi apiInstance = new ScenarioInstancesApi();
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        String $select = $select_example; // String | Specify the attributes you want to show as part of path details of a scenario instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
 
        try {
            Paths result = apiInstance.odataV1ScenarioIdInstancesScenarioInstanceIdPathsGet(authorization, acceptLanguage, $select);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioInstancesApi#odataV1ScenarioIdInstancesScenarioInstanceIdPathsGet");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Valid access token(value = bearer {access token}).
String *acceptLanguage = acceptLanguage_example; // User's language preference (optional)
String *$select = $select_example; // Specify the attributes you want to show as part of path details of a scenario instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
  (optional)

ScenarioInstancesApi *apiInstance = [[ScenarioInstancesApi alloc] init];

// Retrieves the path details of a scenario instance.
[apiInstance odataV1ScenarioIdInstancesScenarioInstanceIdPathsGetWith:authorization
    acceptLanguage:acceptLanguage
    $select:$select
              completionHandler: ^(Paths output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProcessVisibility = require('process_visibility');

var api = new ProcessVisibility.ScenarioInstancesApi()

var authorization = authorization_example; // {String} Valid access token(value = bearer {access token}).

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} User's language preference
  '$select': $select_example // {String} Specify the attributes you want to show as part of path details of a scenario instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.odataV1ScenarioIdInstancesScenarioInstanceIdPathsGet(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class odataV1ScenarioIdInstancesScenarioInstanceIdPathsGetExample
    {
        public void main()
        {
            
            var apiInstance = new ScenarioInstancesApi();
            var authorization = authorization_example;  // String | Valid access token(value = bearer {access token}).
            var acceptLanguage = acceptLanguage_example;  // String | User's language preference (optional) 
            var $select = $select_example;  // String | Specify the attributes you want to show as part of path details of a scenario instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
  (optional) 

            try
            {
                // Retrieves the path details of a scenario instance.
                Paths result = apiInstance.odataV1ScenarioIdInstancesScenarioInstanceIdPathsGet(authorization, acceptLanguage, $select);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScenarioInstancesApi.odataV1ScenarioIdInstancesScenarioInstanceIdPathsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ScenarioInstancesApi();
$authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
$acceptLanguage = acceptLanguage_example; // String | User's language preference
$$select = $select_example; // String | Specify the attributes you want to show as part of path details of a scenario instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
 

try {
    $result = $api_instance->odataV1ScenarioIdInstancesScenarioInstanceIdPathsGet($authorization, $acceptLanguage, $$select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScenarioInstancesApi->odataV1ScenarioIdInstancesScenarioInstanceIdPathsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScenarioInstancesApi;

my $api_instance = WWW::SwaggerClient::ScenarioInstancesApi->new();
my $authorization = authorization_example; # String | Valid access token(value = bearer {access token}).
my $acceptLanguage = acceptLanguage_example; # String | User's language preference
my $$select = $select_example; # String | Specify the attributes you want to show as part of path details of a scenario instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
 

eval { 
    my $result = $api_instance->odataV1ScenarioIdInstancesScenarioInstanceIdPathsGet(authorization => $authorization, acceptLanguage => $acceptLanguage, $select => $$select);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScenarioInstancesApi->odataV1ScenarioIdInstancesScenarioInstanceIdPathsGet: $@\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.ScenarioInstancesApi()
authorization = authorization_example # String | Valid access token(value = bearer {access token}).
acceptLanguage = acceptLanguage_example # String | User's language preference (optional)
$select = $select_example # String | Specify the attributes you want to show as part of path details of a scenario instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
  (optional)

try: 
    # Retrieves the path details of a scenario instance.
    api_response = api_instance.odataV1ScenarioIdInstancesScenarioInstanceIdPathsGet(authorization, acceptLanguage=acceptLanguage, $select=$select)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScenarioInstancesApi->odataV1ScenarioIdInstancesScenarioInstanceIdPathsGet: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
Authorization*
Query parameters
Name Description
$select

Responses

Status: 200 - Retrieves the path details of a scenario instance.

"d": { "results": [{ "segmentId": “Value1”, "sourceId": “Value2”, "sourceName”: “Value4”, "targetId”: “Value3”, "targetName”: “Value5”, "relativeIndex”: “Value6”,"cycletime”: “Value7”,"sourceTimestamp”: “Value8”, "targetTimestamp”: “Value9”,"occurrence”: “Value10” }, { "segmentId": “Value1”, "sourceId": “Value2”, "sourceName”: “Value4”, "targetId”: “Value3”, "targetName”: “Value5”, "relativeIndex”: “Value6”,"cycletime”: “Value7”,"sourceTimestamp”: “Value8”, "targetTimestamp”: “Value9”,"occurrence”: “Value10” }]} }

Status: 403 - Access forbidden. You do not have the required permissions to access the resource.

Status: 404 - Unable to find the scenario instance in the system.

{error={code=The requested scenario instance is not found, message={lang=en, value=Requested entity could not be found.}}}

Status: 500 - Internal server error. The operation you requested led to an error during execution.

{error={code=Internal Server Error, message={lang=en, value=Internal server error during execution of the request.}}}

/odata/v1/{scenarioId}/Instances('{scenarioInstanceId}')/Phases

Retrieves the phase details of a scenario instance. Roles required to execute this operation: - Global roles: PVOperator, PVRestrictedOperator


/odata/v1/{scenarioId}/Instances('{scenarioInstanceId}')/Phases

Usage

curl -X get "https://bpmpvruntime.cfapps.sap.hana.ondemand.com/pv-service/odata/v1/{scenarioId}/Instances('{scenarioInstanceId}')/Phases"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScenarioInstancesApi;

import java.io.File;
import java.util.*;

public class ScenarioInstancesApiExample {

    public static void main(String[] args) {
        
        ScenarioInstancesApi apiInstance = new ScenarioInstancesApi();
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            Phases result = apiInstance.odataV1ScenarioIdInstancesScenarioInstanceIdPhasesGet(authorization, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioInstancesApi#odataV1ScenarioIdInstancesScenarioInstanceIdPhasesGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScenarioInstancesApi;

public class ScenarioInstancesApiExample {

    public static void main(String[] args) {
        ScenarioInstancesApi apiInstance = new ScenarioInstancesApi();
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        try {
            Phases result = apiInstance.odataV1ScenarioIdInstancesScenarioInstanceIdPhasesGet(authorization, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioInstancesApi#odataV1ScenarioIdInstancesScenarioInstanceIdPhasesGet");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Valid access token(value = bearer {access token}).
String *acceptLanguage = acceptLanguage_example; // User's language preference (optional)

ScenarioInstancesApi *apiInstance = [[ScenarioInstancesApi alloc] init];

// Retrieves the phase details of a scenario instance.
[apiInstance odataV1ScenarioIdInstancesScenarioInstanceIdPhasesGetWith:authorization
    acceptLanguage:acceptLanguage
              completionHandler: ^(Phases output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProcessVisibility = require('process_visibility');

var api = new ProcessVisibility.ScenarioInstancesApi()

var authorization = authorization_example; // {String} Valid access token(value = bearer {access token}).

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} User's language preference
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.odataV1ScenarioIdInstancesScenarioInstanceIdPhasesGet(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class odataV1ScenarioIdInstancesScenarioInstanceIdPhasesGetExample
    {
        public void main()
        {
            
            var apiInstance = new ScenarioInstancesApi();
            var authorization = authorization_example;  // String | Valid access token(value = bearer {access token}).
            var acceptLanguage = acceptLanguage_example;  // String | User's language preference (optional) 

            try
            {
                // Retrieves the phase details of a scenario instance.
                Phases result = apiInstance.odataV1ScenarioIdInstancesScenarioInstanceIdPhasesGet(authorization, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScenarioInstancesApi.odataV1ScenarioIdInstancesScenarioInstanceIdPhasesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ScenarioInstancesApi();
$authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
$acceptLanguage = acceptLanguage_example; // String | User's language preference

try {
    $result = $api_instance->odataV1ScenarioIdInstancesScenarioInstanceIdPhasesGet($authorization, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScenarioInstancesApi->odataV1ScenarioIdInstancesScenarioInstanceIdPhasesGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScenarioInstancesApi;

my $api_instance = WWW::SwaggerClient::ScenarioInstancesApi->new();
my $authorization = authorization_example; # String | Valid access token(value = bearer {access token}).
my $acceptLanguage = acceptLanguage_example; # String | User's language preference

eval { 
    my $result = $api_instance->odataV1ScenarioIdInstancesScenarioInstanceIdPhasesGet(authorization => $authorization, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScenarioInstancesApi->odataV1ScenarioIdInstancesScenarioInstanceIdPhasesGet: $@\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.ScenarioInstancesApi()
authorization = authorization_example # String | Valid access token(value = bearer {access token}).
acceptLanguage = acceptLanguage_example # String | User's language preference (optional)

try: 
    # Retrieves the phase details of a scenario instance.
    api_response = api_instance.odataV1ScenarioIdInstancesScenarioInstanceIdPhasesGet(authorization, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScenarioInstancesApi->odataV1ScenarioIdInstancesScenarioInstanceIdPhasesGet: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
Authorization*

Responses

Status: 200 - Retrieves the phase details of a scenario instance.

"d": { "results": [{ "phaseId": “Value1”, "status": “Value2”, "startTime”: “Value3”, "endTime”: “Value4”, "elapsedTime”: “Value5” }, { "phaseId": “Value1”, "status": “Value2”, "startTime”: “Value3”, "endTime”: “Value4”, "elapsedTime”: “Value5” } ]} }

Status: 403 - Access forbidden. You do not have the required permissions to access the resource.

Status: 404 - Unable to find the scenario instance in the system.

{error={code=The requested scenario instance is not found, message={lang=en, value=Requested entity could not be found.}}}

Status: 500 - Internal server error. The operation you requested led to an error during execution.

{error={code=Internal Server Error, message={lang=en, value=Internal server error during execution of the request.}}}

/odata/v1/{scenarioId}/Instances('{scenarioInstanceId}')/Steps

Retrieves the step details of a scenario instance. Roles required to execute this operation: - Global roles: PVOperator, PVRestrictedOperator


/odata/v1/{scenarioId}/Instances('{scenarioInstanceId}')/Steps

Usage

curl -X get "https://bpmpvruntime.cfapps.sap.hana.ondemand.com/pv-service/odata/v1/{scenarioId}/Instances('{scenarioInstanceId}')/Steps?$select="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScenarioInstancesApi;

import java.io.File;
import java.util.*;

public class ScenarioInstancesApiExample {

    public static void main(String[] args) {
        
        ScenarioInstancesApi apiInstance = new ScenarioInstancesApi();
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        String $select = $select_example; // String | Specify the attributes you want to show as part of step details of a scenario instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
   
        try {
            Steps result = apiInstance.odataV1ScenarioIdInstancesScenarioInstanceIdStepsGet(authorization, acceptLanguage, $select);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioInstancesApi#odataV1ScenarioIdInstancesScenarioInstanceIdStepsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScenarioInstancesApi;

public class ScenarioInstancesApiExample {

    public static void main(String[] args) {
        ScenarioInstancesApi apiInstance = new ScenarioInstancesApi();
        String authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
        String acceptLanguage = acceptLanguage_example; // String | User's language preference
        String $select = $select_example; // String | Specify the attributes you want to show as part of step details of a scenario instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
   
        try {
            Steps result = apiInstance.odataV1ScenarioIdInstancesScenarioInstanceIdStepsGet(authorization, acceptLanguage, $select);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScenarioInstancesApi#odataV1ScenarioIdInstancesScenarioInstanceIdStepsGet");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Valid access token(value = bearer {access token}).
String *acceptLanguage = acceptLanguage_example; // User's language preference (optional)
String *$select = $select_example; // Specify the attributes you want to show as part of step details of a scenario instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
    (optional)

ScenarioInstancesApi *apiInstance = [[ScenarioInstancesApi alloc] init];

// Retrieves the step details of a scenario instance.
[apiInstance odataV1ScenarioIdInstancesScenarioInstanceIdStepsGetWith:authorization
    acceptLanguage:acceptLanguage
    $select:$select
              completionHandler: ^(Steps output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProcessVisibility = require('process_visibility');

var api = new ProcessVisibility.ScenarioInstancesApi()

var authorization = authorization_example; // {String} Valid access token(value = bearer {access token}).

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} User's language preference
  '$select': $select_example // {String} Specify the attributes you want to show as part of step details of a scenario instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
   
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.odataV1ScenarioIdInstancesScenarioInstanceIdStepsGet(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class odataV1ScenarioIdInstancesScenarioInstanceIdStepsGetExample
    {
        public void main()
        {
            
            var apiInstance = new ScenarioInstancesApi();
            var authorization = authorization_example;  // String | Valid access token(value = bearer {access token}).
            var acceptLanguage = acceptLanguage_example;  // String | User's language preference (optional) 
            var $select = $select_example;  // String | Specify the attributes you want to show as part of step details of a scenario instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
    (optional) 

            try
            {
                // Retrieves the step details of a scenario instance.
                Steps result = apiInstance.odataV1ScenarioIdInstancesScenarioInstanceIdStepsGet(authorization, acceptLanguage, $select);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScenarioInstancesApi.odataV1ScenarioIdInstancesScenarioInstanceIdStepsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ScenarioInstancesApi();
$authorization = authorization_example; // String | Valid access token(value = bearer {access token}).
$acceptLanguage = acceptLanguage_example; // String | User's language preference
$$select = $select_example; // String | Specify the attributes you want to show as part of step details of a scenario instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
   

try {
    $result = $api_instance->odataV1ScenarioIdInstancesScenarioInstanceIdStepsGet($authorization, $acceptLanguage, $$select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScenarioInstancesApi->odataV1ScenarioIdInstancesScenarioInstanceIdStepsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScenarioInstancesApi;

my $api_instance = WWW::SwaggerClient::ScenarioInstancesApi->new();
my $authorization = authorization_example; # String | Valid access token(value = bearer {access token}).
my $acceptLanguage = acceptLanguage_example; # String | User's language preference
my $$select = $select_example; # String | Specify the attributes you want to show as part of step details of a scenario instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
   

eval { 
    my $result = $api_instance->odataV1ScenarioIdInstancesScenarioInstanceIdStepsGet(authorization => $authorization, acceptLanguage => $acceptLanguage, $select => $$select);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScenarioInstancesApi->odataV1ScenarioIdInstancesScenarioInstanceIdStepsGet: $@\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.ScenarioInstancesApi()
authorization = authorization_example # String | Valid access token(value = bearer {access token}).
acceptLanguage = acceptLanguage_example # String | User's language preference (optional)
$select = $select_example # String | Specify the attributes you want to show as part of step details of a scenario instance (for example: 'attribute1,attribute2').
Attributes of pv-aggregation-role as measure are automatically aggregated. In the specified example, if attribute1 is a measure and attribute2 is a dimension, then the query performs an aggregation of attribute1 and grouping by attribute2.
    (optional)

try: 
    # Retrieves the step details of a scenario instance.
    api_response = api_instance.odataV1ScenarioIdInstancesScenarioInstanceIdStepsGet(authorization, acceptLanguage=acceptLanguage, $select=$select)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScenarioInstancesApi->odataV1ScenarioIdInstancesScenarioInstanceIdStepsGet: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language
Authorization*
Query parameters
Name Description
$select

Responses

Status: 200 - Retrieves the step details of a scenario instance.

"d": { "results": [{ "stepInstanceId": “Value1”, "SC_Step_Id": “Value2”, "SC_Step_Name”: “Value3”, "processDefinitionId”: “Value4”, "scenarioInstanceId": “Value5”, "SC_Step_Type": “Value6”, "SC_Step_Status”: “Value7”, "SC_Step_Start_Time”: “Value8”, "SC_Step_End_Time”: “Value9” , "SC_Step”: “Value10” , "SC_Step_Key”: “Value11” , "SC_Step_Cycle_Time”: “Value12”}, { "stepInstanceId": “Value1”, "SC_Step_Id": “Value2”, "SC_Step_Name”: “Value3”, "processDefinitionId”: “Value4”, "scenarioInstanceId": “Value5”, "SC_Step_Type": “Value6”, "SC_Step_Status”: “Value7”, "SC_Step_Start_Time”: “Value8”, "SC_Step_End_Time”: “Value9” , "SC_Step”: “Value10” , "SC_Step_Key”: “Value11” , "SC_Step_Cycle_Time”: “Value12”} ]} }

Status: 403 - Access forbidden. You do not have the required permissions to access the resource.

Status: 404 - Unable to find the scenario instance in the system.

{error={code=The requested scenario instance is not found, message={lang=en, value=Requested entity could not be found.}}}

Status: 500 - Internal server error. The operation you requested led to an error during execution.

{error={code=Internal Server Error, message={lang=en, value=Internal server error during execution of the request.}}}

Generated 2020-06-23T15:35:19.568+05:30