Inbox API for Neo

Operations

/Claim?SAP__Origin=%27{SAP__Origin}%27&InstanceID=%27{InstanceID}%27

Claims the given task to the current user. Afterwards, the task is in status "RESERVED" and can be handled only by the processor.


/Claim?SAP__Origin=%27{SAP__Origin}%27&InstanceID=%27{InstanceID}%27

Usage

curl -X POST -H "Accept: application/json,application/xml" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://sandbox.api.sap.com/workflow-service/odata/v1/tcm/Claim?SAP__Origin=%27{SAP__Origin}%27&InstanceID=%27{InstanceID}%27"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OperationsApi;

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

public class OperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuthentication
        HttpBasicAuth BasicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuthentication");
        BasicAuthentication.setUsername("YOUR USERNAME");
        BasicAuthentication.setPassword("YOUR PASSWORD");

        // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
        OAuth Oauth2_AuthorizationCode = (OAuth) defaultClient.getAuthentication("Oauth2_AuthorizationCode");
        Oauth2_AuthorizationCode.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
        OAuth Oauth2_ClientCredentials = (OAuth) defaultClient.getAuthentication("Oauth2_ClientCredentials");
        Oauth2_ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        OperationsApi apiInstance = new OperationsApi();
        String sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
        String instanceID = instanceID_example; // String | The ID of the task to be claimed.
        String xCSRFToken = xCSRFToken_example; // String | The XSRF token that is valid for the current session.
        try {
            apiInstance.claimSAPOriginSAPOriginInstanceIDInstanceIDPost(sAPOrigin, instanceID, xCSRFToken);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperationsApi#claimSAPOriginSAPOriginInstanceIDInstanceIDPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OperationsApi;

public class OperationsApiExample {

    public static void main(String[] args) {
        OperationsApi apiInstance = new OperationsApi();
        String sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
        String instanceID = instanceID_example; // String | The ID of the task to be claimed.
        String xCSRFToken = xCSRFToken_example; // String | The XSRF token that is valid for the current session.
        try {
            apiInstance.claimSAPOriginSAPOriginInstanceIDInstanceIDPost(sAPOrigin, instanceID, xCSRFToken);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperationsApi#claimSAPOriginSAPOriginInstanceIDInstanceIDPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_AuthorizationCode)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_ClientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *sAPOrigin = sAPOrigin_example; // The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
String *instanceID = instanceID_example; // The ID of the task to be claimed.
String *xCSRFToken = xCSRFToken_example; // The XSRF token that is valid for the current session.

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

// Claims the given task to the current user
[apiInstance claimSAPOriginSAPOriginInstanceIDInstanceIDPostWith:sAPOrigin
    instanceID:instanceID
    xCSRFToken:xCSRFToken
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InboxApiForNeo = require('inbox_api_for_neo');
var defaultClient = InboxApiForNeo.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuthentication
var BasicAuthentication = defaultClient.authentications['BasicAuthentication'];
BasicAuthentication.username = 'YOUR USERNAME'
BasicAuthentication.password = 'YOUR PASSWORD'

// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
var Oauth2_AuthorizationCode = defaultClient.authentications['Oauth2_AuthorizationCode'];
Oauth2_AuthorizationCode.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
var Oauth2_ClientCredentials = defaultClient.authentications['Oauth2_ClientCredentials'];
Oauth2_ClientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new InboxApiForNeo.OperationsApi()

var sAPOrigin = sAPOrigin_example; // {String} The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).

var instanceID = instanceID_example; // {String} The ID of the task to be claimed.

var xCSRFToken = xCSRFToken_example; // {String} The XSRF token that is valid for the current session.


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

namespace Example
{
    public class claimSAPOriginSAPOriginInstanceIDInstanceIDPostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuthentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OperationsApi();
            var sAPOrigin = sAPOrigin_example;  // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
            var instanceID = instanceID_example;  // String | The ID of the task to be claimed.
            var xCSRFToken = xCSRFToken_example;  // String | The XSRF token that is valid for the current session.

            try
            {
                // Claims the given task to the current user
                apiInstance.claimSAPOriginSAPOriginInstanceIDInstanceIDPost(sAPOrigin, instanceID, xCSRFToken);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OperationsApi.claimSAPOriginSAPOriginInstanceIDInstanceIDPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OperationsApi();
$sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
$instanceID = instanceID_example; // String | The ID of the task to be claimed.
$xCSRFToken = xCSRFToken_example; // String | The XSRF token that is valid for the current session.

try {
    $api_instance->claimSAPOriginSAPOriginInstanceIDInstanceIDPost($sAPOrigin, $instanceID, $xCSRFToken);
} catch (Exception $e) {
    echo 'Exception when calling OperationsApi->claimSAPOriginSAPOriginInstanceIDInstanceIDPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OperationsApi;

# Configure HTTP basic authorization: BasicAuthentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OperationsApi->new();
my $sAPOrigin = sAPOrigin_example; # String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
my $instanceID = instanceID_example; # String | The ID of the task to be claimed.
my $xCSRFToken = xCSRFToken_example; # String | The XSRF token that is valid for the current session.

eval { 
    $api_instance->claimSAPOriginSAPOriginInstanceIDInstanceIDPost(sAPOrigin => $sAPOrigin, instanceID => $instanceID, xCSRFToken => $xCSRFToken);
};
if ($@) {
    warn "Exception when calling OperationsApi->claimSAPOriginSAPOriginInstanceIDInstanceIDPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OperationsApi()
sAPOrigin = sAPOrigin_example # String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
instanceID = instanceID_example # String | The ID of the task to be claimed.
xCSRFToken = xCSRFToken_example # String | The XSRF token that is valid for the current session.

try: 
    # Claims the given task to the current user
    api_instance.claimSAPOriginSAPOriginInstanceIDInstanceIDPost(sAPOrigin, instanceID, xCSRFToken)
except ApiException as e:
    print("Exception when calling OperationsApi->claimSAPOriginSAPOriginInstanceIDInstanceIDPost: %s\n" % e)

Parameters

Path parameters
Name Description
SAP__Origin*
InstanceID*
Header parameters
Name Description
X-CSRF-Token*

Responses

Status: 202 - Task has been claimed.

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

{error={code=TASK_BAD_REQUEST, message={lang=en, value=An error occured: 400 Bad Request}}}

Status: 401 - Unauthorized. Please provide valid authentication credentials to access the resource.

{error=unauthorized, error_description=Full authentication is required to access this resource.}

Status: 403 - The user who sent the request is not authorized to access the requested data or to perform the requested action.

{error={code=TASK_USER_NOT_AUTHORIZED, message={lang=en, value=An error occured: 403 Forbidden}}}

Status: 404 - The requested object could not be found.

{error={code=TASK_NOT_FOUND, message={lang=en, value=An error occured: 404 Not Found}}}

Status: 405 - The action to be executed is not supported by the OData service.

{error={message={lang=en, value=An error occured: 405 Method Not Allowed}}}

Status: 406 - The requested object cannot be returned in the specified format according to the accept headers.

{error={message={lang=en, value=An error occured: 406 Not Acceptable}}}

Status: 500 - An error occurred while processing the request.

{error={code=TASK_INVALID_STATE_TRANSITION, message={lang=en, value=An error occured: 500 Internal Server Error}}}

/Forward?SAP__Origin=%27{SAP__Origin}%27&InstanceID=%27{InstanceID}%27&ForwardTo=%27{ForwardTo}%27

Forwards the given task to the specified user. Afterwards, the task is in status "RESERVED" and only the new processor can work on it. In addition, this user becomes one of the task recipients, that means, the task remains accessible even after it was released. Note that the passed user ID is not validated. If the given user is not present, an administrator is required to reassign the task. Forwarding is a configuration option for user tasks. You can deactivate forwarding.


/Forward?SAP__Origin=%27{SAP__Origin}%27&InstanceID=%27{InstanceID}%27&ForwardTo=%27{ForwardTo}%27

Usage

curl -X POST -H "Accept: application/json,application/xml" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://sandbox.api.sap.com/workflow-service/odata/v1/tcm/Forward?SAP__Origin=%27{SAP__Origin}%27&InstanceID=%27{InstanceID}%27&ForwardTo=%27{ForwardTo}%27"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OperationsApi;

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

public class OperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuthentication
        HttpBasicAuth BasicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuthentication");
        BasicAuthentication.setUsername("YOUR USERNAME");
        BasicAuthentication.setPassword("YOUR PASSWORD");

        // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
        OAuth Oauth2_AuthorizationCode = (OAuth) defaultClient.getAuthentication("Oauth2_AuthorizationCode");
        Oauth2_AuthorizationCode.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
        OAuth Oauth2_ClientCredentials = (OAuth) defaultClient.getAuthentication("Oauth2_ClientCredentials");
        Oauth2_ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        OperationsApi apiInstance = new OperationsApi();
        String sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
        String instanceID = instanceID_example; // String | The ID of the task to be forwarded.
        String forwardTo = forwardTo_example; // String | The ID of the user to be forwarded to.
        String xCSRFToken = xCSRFToken_example; // String | The XSRF token that is valid for the current session.
        try {
            apiInstance.forwardSAPOriginSAPOriginInstanceIDInstanceIDForwardToForwardToPost(sAPOrigin, instanceID, forwardTo, xCSRFToken);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperationsApi#forwardSAPOriginSAPOriginInstanceIDInstanceIDForwardToForwardToPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OperationsApi;

public class OperationsApiExample {

    public static void main(String[] args) {
        OperationsApi apiInstance = new OperationsApi();
        String sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
        String instanceID = instanceID_example; // String | The ID of the task to be forwarded.
        String forwardTo = forwardTo_example; // String | The ID of the user to be forwarded to.
        String xCSRFToken = xCSRFToken_example; // String | The XSRF token that is valid for the current session.
        try {
            apiInstance.forwardSAPOriginSAPOriginInstanceIDInstanceIDForwardToForwardToPost(sAPOrigin, instanceID, forwardTo, xCSRFToken);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperationsApi#forwardSAPOriginSAPOriginInstanceIDInstanceIDForwardToForwardToPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_AuthorizationCode)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_ClientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *sAPOrigin = sAPOrigin_example; // The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
String *instanceID = instanceID_example; // The ID of the task to be forwarded.
String *forwardTo = forwardTo_example; // The ID of the user to be forwarded to.
String *xCSRFToken = xCSRFToken_example; // The XSRF token that is valid for the current session.

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

// Forwards the given task to the specified user
[apiInstance forwardSAPOriginSAPOriginInstanceIDInstanceIDForwardToForwardToPostWith:sAPOrigin
    instanceID:instanceID
    forwardTo:forwardTo
    xCSRFToken:xCSRFToken
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InboxApiForNeo = require('inbox_api_for_neo');
var defaultClient = InboxApiForNeo.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuthentication
var BasicAuthentication = defaultClient.authentications['BasicAuthentication'];
BasicAuthentication.username = 'YOUR USERNAME'
BasicAuthentication.password = 'YOUR PASSWORD'

// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
var Oauth2_AuthorizationCode = defaultClient.authentications['Oauth2_AuthorizationCode'];
Oauth2_AuthorizationCode.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
var Oauth2_ClientCredentials = defaultClient.authentications['Oauth2_ClientCredentials'];
Oauth2_ClientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new InboxApiForNeo.OperationsApi()

var sAPOrigin = sAPOrigin_example; // {String} The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).

var instanceID = instanceID_example; // {String} The ID of the task to be forwarded.

var forwardTo = forwardTo_example; // {String} The ID of the user to be forwarded to.

var xCSRFToken = xCSRFToken_example; // {String} The XSRF token that is valid for the current session.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.forwardSAPOriginSAPOriginInstanceIDInstanceIDForwardToForwardToPost(sAPOrigin, instanceID, forwardTo, xCSRFToken, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class forwardSAPOriginSAPOriginInstanceIDInstanceIDForwardToForwardToPostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuthentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OperationsApi();
            var sAPOrigin = sAPOrigin_example;  // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
            var instanceID = instanceID_example;  // String | The ID of the task to be forwarded.
            var forwardTo = forwardTo_example;  // String | The ID of the user to be forwarded to.
            var xCSRFToken = xCSRFToken_example;  // String | The XSRF token that is valid for the current session.

            try
            {
                // Forwards the given task to the specified user
                apiInstance.forwardSAPOriginSAPOriginInstanceIDInstanceIDForwardToForwardToPost(sAPOrigin, instanceID, forwardTo, xCSRFToken);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OperationsApi.forwardSAPOriginSAPOriginInstanceIDInstanceIDForwardToForwardToPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OperationsApi();
$sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
$instanceID = instanceID_example; // String | The ID of the task to be forwarded.
$forwardTo = forwardTo_example; // String | The ID of the user to be forwarded to.
$xCSRFToken = xCSRFToken_example; // String | The XSRF token that is valid for the current session.

try {
    $api_instance->forwardSAPOriginSAPOriginInstanceIDInstanceIDForwardToForwardToPost($sAPOrigin, $instanceID, $forwardTo, $xCSRFToken);
} catch (Exception $e) {
    echo 'Exception when calling OperationsApi->forwardSAPOriginSAPOriginInstanceIDInstanceIDForwardToForwardToPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OperationsApi;

# Configure HTTP basic authorization: BasicAuthentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OperationsApi->new();
my $sAPOrigin = sAPOrigin_example; # String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
my $instanceID = instanceID_example; # String | The ID of the task to be forwarded.
my $forwardTo = forwardTo_example; # String | The ID of the user to be forwarded to.
my $xCSRFToken = xCSRFToken_example; # String | The XSRF token that is valid for the current session.

eval { 
    $api_instance->forwardSAPOriginSAPOriginInstanceIDInstanceIDForwardToForwardToPost(sAPOrigin => $sAPOrigin, instanceID => $instanceID, forwardTo => $forwardTo, xCSRFToken => $xCSRFToken);
};
if ($@) {
    warn "Exception when calling OperationsApi->forwardSAPOriginSAPOriginInstanceIDInstanceIDForwardToForwardToPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OperationsApi()
sAPOrigin = sAPOrigin_example # String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
instanceID = instanceID_example # String | The ID of the task to be forwarded.
forwardTo = forwardTo_example # String | The ID of the user to be forwarded to.
xCSRFToken = xCSRFToken_example # String | The XSRF token that is valid for the current session.

try: 
    # Forwards the given task to the specified user
    api_instance.forwardSAPOriginSAPOriginInstanceIDInstanceIDForwardToForwardToPost(sAPOrigin, instanceID, forwardTo, xCSRFToken)
except ApiException as e:
    print("Exception when calling OperationsApi->forwardSAPOriginSAPOriginInstanceIDInstanceIDForwardToForwardToPost: %s\n" % e)

Parameters

Path parameters
Name Description
SAP__Origin*
InstanceID*
ForwardTo*
Header parameters
Name Description
X-CSRF-Token*

Responses

Status: 202 - Task has been forwarded.

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

{error={code=TASK_BAD_REQUEST, message={lang=en, value=An error occured: 400 Bad Request}}}

Status: 401 - Unauthorized. Please provide valid authentication credentials to access the resource.

{error=unauthorized, error_description=Full authentication is required to access this resource.}

Status: 403 - The user who sent the request is not authorized to access the requested data or to perform the requested action.

{error={code=TASK_USER_NOT_AUTHORIZED, message={lang=en, value=An error occured: 403 Forbidden}}}

Status: 404 - The requested object could not be found.

{error={code=TASK_NOT_FOUND, message={lang=en, value=An error occured: 404 Not Found}}}

Status: 405 - The action to be executed is not supported by the OData service.

{error={message={lang=en, value=An error occured: 405 Method Not Allowed}}}

Status: 406 - The requested object cannot be returned in the specified format according to the accept headers.

{error={message={lang=en, value=An error occured: 406 Not Acceptable}}}

Status: 500 - An error occurred while processing the request.

{error={code=TASK_INVALID_STATE_TRANSITION, message={lang=en, value=An error occured: 500 Internal Server Error}}}

/Release?SAP__Origin=%27{SAP__Origin}%27&InstanceID=%27{InstanceID}%27

Releases a given task so it can be claimed by other users. Afterwards, the task is in status "READY" and can be claimed by any user who is assigned as a potential owner.


/Release?SAP__Origin=%27{SAP__Origin}%27&InstanceID=%27{InstanceID}%27

Usage

curl -X POST -H "Accept: application/json,application/xml" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://sandbox.api.sap.com/workflow-service/odata/v1/tcm/Release?SAP__Origin=%27{SAP__Origin}%27&InstanceID=%27{InstanceID}%27"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OperationsApi;

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

public class OperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuthentication
        HttpBasicAuth BasicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuthentication");
        BasicAuthentication.setUsername("YOUR USERNAME");
        BasicAuthentication.setPassword("YOUR PASSWORD");

        // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
        OAuth Oauth2_AuthorizationCode = (OAuth) defaultClient.getAuthentication("Oauth2_AuthorizationCode");
        Oauth2_AuthorizationCode.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
        OAuth Oauth2_ClientCredentials = (OAuth) defaultClient.getAuthentication("Oauth2_ClientCredentials");
        Oauth2_ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        OperationsApi apiInstance = new OperationsApi();
        String sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
        String instanceID = instanceID_example; // String | The ID of the task to be released.
        String xCSRFToken = xCSRFToken_example; // String | The XSRF token that is valid for the current session.
        try {
            apiInstance.releaseSAPOriginSAPOriginInstanceIDInstanceIDPost(sAPOrigin, instanceID, xCSRFToken);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperationsApi#releaseSAPOriginSAPOriginInstanceIDInstanceIDPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OperationsApi;

public class OperationsApiExample {

    public static void main(String[] args) {
        OperationsApi apiInstance = new OperationsApi();
        String sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
        String instanceID = instanceID_example; // String | The ID of the task to be released.
        String xCSRFToken = xCSRFToken_example; // String | The XSRF token that is valid for the current session.
        try {
            apiInstance.releaseSAPOriginSAPOriginInstanceIDInstanceIDPost(sAPOrigin, instanceID, xCSRFToken);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperationsApi#releaseSAPOriginSAPOriginInstanceIDInstanceIDPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_AuthorizationCode)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_ClientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *sAPOrigin = sAPOrigin_example; // The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
String *instanceID = instanceID_example; // The ID of the task to be released.
String *xCSRFToken = xCSRFToken_example; // The XSRF token that is valid for the current session.

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

// Releases the given task so it can be claimed by other users
[apiInstance releaseSAPOriginSAPOriginInstanceIDInstanceIDPostWith:sAPOrigin
    instanceID:instanceID
    xCSRFToken:xCSRFToken
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InboxApiForNeo = require('inbox_api_for_neo');
var defaultClient = InboxApiForNeo.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuthentication
var BasicAuthentication = defaultClient.authentications['BasicAuthentication'];
BasicAuthentication.username = 'YOUR USERNAME'
BasicAuthentication.password = 'YOUR PASSWORD'

// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
var Oauth2_AuthorizationCode = defaultClient.authentications['Oauth2_AuthorizationCode'];
Oauth2_AuthorizationCode.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
var Oauth2_ClientCredentials = defaultClient.authentications['Oauth2_ClientCredentials'];
Oauth2_ClientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new InboxApiForNeo.OperationsApi()

var sAPOrigin = sAPOrigin_example; // {String} The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).

var instanceID = instanceID_example; // {String} The ID of the task to be released.

var xCSRFToken = xCSRFToken_example; // {String} The XSRF token that is valid for the current session.


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

namespace Example
{
    public class releaseSAPOriginSAPOriginInstanceIDInstanceIDPostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuthentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OperationsApi();
            var sAPOrigin = sAPOrigin_example;  // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
            var instanceID = instanceID_example;  // String | The ID of the task to be released.
            var xCSRFToken = xCSRFToken_example;  // String | The XSRF token that is valid for the current session.

            try
            {
                // Releases the given task so it can be claimed by other users
                apiInstance.releaseSAPOriginSAPOriginInstanceIDInstanceIDPost(sAPOrigin, instanceID, xCSRFToken);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OperationsApi.releaseSAPOriginSAPOriginInstanceIDInstanceIDPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OperationsApi();
$sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
$instanceID = instanceID_example; // String | The ID of the task to be released.
$xCSRFToken = xCSRFToken_example; // String | The XSRF token that is valid for the current session.

try {
    $api_instance->releaseSAPOriginSAPOriginInstanceIDInstanceIDPost($sAPOrigin, $instanceID, $xCSRFToken);
} catch (Exception $e) {
    echo 'Exception when calling OperationsApi->releaseSAPOriginSAPOriginInstanceIDInstanceIDPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OperationsApi;

# Configure HTTP basic authorization: BasicAuthentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OperationsApi->new();
my $sAPOrigin = sAPOrigin_example; # String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
my $instanceID = instanceID_example; # String | The ID of the task to be released.
my $xCSRFToken = xCSRFToken_example; # String | The XSRF token that is valid for the current session.

eval { 
    $api_instance->releaseSAPOriginSAPOriginInstanceIDInstanceIDPost(sAPOrigin => $sAPOrigin, instanceID => $instanceID, xCSRFToken => $xCSRFToken);
};
if ($@) {
    warn "Exception when calling OperationsApi->releaseSAPOriginSAPOriginInstanceIDInstanceIDPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OperationsApi()
sAPOrigin = sAPOrigin_example # String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
instanceID = instanceID_example # String | The ID of the task to be released.
xCSRFToken = xCSRFToken_example # String | The XSRF token that is valid for the current session.

try: 
    # Releases the given task so it can be claimed by other users
    api_instance.releaseSAPOriginSAPOriginInstanceIDInstanceIDPost(sAPOrigin, instanceID, xCSRFToken)
except ApiException as e:
    print("Exception when calling OperationsApi->releaseSAPOriginSAPOriginInstanceIDInstanceIDPost: %s\n" % e)

Parameters

Path parameters
Name Description
SAP__Origin*
InstanceID*
Header parameters
Name Description
X-CSRF-Token*

Responses

Status: 202 - Task has been released.

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

{error={code=TASK_BAD_REQUEST, message={lang=en, value=An error occured: 400 Bad Request}}}

Status: 401 - Unauthorized. Please provide valid authentication credentials to access the resource.

{error=unauthorized, error_description=Full authentication is required to access this resource.}

Status: 403 - The user who sent the request is not authorized to access the requested data or to perform the requested action.

{error={code=TASK_USER_NOT_AUTHORIZED, message={lang=en, value=An error occured: 403 Forbidden}}}

Status: 404 - The requested object could not be found.

{error={code=TASK_NOT_FOUND, message={lang=en, value=An error occured: 404 Not Found}}}

Status: 405 - The action to be executed is not supported by the OData service.

{error={message={lang=en, value=An error occured: 405 Method Not Allowed}}}

Status: 406 - The requested object cannot be returned in the specified format according to the accept headers.

{error={message={lang=en, value=An error occured: 406 Not Acceptable}}}

Status: 500 - An error occurred while processing the request.

{error={code=TASK_INVALID_STATE_TRANSITION, message={lang=en, value=An error occured: 500 Internal Server Error}}}

TaskCollection

/TaskCollection

Retrieves a list of the tasks for the current user. The request can be parameterized.


/TaskCollection

Usage

curl -X GET -H "Accept: application/json,application/xml" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://sandbox.api.sap.com/workflow-service/odata/v1/tcm/TaskCollection?$expand=&$skip=&$top=&$filter=&$orderby=&$inlinecount=&$format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskCollectionApi;

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

public class TaskCollectionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuthentication
        HttpBasicAuth BasicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuthentication");
        BasicAuthentication.setUsername("YOUR USERNAME");
        BasicAuthentication.setPassword("YOUR PASSWORD");

        // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
        OAuth Oauth2_AuthorizationCode = (OAuth) defaultClient.getAuthentication("Oauth2_AuthorizationCode");
        Oauth2_AuthorizationCode.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
        OAuth Oauth2_ClientCredentials = (OAuth) defaultClient.getAuthentication("Oauth2_ClientCredentials");
        Oauth2_ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        TaskCollectionApi apiInstance = new TaskCollectionApi();
        String acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
        String $expand = $expand_example; // String | Expand attributes of the task. The enumeration of allowed values is subject to change. Separate multiple values by a comma. 
        Integer $skip = 56; // Integer | Specify the number of records you want to skip from the beginning.
You can skip at most 4000 records. To indicate a result range that starts, for example, at 1001, combine the $skip with the $top parameter.
If not specified, no records are skipped.
Refer also to the $top parameter.
        Integer $top = 56; // Integer | Specify the number of records you want to show.
You can see at most 1000 records per API call. To indicate a result range that starts, for example, at 1001, combine the $top with the $skip parameter.
If not specified, 100 records are returned.
Refer also to the $skip parameter.
        String $filter = $filter_example; // String | Specify the filter attribute for tasks using the following format: `$filter=attribute eq 'value'`. More complex filter predicates are only supported as described in the following.

Filtering on 'CreatedOn' and 'CompletionDeadline' supports the greater-equal ('ge') and lower-equal ('le') operator. All other attributes only support filtering on equality ('eq'). 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'READY' and Priority eq 'HIGH'`).

Filtering the TaskDefinitionID, Status, Priority, and PriorityNumber attributes supports multiple values that are combined with 'or' (for example: `Status eq 'READY' or Status eq 'RESERVED'`).

Filter predicates which are based on the 'CustomAttributeData' navigation property must provide the name of the task attribute and its value combined with 'and', for example `CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_247'`. 
These predicates can be combined with 'and' to filter on different attributes. They can be combined with 'or' to filter multiple values, for example: `(CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_247') or (CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_007')`.
For optimal performance, filter also the 'TaskDefinitionID' attribute of candidate tasks. If more than 50 different task definitions match the query based on the 'CustomAttributeData/Name' predicates, you must specify a predicate on the 'TaskDefinitionID' attribute.
        String $orderby = $orderby_example; // String | Specify the attribute you want to sort by and the order separated by a space. 
Up to two attributes can be used (for example: 'CreatedOn desc, Priority desc'). Using more attributes is not allowed.
Results are sorted in the given sequence. 

When sorting by TaskDefinitionName, it has to be the first in the sequence.
        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. 
        try {
            TaskInstances result = apiInstance.taskCollectionGet(acceptLanguage, $expand, $skip, $top, $filter, $orderby, $inlinecount, $format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskCollectionApi#taskCollectionGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskCollectionApi;

public class TaskCollectionApiExample {

    public static void main(String[] args) {
        TaskCollectionApi apiInstance = new TaskCollectionApi();
        String acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
        String $expand = $expand_example; // String | Expand attributes of the task. The enumeration of allowed values is subject to change. Separate multiple values by a comma. 
        Integer $skip = 56; // Integer | Specify the number of records you want to skip from the beginning.
You can skip at most 4000 records. To indicate a result range that starts, for example, at 1001, combine the $skip with the $top parameter.
If not specified, no records are skipped.
Refer also to the $top parameter.
        Integer $top = 56; // Integer | Specify the number of records you want to show.
You can see at most 1000 records per API call. To indicate a result range that starts, for example, at 1001, combine the $top with the $skip parameter.
If not specified, 100 records are returned.
Refer also to the $skip parameter.
        String $filter = $filter_example; // String | Specify the filter attribute for tasks using the following format: `$filter=attribute eq 'value'`. More complex filter predicates are only supported as described in the following.

Filtering on 'CreatedOn' and 'CompletionDeadline' supports the greater-equal ('ge') and lower-equal ('le') operator. All other attributes only support filtering on equality ('eq'). 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'READY' and Priority eq 'HIGH'`).

Filtering the TaskDefinitionID, Status, Priority, and PriorityNumber attributes supports multiple values that are combined with 'or' (for example: `Status eq 'READY' or Status eq 'RESERVED'`).

Filter predicates which are based on the 'CustomAttributeData' navigation property must provide the name of the task attribute and its value combined with 'and', for example `CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_247'`. 
These predicates can be combined with 'and' to filter on different attributes. They can be combined with 'or' to filter multiple values, for example: `(CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_247') or (CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_007')`.
For optimal performance, filter also the 'TaskDefinitionID' attribute of candidate tasks. If more than 50 different task definitions match the query based on the 'CustomAttributeData/Name' predicates, you must specify a predicate on the 'TaskDefinitionID' attribute.
        String $orderby = $orderby_example; // String | Specify the attribute you want to sort by and the order separated by a space. 
Up to two attributes can be used (for example: 'CreatedOn desc, Priority desc'). Using more attributes is not allowed.
Results are sorted in the given sequence. 

When sorting by TaskDefinitionName, it has to be the first in the sequence.
        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. 
        try {
            TaskInstances result = apiInstance.taskCollectionGet(acceptLanguage, $expand, $skip, $top, $filter, $orderby, $inlinecount, $format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskCollectionApi#taskCollectionGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_AuthorizationCode)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_ClientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *acceptLanguage = acceptLanguage_example; // Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional)
String *$expand = $expand_example; // Expand attributes of the task. The enumeration of allowed values is subject to change. Separate multiple values by a comma.  (optional) (default to Description)
Integer *$skip = 56; // Specify the number of records you want to skip from the beginning.
You can skip at most 4000 records. To indicate a result range that starts, for example, at 1001, combine the $skip with the $top parameter.
If not specified, no records are skipped.
Refer also to the $top parameter. (optional) (default to 0)
Integer *$top = 56; // Specify the number of records you want to show.
You can see at most 1000 records per API call. To indicate a result range that starts, for example, at 1001, combine the $top with the $skip parameter.
If not specified, 100 records are returned.
Refer also to the $skip parameter. (optional) (default to 100)
String *$filter = $filter_example; // Specify the filter attribute for tasks using the following format: `$filter=attribute eq 'value'`. More complex filter predicates are only supported as described in the following.

Filtering on 'CreatedOn' and 'CompletionDeadline' supports the greater-equal ('ge') and lower-equal ('le') operator. All other attributes only support filtering on equality ('eq'). 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'READY' and Priority eq 'HIGH'`).

Filtering the TaskDefinitionID, Status, Priority, and PriorityNumber attributes supports multiple values that are combined with 'or' (for example: `Status eq 'READY' or Status eq 'RESERVED'`).

Filter predicates which are based on the 'CustomAttributeData' navigation property must provide the name of the task attribute and its value combined with 'and', for example `CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_247'`. 
These predicates can be combined with 'and' to filter on different attributes. They can be combined with 'or' to filter multiple values, for example: `(CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_247') or (CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_007')`.
For optimal performance, filter also the 'TaskDefinitionID' attribute of candidate tasks. If more than 50 different task definitions match the query based on the 'CustomAttributeData/Name' predicates, you must specify a predicate on the 'TaskDefinitionID' attribute. (optional) (default to Status eq 'READY' or Status eq 'RESERVED')
String *$orderby = $orderby_example; // Specify the attribute you want to sort by and the order separated by a space. 
Up to two attributes can be used (for example: 'CreatedOn desc, Priority desc'). Using more attributes is not allowed.
Results are sorted in the given sequence. 

When sorting by TaskDefinitionName, it has to be the first in the sequence. (optional) (default to CreatedOn desc)
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) (default to none)
String *$format = $format_example; // Specify the format of the result.  (optional) (default to xml)

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

// Retrieves a list of the tasks for the current user
[apiInstance taskCollectionGetWith:acceptLanguage
    $expand:$expand
    $skip:$skip
    $top:$top
    $filter:$filter
    $orderby:$orderby
    $inlinecount:$inlinecount
    $format:$format
              completionHandler: ^(TaskInstances output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InboxApiForNeo = require('inbox_api_for_neo');
var defaultClient = InboxApiForNeo.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuthentication
var BasicAuthentication = defaultClient.authentications['BasicAuthentication'];
BasicAuthentication.username = 'YOUR USERNAME'
BasicAuthentication.password = 'YOUR PASSWORD'

// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
var Oauth2_AuthorizationCode = defaultClient.authentications['Oauth2_AuthorizationCode'];
Oauth2_AuthorizationCode.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
var Oauth2_ClientCredentials = defaultClient.authentications['Oauth2_ClientCredentials'];
Oauth2_ClientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new InboxApiForNeo.TaskCollectionApi()

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} Provide a preferred language. If a translation is available, relevant texts are returned in this language.
  '$expand': $expand_example, // {String} Expand attributes of the task. The enumeration of allowed values is subject to change. Separate multiple values by a comma. 
  '$skip': 56, // {Integer} Specify the number of records you want to skip from the beginning.
You can skip at most 4000 records. To indicate a result range that starts, for example, at 1001, combine the $skip with the $top parameter.
If not specified, no records are skipped.
Refer also to the $top parameter.
  '$top': 56, // {Integer} Specify the number of records you want to show.
You can see at most 1000 records per API call. To indicate a result range that starts, for example, at 1001, combine the $top with the $skip parameter.
If not specified, 100 records are returned.
Refer also to the $skip parameter.
  '$filter': $filter_example, // {String} Specify the filter attribute for tasks using the following format: `$filter=attribute eq 'value'`. More complex filter predicates are only supported as described in the following.

Filtering on 'CreatedOn' and 'CompletionDeadline' supports the greater-equal ('ge') and lower-equal ('le') operator. All other attributes only support filtering on equality ('eq'). 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'READY' and Priority eq 'HIGH'`).

Filtering the TaskDefinitionID, Status, Priority, and PriorityNumber attributes supports multiple values that are combined with 'or' (for example: `Status eq 'READY' or Status eq 'RESERVED'`).

Filter predicates which are based on the 'CustomAttributeData' navigation property must provide the name of the task attribute and its value combined with 'and', for example `CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_247'`. 
These predicates can be combined with 'and' to filter on different attributes. They can be combined with 'or' to filter multiple values, for example: `(CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_247') or (CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_007')`.
For optimal performance, filter also the 'TaskDefinitionID' attribute of candidate tasks. If more than 50 different task definitions match the query based on the 'CustomAttributeData/Name' predicates, you must specify a predicate on the 'TaskDefinitionID' attribute.
  '$orderby': $orderby_example, // {String} Specify the attribute you want to sort by and the order separated by a space. 
Up to two attributes can be used (for example: 'CreatedOn desc, Priority desc'). Using more attributes is not allowed.
Results are sorted in the given sequence. 

When sorting by TaskDefinitionName, it has to be the first in the sequence.
  '$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. 
};

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

namespace Example
{
    public class taskCollectionGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuthentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TaskCollectionApi();
            var acceptLanguage = acceptLanguage_example;  // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional) 
            var $expand = $expand_example;  // String | Expand attributes of the task. The enumeration of allowed values is subject to change. Separate multiple values by a comma.  (optional)  (default to Description)
            var $skip = 56;  // Integer | Specify the number of records you want to skip from the beginning.
You can skip at most 4000 records. To indicate a result range that starts, for example, at 1001, combine the $skip with the $top parameter.
If not specified, no records are skipped.
Refer also to the $top parameter. (optional)  (default to 0)
            var $top = 56;  // Integer | Specify the number of records you want to show.
You can see at most 1000 records per API call. To indicate a result range that starts, for example, at 1001, combine the $top with the $skip parameter.
If not specified, 100 records are returned.
Refer also to the $skip parameter. (optional)  (default to 100)
            var $filter = $filter_example;  // String | Specify the filter attribute for tasks using the following format: `$filter=attribute eq 'value'`. More complex filter predicates are only supported as described in the following.

Filtering on 'CreatedOn' and 'CompletionDeadline' supports the greater-equal ('ge') and lower-equal ('le') operator. All other attributes only support filtering on equality ('eq'). 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'READY' and Priority eq 'HIGH'`).

Filtering the TaskDefinitionID, Status, Priority, and PriorityNumber attributes supports multiple values that are combined with 'or' (for example: `Status eq 'READY' or Status eq 'RESERVED'`).

Filter predicates which are based on the 'CustomAttributeData' navigation property must provide the name of the task attribute and its value combined with 'and', for example `CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_247'`. 
These predicates can be combined with 'and' to filter on different attributes. They can be combined with 'or' to filter multiple values, for example: `(CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_247') or (CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_007')`.
For optimal performance, filter also the 'TaskDefinitionID' attribute of candidate tasks. If more than 50 different task definitions match the query based on the 'CustomAttributeData/Name' predicates, you must specify a predicate on the 'TaskDefinitionID' attribute. (optional)  (default to Status eq 'READY' or Status eq 'RESERVED')
            var $orderby = $orderby_example;  // String | Specify the attribute you want to sort by and the order separated by a space. 
Up to two attributes can be used (for example: 'CreatedOn desc, Priority desc'). Using more attributes is not allowed.
Results are sorted in the given sequence. 

When sorting by TaskDefinitionName, it has to be the first in the sequence. (optional)  (default to CreatedOn desc)
            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)  (default to none)
            var $format = $format_example;  // String | Specify the format of the result.  (optional)  (default to xml)

            try
            {
                // Retrieves a list of the tasks for the current user
                TaskInstances result = apiInstance.taskCollectionGet(acceptLanguage, $expand, $skip, $top, $filter, $orderby, $inlinecount, $format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskCollectionApi.taskCollectionGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\TaskCollectionApi();
$acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
$$expand = $expand_example; // String | Expand attributes of the task. The enumeration of allowed values is subject to change. Separate multiple values by a comma. 
$$skip = 56; // Integer | Specify the number of records you want to skip from the beginning.
You can skip at most 4000 records. To indicate a result range that starts, for example, at 1001, combine the $skip with the $top parameter.
If not specified, no records are skipped.
Refer also to the $top parameter.
$$top = 56; // Integer | Specify the number of records you want to show.
You can see at most 1000 records per API call. To indicate a result range that starts, for example, at 1001, combine the $top with the $skip parameter.
If not specified, 100 records are returned.
Refer also to the $skip parameter.
$$filter = $filter_example; // String | Specify the filter attribute for tasks using the following format: `$filter=attribute eq 'value'`. More complex filter predicates are only supported as described in the following.

Filtering on 'CreatedOn' and 'CompletionDeadline' supports the greater-equal ('ge') and lower-equal ('le') operator. All other attributes only support filtering on equality ('eq'). 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'READY' and Priority eq 'HIGH'`).

Filtering the TaskDefinitionID, Status, Priority, and PriorityNumber attributes supports multiple values that are combined with 'or' (for example: `Status eq 'READY' or Status eq 'RESERVED'`).

Filter predicates which are based on the 'CustomAttributeData' navigation property must provide the name of the task attribute and its value combined with 'and', for example `CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_247'`. 
These predicates can be combined with 'and' to filter on different attributes. They can be combined with 'or' to filter multiple values, for example: `(CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_247') or (CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_007')`.
For optimal performance, filter also the 'TaskDefinitionID' attribute of candidate tasks. If more than 50 different task definitions match the query based on the 'CustomAttributeData/Name' predicates, you must specify a predicate on the 'TaskDefinitionID' attribute.
$$orderby = $orderby_example; // String | Specify the attribute you want to sort by and the order separated by a space. 
Up to two attributes can be used (for example: 'CreatedOn desc, Priority desc'). Using more attributes is not allowed.
Results are sorted in the given sequence. 

When sorting by TaskDefinitionName, it has to be the first in the sequence.
$$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. 

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

# Configure HTTP basic authorization: BasicAuthentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TaskCollectionApi->new();
my $acceptLanguage = acceptLanguage_example; # String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
my $$expand = $expand_example; # String | Expand attributes of the task. The enumeration of allowed values is subject to change. Separate multiple values by a comma. 
my $$skip = 56; # Integer | Specify the number of records you want to skip from the beginning.
You can skip at most 4000 records. To indicate a result range that starts, for example, at 1001, combine the $skip with the $top parameter.
If not specified, no records are skipped.
Refer also to the $top parameter.
my $$top = 56; # Integer | Specify the number of records you want to show.
You can see at most 1000 records per API call. To indicate a result range that starts, for example, at 1001, combine the $top with the $skip parameter.
If not specified, 100 records are returned.
Refer also to the $skip parameter.
my $$filter = $filter_example; # String | Specify the filter attribute for tasks using the following format: `$filter=attribute eq 'value'`. More complex filter predicates are only supported as described in the following.

Filtering on 'CreatedOn' and 'CompletionDeadline' supports the greater-equal ('ge') and lower-equal ('le') operator. All other attributes only support filtering on equality ('eq'). 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'READY' and Priority eq 'HIGH'`).

Filtering the TaskDefinitionID, Status, Priority, and PriorityNumber attributes supports multiple values that are combined with 'or' (for example: `Status eq 'READY' or Status eq 'RESERVED'`).

Filter predicates which are based on the 'CustomAttributeData' navigation property must provide the name of the task attribute and its value combined with 'and', for example `CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_247'`. 
These predicates can be combined with 'and' to filter on different attributes. They can be combined with 'or' to filter multiple values, for example: `(CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_247') or (CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_007')`.
For optimal performance, filter also the 'TaskDefinitionID' attribute of candidate tasks. If more than 50 different task definitions match the query based on the 'CustomAttributeData/Name' predicates, you must specify a predicate on the 'TaskDefinitionID' attribute.
my $$orderby = $orderby_example; # String | Specify the attribute you want to sort by and the order separated by a space. 
Up to two attributes can be used (for example: 'CreatedOn desc, Priority desc'). Using more attributes is not allowed.
Results are sorted in the given sequence. 

When sorting by TaskDefinitionName, it has to be the first in the sequence.
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. 

eval { 
    my $result = $api_instance->taskCollectionGet(acceptLanguage => $acceptLanguage, $expand => $$expand, $skip => $$skip, $top => $$top, $filter => $$filter, $orderby => $$orderby, $inlinecount => $$inlinecount, $format => $$format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaskCollectionApi->taskCollectionGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TaskCollectionApi()
acceptLanguage = acceptLanguage_example # String | Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional)
$expand = $expand_example # String | Expand attributes of the task. The enumeration of allowed values is subject to change. Separate multiple values by a comma.  (optional) (default to Description)
$skip = 56 # Integer | Specify the number of records you want to skip from the beginning.
You can skip at most 4000 records. To indicate a result range that starts, for example, at 1001, combine the $skip with the $top parameter.
If not specified, no records are skipped.
Refer also to the $top parameter. (optional) (default to 0)
$top = 56 # Integer | Specify the number of records you want to show.
You can see at most 1000 records per API call. To indicate a result range that starts, for example, at 1001, combine the $top with the $skip parameter.
If not specified, 100 records are returned.
Refer also to the $skip parameter. (optional) (default to 100)
$filter = $filter_example # String | Specify the filter attribute for tasks using the following format: `$filter=attribute eq 'value'`. More complex filter predicates are only supported as described in the following.

Filtering on 'CreatedOn' and 'CompletionDeadline' supports the greater-equal ('ge') and lower-equal ('le') operator. All other attributes only support filtering on equality ('eq'). 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'READY' and Priority eq 'HIGH'`).

Filtering the TaskDefinitionID, Status, Priority, and PriorityNumber attributes supports multiple values that are combined with 'or' (for example: `Status eq 'READY' or Status eq 'RESERVED'`).

Filter predicates which are based on the 'CustomAttributeData' navigation property must provide the name of the task attribute and its value combined with 'and', for example `CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_247'`. 
These predicates can be combined with 'and' to filter on different attributes. They can be combined with 'or' to filter multiple values, for example: `(CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_247') or (CustomAttributeData/Name eq 'ProjectId' and CustomAttributeData/Value eq 'PRO_007')`.
For optimal performance, filter also the 'TaskDefinitionID' attribute of candidate tasks. If more than 50 different task definitions match the query based on the 'CustomAttributeData/Name' predicates, you must specify a predicate on the 'TaskDefinitionID' attribute. (optional) (default to Status eq 'READY' or Status eq 'RESERVED')
$orderby = $orderby_example # String | Specify the attribute you want to sort by and the order separated by a space. 
Up to two attributes can be used (for example: 'CreatedOn desc, Priority desc'). Using more attributes is not allowed.
Results are sorted in the given sequence. 

When sorting by TaskDefinitionName, it has to be the first in the sequence. (optional) (default to CreatedOn desc)
$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) (default to none)
$format = $format_example # String | Specify the format of the result.  (optional) (default to xml)

try: 
    # Retrieves a list of the tasks for the current user
    api_response = api_instance.taskCollectionGet(acceptLanguage=acceptLanguage, $expand=$expand, $skip=$skip, $top=$top, $filter=$filter, $orderby=$orderby, $inlinecount=$inlinecount, $format=$format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaskCollectionApi->taskCollectionGet: %s\n" % e)

Parameters

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

Responses

Status: 200 - Returns a list of task instances for the current user.

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

{error={code=TASK_BAD_REQUEST, message={lang=en, value=An error occured: 400 Bad Request}}}

Status: 401 - Unauthorized. Please provide valid authentication credentials to access the resource.

{error=unauthorized, error_description=Full authentication is required to access this resource.}

Status: 403 - The user who sent the request is not authorized to access the requested data or to perform the requested action.

{error={code=TASK_USER_NOT_AUTHORIZED, message={lang=en, value=An error occured: 403 Forbidden}}}

Status: 404 - The requested object could not be found.

{error={code=TASK_NOT_FOUND, message={lang=en, value=An error occured: 404 Not Found}}}

Status: 405 - The action to be executed is not supported by the OData service.

{error={message={lang=en, value=An error occured: 405 Method Not Allowed}}}

Status: 406 - The requested object cannot be returned in the specified format according to the accept headers.

{error={message={lang=en, value=An error occured: 406 Not Acceptable}}}

Status: 500 - An error occurred while processing the request.

{error={code=TASK_INVALID_STATE_TRANSITION, message={lang=en, value=An error occured: 500 Internal Server Error}}}

/TaskCollection(SAP__Origin=%27{SAP__Origin}%27,InstanceID=%27{InstanceID}%27)/CustomAttributeData

Retrieves the custom attribute data for a given task. The request can be parameterized.


/TaskCollection(SAP__Origin=%27{SAP__Origin}%27,InstanceID=%27{InstanceID}%27)/CustomAttributeData

Usage

curl -X GET -H "Accept: application/json,application/xml" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://sandbox.api.sap.com/workflow-service/odata/v1/tcm/TaskCollection(SAP__Origin=%27{SAP__Origin}%27,InstanceID=%27{InstanceID}%27)/CustomAttributeData?$format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskCollectionApi;

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

public class TaskCollectionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuthentication
        HttpBasicAuth BasicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuthentication");
        BasicAuthentication.setUsername("YOUR USERNAME");
        BasicAuthentication.setPassword("YOUR PASSWORD");

        // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
        OAuth Oauth2_AuthorizationCode = (OAuth) defaultClient.getAuthentication("Oauth2_AuthorizationCode");
        Oauth2_AuthorizationCode.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
        OAuth Oauth2_ClientCredentials = (OAuth) defaultClient.getAuthentication("Oauth2_ClientCredentials");
        Oauth2_ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        TaskCollectionApi apiInstance = new TaskCollectionApi();
        String sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
        String instanceID = instanceID_example; // String | The ID of the task.
        String acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
        String $format = $format_example; // String | Specify the format of the result. 
        try {
            TaskCustomAttributeDatas result = apiInstance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDCustomAttributeDataGet(sAPOrigin, instanceID, acceptLanguage, $format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskCollectionApi#taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDCustomAttributeDataGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskCollectionApi;

public class TaskCollectionApiExample {

    public static void main(String[] args) {
        TaskCollectionApi apiInstance = new TaskCollectionApi();
        String sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
        String instanceID = instanceID_example; // String | The ID of the task.
        String acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
        String $format = $format_example; // String | Specify the format of the result. 
        try {
            TaskCustomAttributeDatas result = apiInstance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDCustomAttributeDataGet(sAPOrigin, instanceID, acceptLanguage, $format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskCollectionApi#taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDCustomAttributeDataGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_AuthorizationCode)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_ClientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *sAPOrigin = sAPOrigin_example; // The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
String *instanceID = instanceID_example; // The ID of the task.
String *acceptLanguage = acceptLanguage_example; // Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional)
String *$format = $format_example; // Specify the format of the result.  (optional) (default to xml)

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

// Retrieves the custom attribute data for a given task
[apiInstance taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDCustomAttributeDataGetWith:sAPOrigin
    instanceID:instanceID
    acceptLanguage:acceptLanguage
    $format:$format
              completionHandler: ^(TaskCustomAttributeDatas output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InboxApiForNeo = require('inbox_api_for_neo');
var defaultClient = InboxApiForNeo.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuthentication
var BasicAuthentication = defaultClient.authentications['BasicAuthentication'];
BasicAuthentication.username = 'YOUR USERNAME'
BasicAuthentication.password = 'YOUR PASSWORD'

// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
var Oauth2_AuthorizationCode = defaultClient.authentications['Oauth2_AuthorizationCode'];
Oauth2_AuthorizationCode.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
var Oauth2_ClientCredentials = defaultClient.authentications['Oauth2_ClientCredentials'];
Oauth2_ClientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new InboxApiForNeo.TaskCollectionApi()

var sAPOrigin = sAPOrigin_example; // {String} The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).

var instanceID = instanceID_example; // {String} The ID of the task.

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} Provide a preferred language. If a translation is available, relevant texts are returned in this language.
  '$format': $format_example // {String} Specify the format of the result. 
};

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

namespace Example
{
    public class taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDCustomAttributeDataGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuthentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TaskCollectionApi();
            var sAPOrigin = sAPOrigin_example;  // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
            var instanceID = instanceID_example;  // String | The ID of the task.
            var acceptLanguage = acceptLanguage_example;  // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional) 
            var $format = $format_example;  // String | Specify the format of the result.  (optional)  (default to xml)

            try
            {
                // Retrieves the custom attribute data for a given task
                TaskCustomAttributeDatas result = apiInstance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDCustomAttributeDataGet(sAPOrigin, instanceID, acceptLanguage, $format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskCollectionApi.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDCustomAttributeDataGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\TaskCollectionApi();
$sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
$instanceID = instanceID_example; // String | The ID of the task.
$acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
$$format = $format_example; // String | Specify the format of the result. 

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

# Configure HTTP basic authorization: BasicAuthentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TaskCollectionApi->new();
my $sAPOrigin = sAPOrigin_example; # String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
my $instanceID = instanceID_example; # String | The ID of the task.
my $acceptLanguage = acceptLanguage_example; # String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
my $$format = $format_example; # String | Specify the format of the result. 

eval { 
    my $result = $api_instance->taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDCustomAttributeDataGet(sAPOrigin => $sAPOrigin, instanceID => $instanceID, acceptLanguage => $acceptLanguage, $format => $$format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaskCollectionApi->taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDCustomAttributeDataGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TaskCollectionApi()
sAPOrigin = sAPOrigin_example # String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
instanceID = instanceID_example # String | The ID of the task.
acceptLanguage = acceptLanguage_example # String | Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional)
$format = $format_example # String | Specify the format of the result.  (optional) (default to xml)

try: 
    # Retrieves the custom attribute data for a given task
    api_response = api_instance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDCustomAttributeDataGet(sAPOrigin, instanceID, acceptLanguage=acceptLanguage, $format=$format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaskCollectionApi->taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDCustomAttributeDataGet: %s\n" % e)

Parameters

Path parameters
Name Description
SAP__Origin*
InstanceID*
Header parameters
Name Description
Accept-Language
Query parameters
Name Description
$format

Responses

Status: 200 - Returns the custom attribute data of a given task.

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

{error={code=TASK_BAD_REQUEST, message={lang=en, value=An error occured: 400 Bad Request}}}

Status: 401 - Unauthorized. Please provide valid authentication credentials to access the resource.

{error=unauthorized, error_description=Full authentication is required to access this resource.}

Status: 403 - The user who sent the request is not authorized to access the requested data or to perform the requested action.

{error={code=TASK_USER_NOT_AUTHORIZED, message={lang=en, value=An error occured: 403 Forbidden}}}

Status: 404 - The requested object could not be found.

{error={code=TASK_NOT_FOUND, message={lang=en, value=An error occured: 404 Not Found}}}

Status: 405 - The action to be executed is not supported by the OData service.

{error={message={lang=en, value=An error occured: 405 Method Not Allowed}}}

Status: 406 - The requested object cannot be returned in the specified format according to the accept headers.

{error={message={lang=en, value=An error occured: 406 Not Acceptable}}}

Status: 500 - An error occurred while processing the request.

{error={code=TASK_INVALID_STATE_TRANSITION, message={lang=en, value=An error occured: 500 Internal Server Error}}}

/TaskCollection(SAP__Origin=%27{SAP__Origin}%27,InstanceID=%27{InstanceID}%27)/Description

Retrieves the description of a task.


/TaskCollection(SAP__Origin=%27{SAP__Origin}%27,InstanceID=%27{InstanceID}%27)/Description

Usage

curl -X GET -H "Accept: application/json,application/xml" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://sandbox.api.sap.com/workflow-service/odata/v1/tcm/TaskCollection(SAP__Origin=%27{SAP__Origin}%27,InstanceID=%27{InstanceID}%27)/Description?$format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskCollectionApi;

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

public class TaskCollectionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuthentication
        HttpBasicAuth BasicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuthentication");
        BasicAuthentication.setUsername("YOUR USERNAME");
        BasicAuthentication.setPassword("YOUR PASSWORD");

        // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
        OAuth Oauth2_AuthorizationCode = (OAuth) defaultClient.getAuthentication("Oauth2_AuthorizationCode");
        Oauth2_AuthorizationCode.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
        OAuth Oauth2_ClientCredentials = (OAuth) defaultClient.getAuthentication("Oauth2_ClientCredentials");
        Oauth2_ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        TaskCollectionApi apiInstance = new TaskCollectionApi();
        String sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
        String instanceID = instanceID_example; // String | The ID of the task.
        String acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
        String $format = $format_example; // String | Specify the format of the result. 
        try {
            TaskDescription result = apiInstance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDDescriptionGet(sAPOrigin, instanceID, acceptLanguage, $format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskCollectionApi#taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDDescriptionGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskCollectionApi;

public class TaskCollectionApiExample {

    public static void main(String[] args) {
        TaskCollectionApi apiInstance = new TaskCollectionApi();
        String sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
        String instanceID = instanceID_example; // String | The ID of the task.
        String acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
        String $format = $format_example; // String | Specify the format of the result. 
        try {
            TaskDescription result = apiInstance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDDescriptionGet(sAPOrigin, instanceID, acceptLanguage, $format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskCollectionApi#taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDDescriptionGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_AuthorizationCode)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_ClientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *sAPOrigin = sAPOrigin_example; // The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
String *instanceID = instanceID_example; // The ID of the task.
String *acceptLanguage = acceptLanguage_example; // Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional)
String *$format = $format_example; // Specify the format of the result.  (optional) (default to xml)

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

// Retrieves the description of a task
[apiInstance taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDDescriptionGetWith:sAPOrigin
    instanceID:instanceID
    acceptLanguage:acceptLanguage
    $format:$format
              completionHandler: ^(TaskDescription output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InboxApiForNeo = require('inbox_api_for_neo');
var defaultClient = InboxApiForNeo.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuthentication
var BasicAuthentication = defaultClient.authentications['BasicAuthentication'];
BasicAuthentication.username = 'YOUR USERNAME'
BasicAuthentication.password = 'YOUR PASSWORD'

// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
var Oauth2_AuthorizationCode = defaultClient.authentications['Oauth2_AuthorizationCode'];
Oauth2_AuthorizationCode.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
var Oauth2_ClientCredentials = defaultClient.authentications['Oauth2_ClientCredentials'];
Oauth2_ClientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new InboxApiForNeo.TaskCollectionApi()

var sAPOrigin = sAPOrigin_example; // {String} The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).

var instanceID = instanceID_example; // {String} The ID of the task.

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} Provide a preferred language. If a translation is available, relevant texts are returned in this language.
  '$format': $format_example // {String} Specify the format of the result. 
};

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

namespace Example
{
    public class taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDDescriptionGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuthentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TaskCollectionApi();
            var sAPOrigin = sAPOrigin_example;  // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
            var instanceID = instanceID_example;  // String | The ID of the task.
            var acceptLanguage = acceptLanguage_example;  // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional) 
            var $format = $format_example;  // String | Specify the format of the result.  (optional)  (default to xml)

            try
            {
                // Retrieves the description of a task
                TaskDescription result = apiInstance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDDescriptionGet(sAPOrigin, instanceID, acceptLanguage, $format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskCollectionApi.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDDescriptionGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\TaskCollectionApi();
$sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
$instanceID = instanceID_example; // String | The ID of the task.
$acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
$$format = $format_example; // String | Specify the format of the result. 

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

# Configure HTTP basic authorization: BasicAuthentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TaskCollectionApi->new();
my $sAPOrigin = sAPOrigin_example; # String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
my $instanceID = instanceID_example; # String | The ID of the task.
my $acceptLanguage = acceptLanguage_example; # String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
my $$format = $format_example; # String | Specify the format of the result. 

eval { 
    my $result = $api_instance->taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDDescriptionGet(sAPOrigin => $sAPOrigin, instanceID => $instanceID, acceptLanguage => $acceptLanguage, $format => $$format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaskCollectionApi->taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDDescriptionGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TaskCollectionApi()
sAPOrigin = sAPOrigin_example # String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
instanceID = instanceID_example # String | The ID of the task.
acceptLanguage = acceptLanguage_example # String | Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional)
$format = $format_example # String | Specify the format of the result.  (optional) (default to xml)

try: 
    # Retrieves the description of a task
    api_response = api_instance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDDescriptionGet(sAPOrigin, instanceID, acceptLanguage=acceptLanguage, $format=$format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaskCollectionApi->taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDDescriptionGet: %s\n" % e)

Parameters

Path parameters
Name Description
SAP__Origin*
InstanceID*
Header parameters
Name Description
Accept-Language
Query parameters
Name Description
$format

Responses

Status: 200 - Returns the description for a given task.

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

{error={code=TASK_BAD_REQUEST, message={lang=en, value=An error occured: 400 Bad Request}}}

Status: 401 - Unauthorized. Please provide valid authentication credentials to access the resource.

{error=unauthorized, error_description=Full authentication is required to access this resource.}

Status: 403 - The user who sent the request is not authorized to access the requested data or to perform the requested action.

{error={code=TASK_USER_NOT_AUTHORIZED, message={lang=en, value=An error occured: 403 Forbidden}}}

Status: 404 - The requested object could not be found.

{error={code=TASK_NOT_FOUND, message={lang=en, value=An error occured: 404 Not Found}}}

Status: 405 - The action to be executed is not supported by the OData service.

{error={message={lang=en, value=An error occured: 405 Method Not Allowed}}}

Status: 406 - The requested object cannot be returned in the specified format according to the accept headers.

{error={message={lang=en, value=An error occured: 406 Not Acceptable}}}

Status: 500 - An error occurred while processing the request.

{error={code=TASK_INVALID_STATE_TRANSITION, message={lang=en, value=An error occured: 500 Internal Server Error}}}

/TaskCollection(SAP__Origin=%27{SAP__Origin}%27,InstanceID=%27{InstanceID}%27)

Retrieves a task for the current user. The request can be parameterized.


/TaskCollection(SAP__Origin=%27{SAP__Origin}%27,InstanceID=%27{InstanceID}%27)

Usage

curl -X GET -H "Accept: application/json,application/xml" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://sandbox.api.sap.com/workflow-service/odata/v1/tcm/TaskCollection(SAP__Origin=%27{SAP__Origin}%27,InstanceID=%27{InstanceID}%27)?$format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskCollectionApi;

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

public class TaskCollectionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuthentication
        HttpBasicAuth BasicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuthentication");
        BasicAuthentication.setUsername("YOUR USERNAME");
        BasicAuthentication.setPassword("YOUR PASSWORD");

        // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
        OAuth Oauth2_AuthorizationCode = (OAuth) defaultClient.getAuthentication("Oauth2_AuthorizationCode");
        Oauth2_AuthorizationCode.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
        OAuth Oauth2_ClientCredentials = (OAuth) defaultClient.getAuthentication("Oauth2_ClientCredentials");
        Oauth2_ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        TaskCollectionApi apiInstance = new TaskCollectionApi();
        String sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
        String instanceID = instanceID_example; // String | The ID of the task.
        String acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
        String $format = $format_example; // String | Specify the format of the result. 
        try {
            TaskInstance result = apiInstance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDGet(sAPOrigin, instanceID, acceptLanguage, $format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskCollectionApi#taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskCollectionApi;

public class TaskCollectionApiExample {

    public static void main(String[] args) {
        TaskCollectionApi apiInstance = new TaskCollectionApi();
        String sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
        String instanceID = instanceID_example; // String | The ID of the task.
        String acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
        String $format = $format_example; // String | Specify the format of the result. 
        try {
            TaskInstance result = apiInstance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDGet(sAPOrigin, instanceID, acceptLanguage, $format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskCollectionApi#taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_AuthorizationCode)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_ClientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *sAPOrigin = sAPOrigin_example; // The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
String *instanceID = instanceID_example; // The ID of the task.
String *acceptLanguage = acceptLanguage_example; // Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional)
String *$format = $format_example; // Specify the format of the result.  (optional) (default to xml)

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

// Retrieves a task for the current user
[apiInstance taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDGetWith:sAPOrigin
    instanceID:instanceID
    acceptLanguage:acceptLanguage
    $format:$format
              completionHandler: ^(TaskInstance output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InboxApiForNeo = require('inbox_api_for_neo');
var defaultClient = InboxApiForNeo.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuthentication
var BasicAuthentication = defaultClient.authentications['BasicAuthentication'];
BasicAuthentication.username = 'YOUR USERNAME'
BasicAuthentication.password = 'YOUR PASSWORD'

// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
var Oauth2_AuthorizationCode = defaultClient.authentications['Oauth2_AuthorizationCode'];
Oauth2_AuthorizationCode.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
var Oauth2_ClientCredentials = defaultClient.authentications['Oauth2_ClientCredentials'];
Oauth2_ClientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new InboxApiForNeo.TaskCollectionApi()

var sAPOrigin = sAPOrigin_example; // {String} The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).

var instanceID = instanceID_example; // {String} The ID of the task.

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} Provide a preferred language. If a translation is available, relevant texts are returned in this language.
  '$format': $format_example // {String} Specify the format of the result. 
};

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

namespace Example
{
    public class taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuthentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TaskCollectionApi();
            var sAPOrigin = sAPOrigin_example;  // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
            var instanceID = instanceID_example;  // String | The ID of the task.
            var acceptLanguage = acceptLanguage_example;  // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional) 
            var $format = $format_example;  // String | Specify the format of the result.  (optional)  (default to xml)

            try
            {
                // Retrieves a task for the current user
                TaskInstance result = apiInstance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDGet(sAPOrigin, instanceID, acceptLanguage, $format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskCollectionApi.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\TaskCollectionApi();
$sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
$instanceID = instanceID_example; // String | The ID of the task.
$acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
$$format = $format_example; // String | Specify the format of the result. 

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

# Configure HTTP basic authorization: BasicAuthentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TaskCollectionApi->new();
my $sAPOrigin = sAPOrigin_example; # String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
my $instanceID = instanceID_example; # String | The ID of the task.
my $acceptLanguage = acceptLanguage_example; # String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
my $$format = $format_example; # String | Specify the format of the result. 

eval { 
    my $result = $api_instance->taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDGet(sAPOrigin => $sAPOrigin, instanceID => $instanceID, acceptLanguage => $acceptLanguage, $format => $$format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaskCollectionApi->taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TaskCollectionApi()
sAPOrigin = sAPOrigin_example # String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
instanceID = instanceID_example # String | The ID of the task.
acceptLanguage = acceptLanguage_example # String | Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional)
$format = $format_example # String | Specify the format of the result.  (optional) (default to xml)

try: 
    # Retrieves a task for the current user
    api_response = api_instance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDGet(sAPOrigin, instanceID, acceptLanguage=acceptLanguage, $format=$format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaskCollectionApi->taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDGet: %s\n" % e)

Parameters

Path parameters
Name Description
SAP__Origin*
InstanceID*
Header parameters
Name Description
Accept-Language
Query parameters
Name Description
$format

Responses

Status: 200 - Returns a task.

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

{error={code=TASK_BAD_REQUEST, message={lang=en, value=An error occured: 400 Bad Request}}}

Status: 401 - Unauthorized. Please provide valid authentication credentials to access the resource.

{error=unauthorized, error_description=Full authentication is required to access this resource.}

Status: 403 - The user who sent the request is not authorized to access the requested data or to perform the requested action.

{error={code=TASK_USER_NOT_AUTHORIZED, message={lang=en, value=An error occured: 403 Forbidden}}}

Status: 404 - The requested object could not be found.

{error={code=TASK_NOT_FOUND, message={lang=en, value=An error occured: 404 Not Found}}}

Status: 405 - The action to be executed is not supported by the OData service.

{error={message={lang=en, value=An error occured: 405 Method Not Allowed}}}

Status: 406 - The requested object cannot be returned in the specified format according to the accept headers.

{error={message={lang=en, value=An error occured: 406 Not Acceptable}}}

Status: 500 - An error occurred while processing the request.

{error={code=TASK_INVALID_STATE_TRANSITION, message={lang=en, value=An error occured: 500 Internal Server Error}}}

/TaskCollection(SAP__Origin=%27{SAP__Origin}%27,InstanceID=%27{InstanceID}%27)/TaskDefinitionData

Retrieves the task definition data for a given task. The request can be parameterized.


/TaskCollection(SAP__Origin=%27{SAP__Origin}%27,InstanceID=%27{InstanceID}%27)/TaskDefinitionData

Usage

curl -X GET -H "Accept: application/json,application/xml" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://sandbox.api.sap.com/workflow-service/odata/v1/tcm/TaskCollection(SAP__Origin=%27{SAP__Origin}%27,InstanceID=%27{InstanceID}%27)/TaskDefinitionData?$format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskCollectionApi;

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

public class TaskCollectionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuthentication
        HttpBasicAuth BasicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuthentication");
        BasicAuthentication.setUsername("YOUR USERNAME");
        BasicAuthentication.setPassword("YOUR PASSWORD");

        // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
        OAuth Oauth2_AuthorizationCode = (OAuth) defaultClient.getAuthentication("Oauth2_AuthorizationCode");
        Oauth2_AuthorizationCode.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
        OAuth Oauth2_ClientCredentials = (OAuth) defaultClient.getAuthentication("Oauth2_ClientCredentials");
        Oauth2_ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        TaskCollectionApi apiInstance = new TaskCollectionApi();
        String sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
        String instanceID = instanceID_example; // String | The ID of the task.
        String acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.    
        String $format = $format_example; // String | Specify the format of the result. 
        try {
            TaskDefinition result = apiInstance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDTaskDefinitionDataGet(sAPOrigin, instanceID, acceptLanguage, $format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskCollectionApi#taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDTaskDefinitionDataGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskCollectionApi;

public class TaskCollectionApiExample {

    public static void main(String[] args) {
        TaskCollectionApi apiInstance = new TaskCollectionApi();
        String sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
        String instanceID = instanceID_example; // String | The ID of the task.
        String acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.    
        String $format = $format_example; // String | Specify the format of the result. 
        try {
            TaskDefinition result = apiInstance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDTaskDefinitionDataGet(sAPOrigin, instanceID, acceptLanguage, $format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskCollectionApi#taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDTaskDefinitionDataGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_AuthorizationCode)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_ClientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *sAPOrigin = sAPOrigin_example; // The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
String *instanceID = instanceID_example; // The ID of the task.
String *acceptLanguage = acceptLanguage_example; // Provide a preferred language. If a translation is available, relevant texts are returned in this language.     (optional)
String *$format = $format_example; // Specify the format of the result.  (optional) (default to xml)

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

// Retrieves the task definition data for a given task
[apiInstance taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDTaskDefinitionDataGetWith:sAPOrigin
    instanceID:instanceID
    acceptLanguage:acceptLanguage
    $format:$format
              completionHandler: ^(TaskDefinition output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InboxApiForNeo = require('inbox_api_for_neo');
var defaultClient = InboxApiForNeo.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuthentication
var BasicAuthentication = defaultClient.authentications['BasicAuthentication'];
BasicAuthentication.username = 'YOUR USERNAME'
BasicAuthentication.password = 'YOUR PASSWORD'

// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
var Oauth2_AuthorizationCode = defaultClient.authentications['Oauth2_AuthorizationCode'];
Oauth2_AuthorizationCode.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
var Oauth2_ClientCredentials = defaultClient.authentications['Oauth2_ClientCredentials'];
Oauth2_ClientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new InboxApiForNeo.TaskCollectionApi()

var sAPOrigin = sAPOrigin_example; // {String} The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).

var instanceID = instanceID_example; // {String} The ID of the task.

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} Provide a preferred language. If a translation is available, relevant texts are returned in this language.    
  '$format': $format_example // {String} Specify the format of the result. 
};

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

namespace Example
{
    public class taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDTaskDefinitionDataGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuthentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TaskCollectionApi();
            var sAPOrigin = sAPOrigin_example;  // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
            var instanceID = instanceID_example;  // String | The ID of the task.
            var acceptLanguage = acceptLanguage_example;  // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.     (optional) 
            var $format = $format_example;  // String | Specify the format of the result.  (optional)  (default to xml)

            try
            {
                // Retrieves the task definition data for a given task
                TaskDefinition result = apiInstance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDTaskDefinitionDataGet(sAPOrigin, instanceID, acceptLanguage, $format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskCollectionApi.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDTaskDefinitionDataGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\TaskCollectionApi();
$sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
$instanceID = instanceID_example; // String | The ID of the task.
$acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.    
$$format = $format_example; // String | Specify the format of the result. 

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

# Configure HTTP basic authorization: BasicAuthentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TaskCollectionApi->new();
my $sAPOrigin = sAPOrigin_example; # String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
my $instanceID = instanceID_example; # String | The ID of the task.
my $acceptLanguage = acceptLanguage_example; # String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.    
my $$format = $format_example; # String | Specify the format of the result. 

eval { 
    my $result = $api_instance->taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDTaskDefinitionDataGet(sAPOrigin => $sAPOrigin, instanceID => $instanceID, acceptLanguage => $acceptLanguage, $format => $$format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaskCollectionApi->taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDTaskDefinitionDataGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TaskCollectionApi()
sAPOrigin = sAPOrigin_example # String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
instanceID = instanceID_example # String | The ID of the task.
acceptLanguage = acceptLanguage_example # String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.     (optional)
$format = $format_example # String | Specify the format of the result.  (optional) (default to xml)

try: 
    # Retrieves the task definition data for a given task
    api_response = api_instance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDTaskDefinitionDataGet(sAPOrigin, instanceID, acceptLanguage=acceptLanguage, $format=$format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaskCollectionApi->taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDTaskDefinitionDataGet: %s\n" % e)

Parameters

Path parameters
Name Description
SAP__Origin*
InstanceID*
Header parameters
Name Description
Accept-Language
Query parameters
Name Description
$format

Responses

Status: 200 - Returns the task definition data of a given task.

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

{error={code=TASK_BAD_REQUEST, message={lang=en, value=An error occured: 400 Bad Request}}}

Status: 401 - Unauthorized. Please provide valid authentication credentials to access the resource.

{error=unauthorized, error_description=Full authentication is required to access this resource.}

Status: 403 - The user who sent the request is not authorized to access the requested data or to perform the requested action.

{error={code=TASK_USER_NOT_AUTHORIZED, message={lang=en, value=An error occured: 403 Forbidden}}}

Status: 404 - The requested object could not be found.

{error={code=TASK_NOT_FOUND, message={lang=en, value=An error occured: 404 Not Found}}}

Status: 405 - The action to be executed is not supported by the OData service.

{error={message={lang=en, value=An error occured: 405 Method Not Allowed}}}

Status: 406 - The requested object cannot be returned in the specified format according to the accept headers.

{error={message={lang=en, value=An error occured: 406 Not Acceptable}}}

Status: 500 - An error occurred while processing the request.

{error={code=TASK_INVALID_STATE_TRANSITION, message={lang=en, value=An error occured: 500 Internal Server Error}}}

/TaskCollection(SAP__Origin=%27{SAP__Origin}%27,InstanceID=%27{InstanceID}%27)/WorkflowLogs

Retrieves the history of the workflow for the given task, with detailed information about the tasks that are part of the workflow.


/TaskCollection(SAP__Origin=%27{SAP__Origin}%27,InstanceID=%27{InstanceID}%27)/WorkflowLogs

Usage

curl -X GET -H "Accept: application/json,application/xml" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://sandbox.api.sap.com/workflow-service/odata/v1/tcm/TaskCollection(SAP__Origin=%27{SAP__Origin}%27,InstanceID=%27{InstanceID}%27)/WorkflowLogs?$format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskCollectionApi;

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

public class TaskCollectionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuthentication
        HttpBasicAuth BasicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuthentication");
        BasicAuthentication.setUsername("YOUR USERNAME");
        BasicAuthentication.setPassword("YOUR PASSWORD");

        // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
        OAuth Oauth2_AuthorizationCode = (OAuth) defaultClient.getAuthentication("Oauth2_AuthorizationCode");
        Oauth2_AuthorizationCode.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
        OAuth Oauth2_ClientCredentials = (OAuth) defaultClient.getAuthentication("Oauth2_ClientCredentials");
        Oauth2_ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        TaskCollectionApi apiInstance = new TaskCollectionApi();
        String sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
        String instanceID = instanceID_example; // String | The ID of the task.
        String acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
        String $format = $format_example; // String | Specify the format of the result. 
        try {
            WorkflowLogs result = apiInstance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDWorkflowLogsGet(sAPOrigin, instanceID, acceptLanguage, $format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskCollectionApi#taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDWorkflowLogsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskCollectionApi;

public class TaskCollectionApiExample {

    public static void main(String[] args) {
        TaskCollectionApi apiInstance = new TaskCollectionApi();
        String sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
        String instanceID = instanceID_example; // String | The ID of the task.
        String acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
        String $format = $format_example; // String | Specify the format of the result. 
        try {
            WorkflowLogs result = apiInstance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDWorkflowLogsGet(sAPOrigin, instanceID, acceptLanguage, $format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskCollectionApi#taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDWorkflowLogsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_AuthorizationCode)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_ClientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *sAPOrigin = sAPOrigin_example; // The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
String *instanceID = instanceID_example; // The ID of the task.
String *acceptLanguage = acceptLanguage_example; // Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional)
String *$format = $format_example; // Specify the format of the result.  (optional) (default to xml)

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

// Retrieves the history of the workflow for the given task
[apiInstance taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDWorkflowLogsGetWith:sAPOrigin
    instanceID:instanceID
    acceptLanguage:acceptLanguage
    $format:$format
              completionHandler: ^(WorkflowLogs output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InboxApiForNeo = require('inbox_api_for_neo');
var defaultClient = InboxApiForNeo.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuthentication
var BasicAuthentication = defaultClient.authentications['BasicAuthentication'];
BasicAuthentication.username = 'YOUR USERNAME'
BasicAuthentication.password = 'YOUR PASSWORD'

// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
var Oauth2_AuthorizationCode = defaultClient.authentications['Oauth2_AuthorizationCode'];
Oauth2_AuthorizationCode.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
var Oauth2_ClientCredentials = defaultClient.authentications['Oauth2_ClientCredentials'];
Oauth2_ClientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new InboxApiForNeo.TaskCollectionApi()

var sAPOrigin = sAPOrigin_example; // {String} The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).

var instanceID = instanceID_example; // {String} The ID of the task.

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} Provide a preferred language. If a translation is available, relevant texts are returned in this language.
  '$format': $format_example // {String} Specify the format of the result. 
};

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

namespace Example
{
    public class taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDWorkflowLogsGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuthentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TaskCollectionApi();
            var sAPOrigin = sAPOrigin_example;  // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
            var instanceID = instanceID_example;  // String | The ID of the task.
            var acceptLanguage = acceptLanguage_example;  // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional) 
            var $format = $format_example;  // String | Specify the format of the result.  (optional)  (default to xml)

            try
            {
                // Retrieves the history of the workflow for the given task
                WorkflowLogs result = apiInstance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDWorkflowLogsGet(sAPOrigin, instanceID, acceptLanguage, $format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskCollectionApi.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDWorkflowLogsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\TaskCollectionApi();
$sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
$instanceID = instanceID_example; // String | The ID of the task.
$acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
$$format = $format_example; // String | Specify the format of the result. 

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

# Configure HTTP basic authorization: BasicAuthentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TaskCollectionApi->new();
my $sAPOrigin = sAPOrigin_example; # String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
my $instanceID = instanceID_example; # String | The ID of the task.
my $acceptLanguage = acceptLanguage_example; # String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
my $$format = $format_example; # String | Specify the format of the result. 

eval { 
    my $result = $api_instance->taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDWorkflowLogsGet(sAPOrigin => $sAPOrigin, instanceID => $instanceID, acceptLanguage => $acceptLanguage, $format => $$format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaskCollectionApi->taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDWorkflowLogsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TaskCollectionApi()
sAPOrigin = sAPOrigin_example # String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
instanceID = instanceID_example # String | The ID of the task.
acceptLanguage = acceptLanguage_example # String | Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional)
$format = $format_example # String | Specify the format of the result.  (optional) (default to xml)

try: 
    # Retrieves the history of the workflow for the given task
    api_response = api_instance.taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDWorkflowLogsGet(sAPOrigin, instanceID, acceptLanguage=acceptLanguage, $format=$format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaskCollectionApi->taskCollectionSAPOriginSAPOriginInstanceIDInstanceIDWorkflowLogsGet: %s\n" % e)

Parameters

Path parameters
Name Description
SAP__Origin*
InstanceID*
Header parameters
Name Description
Accept-Language
Query parameters
Name Description
$format

Responses

Status: 200 - Returns the workflow logs for a given task.

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

{error={code=TASK_BAD_REQUEST, message={lang=en, value=An error occured: 400 Bad Request}}}

Status: 401 - Unauthorized. Please provide valid authentication credentials to access the resource.

{error=unauthorized, error_description=Full authentication is required to access this resource.}

Status: 403 - The user who sent the request is not authorized to access the requested data or to perform the requested action.

{error={code=TASK_USER_NOT_AUTHORIZED, message={lang=en, value=An error occured: 403 Forbidden}}}

Status: 404 - The requested object could not be found.

{error={code=TASK_NOT_FOUND, message={lang=en, value=An error occured: 404 Not Found}}}

Status: 405 - The action to be executed is not supported by the OData service.

{error={message={lang=en, value=An error occured: 405 Method Not Allowed}}}

Status: 406 - The requested object cannot be returned in the specified format according to the accept headers.

{error={message={lang=en, value=An error occured: 406 Not Acceptable}}}

Status: 500 - An error occurred while processing the request.

{error={code=TASK_INVALID_STATE_TRANSITION, message={lang=en, value=An error occured: 500 Internal Server Error}}}

/TaskCollection/$count

Retrieves the number of tasks for the current user. The request can be parameterized.


/TaskCollection/$count

Usage

curl -X GET -H "Accept: application/json,application/xml" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://sandbox.api.sap.com/workflow-service/odata/v1/tcm/TaskCollection/$count?$filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskCollectionApi;

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

public class TaskCollectionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuthentication
        HttpBasicAuth BasicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuthentication");
        BasicAuthentication.setUsername("YOUR USERNAME");
        BasicAuthentication.setPassword("YOUR PASSWORD");

        // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
        OAuth Oauth2_AuthorizationCode = (OAuth) defaultClient.getAuthentication("Oauth2_AuthorizationCode");
        Oauth2_AuthorizationCode.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
        OAuth Oauth2_ClientCredentials = (OAuth) defaultClient.getAuthentication("Oauth2_ClientCredentials");
        Oauth2_ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        TaskCollectionApi apiInstance = new TaskCollectionApi();
        String $filter = $filter_example; // String | Specify the filter attribute for tasks using the following format: $filter=attribute eq 'value'. 

Filtering on 'CreatedOn' and 'CompletionDeadline' supports the greater-equal ('ge') and lower-equal ('le') operator. All other attributes only support filtering on equality ('eq'). 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'READY' and Priority eq 'HIGH'`).

Filtering the TaskDefinitionID, Status, Priority, and PriorityNumber attributes supports multiple values that are combined with 'or' (for example: `Status eq 'READY' or Status eq 'RESERVED'`).
        try {
            'Integer' result = apiInstance.taskCollectioncountGet($filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskCollectionApi#taskCollectioncountGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskCollectionApi;

public class TaskCollectionApiExample {

    public static void main(String[] args) {
        TaskCollectionApi apiInstance = new TaskCollectionApi();
        String $filter = $filter_example; // String | Specify the filter attribute for tasks using the following format: $filter=attribute eq 'value'. 

Filtering on 'CreatedOn' and 'CompletionDeadline' supports the greater-equal ('ge') and lower-equal ('le') operator. All other attributes only support filtering on equality ('eq'). 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'READY' and Priority eq 'HIGH'`).

Filtering the TaskDefinitionID, Status, Priority, and PriorityNumber attributes supports multiple values that are combined with 'or' (for example: `Status eq 'READY' or Status eq 'RESERVED'`).
        try {
            'Integer' result = apiInstance.taskCollectioncountGet($filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskCollectionApi#taskCollectioncountGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_AuthorizationCode)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_ClientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *$filter = $filter_example; // Specify the filter attribute for tasks using the following format: $filter=attribute eq 'value'. 

Filtering on 'CreatedOn' and 'CompletionDeadline' supports the greater-equal ('ge') and lower-equal ('le') operator. All other attributes only support filtering on equality ('eq'). 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'READY' and Priority eq 'HIGH'`).

Filtering the TaskDefinitionID, Status, Priority, and PriorityNumber attributes supports multiple values that are combined with 'or' (for example: `Status eq 'READY' or Status eq 'RESERVED'`). (optional) (default to Status eq 'READY' or Status eq 'RESERVED')

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

// Retrieves the number of the tasks for the current user.
[apiInstance taskCollectioncountGetWith:$filter
              completionHandler: ^('Integer' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InboxApiForNeo = require('inbox_api_for_neo');
var defaultClient = InboxApiForNeo.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuthentication
var BasicAuthentication = defaultClient.authentications['BasicAuthentication'];
BasicAuthentication.username = 'YOUR USERNAME'
BasicAuthentication.password = 'YOUR PASSWORD'

// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
var Oauth2_AuthorizationCode = defaultClient.authentications['Oauth2_AuthorizationCode'];
Oauth2_AuthorizationCode.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
var Oauth2_ClientCredentials = defaultClient.authentications['Oauth2_ClientCredentials'];
Oauth2_ClientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new InboxApiForNeo.TaskCollectionApi()

var opts = { 
  '$filter': $filter_example // {String} Specify the filter attribute for tasks using the following format: $filter=attribute eq 'value'. 

Filtering on 'CreatedOn' and 'CompletionDeadline' supports the greater-equal ('ge') and lower-equal ('le') operator. All other attributes only support filtering on equality ('eq'). 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'READY' and Priority eq 'HIGH'`).

Filtering the TaskDefinitionID, Status, Priority, and PriorityNumber attributes supports multiple values that are combined with 'or' (for example: `Status eq 'READY' or Status eq 'RESERVED'`).
};

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

namespace Example
{
    public class taskCollectioncountGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuthentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TaskCollectionApi();
            var $filter = $filter_example;  // String | Specify the filter attribute for tasks using the following format: $filter=attribute eq 'value'. 

Filtering on 'CreatedOn' and 'CompletionDeadline' supports the greater-equal ('ge') and lower-equal ('le') operator. All other attributes only support filtering on equality ('eq'). 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'READY' and Priority eq 'HIGH'`).

Filtering the TaskDefinitionID, Status, Priority, and PriorityNumber attributes supports multiple values that are combined with 'or' (for example: `Status eq 'READY' or Status eq 'RESERVED'`). (optional)  (default to Status eq 'READY' or Status eq 'RESERVED')

            try
            {
                // Retrieves the number of the tasks for the current user.
                'Integer' result = apiInstance.taskCollectioncountGet($filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskCollectionApi.taskCollectioncountGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\TaskCollectionApi();
$$filter = $filter_example; // String | Specify the filter attribute for tasks using the following format: $filter=attribute eq 'value'. 

Filtering on 'CreatedOn' and 'CompletionDeadline' supports the greater-equal ('ge') and lower-equal ('le') operator. All other attributes only support filtering on equality ('eq'). 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'READY' and Priority eq 'HIGH'`).

Filtering the TaskDefinitionID, Status, Priority, and PriorityNumber attributes supports multiple values that are combined with 'or' (for example: `Status eq 'READY' or Status eq 'RESERVED'`).

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

# Configure HTTP basic authorization: BasicAuthentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TaskCollectionApi->new();
my $$filter = $filter_example; # String | Specify the filter attribute for tasks using the following format: $filter=attribute eq 'value'. 

Filtering on 'CreatedOn' and 'CompletionDeadline' supports the greater-equal ('ge') and lower-equal ('le') operator. All other attributes only support filtering on equality ('eq'). 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'READY' and Priority eq 'HIGH'`).

Filtering the TaskDefinitionID, Status, Priority, and PriorityNumber attributes supports multiple values that are combined with 'or' (for example: `Status eq 'READY' or Status eq 'RESERVED'`).

eval { 
    my $result = $api_instance->taskCollectioncountGet($filter => $$filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaskCollectionApi->taskCollectioncountGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TaskCollectionApi()
$filter = $filter_example # String | Specify the filter attribute for tasks using the following format: $filter=attribute eq 'value'. 

Filtering on 'CreatedOn' and 'CompletionDeadline' supports the greater-equal ('ge') and lower-equal ('le') operator. All other attributes only support filtering on equality ('eq'). 

Multiple filters on different attributes can be combined with 'and' (for example: `Status eq 'READY' and Priority eq 'HIGH'`).

Filtering the TaskDefinitionID, Status, Priority, and PriorityNumber attributes supports multiple values that are combined with 'or' (for example: `Status eq 'READY' or Status eq 'RESERVED'`). (optional) (default to Status eq 'READY' or Status eq 'RESERVED')

try: 
    # Retrieves the number of the tasks for the current user.
    api_response = api_instance.taskCollectioncountGet($filter=$filter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaskCollectionApi->taskCollectioncountGet: %s\n" % e)

Parameters

Query parameters
Name Description
$filter

Responses

Status: 200 - Returns the number of task instances for the current user.

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

{error={code=TASK_BAD_REQUEST, message={lang=en, value=An error occured: 400 Bad Request}}}

Status: 401 - Unauthorized. Please provide valid authentication credentials to access the resource.

{error=unauthorized, error_description=Full authentication is required to access this resource.}

Status: 403 - The user who sent the request is not authorized to access the requested data or to perform the requested action.

{error={code=TASK_USER_NOT_AUTHORIZED, message={lang=en, value=An error occured: 403 Forbidden}}}

Status: 404 - The requested object could not be found.

{error={code=TASK_NOT_FOUND, message={lang=en, value=An error occured: 404 Not Found}}}

Status: 405 - The action to be executed is not supported by the OData service.

{error={message={lang=en, value=An error occured: 405 Method Not Allowed}}}

Status: 406 - The requested object cannot be returned in the specified format according to the accept headers.

{error={message={lang=en, value=An error occured: 406 Not Acceptable}}}

Status: 500 - An error occurred while processing the request.

{error={code=TASK_INVALID_STATE_TRANSITION, message={lang=en, value=An error occured: 500 Internal Server Error}}}

TaskDefinitionCollection

/TaskDefinitionCollection

Retrieves a list of the task definitions for the current user.


/TaskDefinitionCollection

Usage

curl -X GET -H "Accept: application/json,application/xml" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://sandbox.api.sap.com/workflow-service/odata/v1/tcm/TaskDefinitionCollection"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskDefinitionCollectionApi;

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

public class TaskDefinitionCollectionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuthentication
        HttpBasicAuth BasicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuthentication");
        BasicAuthentication.setUsername("YOUR USERNAME");
        BasicAuthentication.setPassword("YOUR PASSWORD");

        // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
        OAuth Oauth2_AuthorizationCode = (OAuth) defaultClient.getAuthentication("Oauth2_AuthorizationCode");
        Oauth2_AuthorizationCode.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
        OAuth Oauth2_ClientCredentials = (OAuth) defaultClient.getAuthentication("Oauth2_ClientCredentials");
        Oauth2_ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        TaskDefinitionCollectionApi apiInstance = new TaskDefinitionCollectionApi();
        String acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
        try {
            TaskDefinitions result = apiInstance.taskDefinitionCollectionGet(acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskDefinitionCollectionApi#taskDefinitionCollectionGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskDefinitionCollectionApi;

public class TaskDefinitionCollectionApiExample {

    public static void main(String[] args) {
        TaskDefinitionCollectionApi apiInstance = new TaskDefinitionCollectionApi();
        String acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
        try {
            TaskDefinitions result = apiInstance.taskDefinitionCollectionGet(acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskDefinitionCollectionApi#taskDefinitionCollectionGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_AuthorizationCode)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_ClientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *acceptLanguage = acceptLanguage_example; // Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional)

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

// Retrieves a list of the task definitions for the current user
[apiInstance taskDefinitionCollectionGetWith:acceptLanguage
              completionHandler: ^(TaskDefinitions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InboxApiForNeo = require('inbox_api_for_neo');
var defaultClient = InboxApiForNeo.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuthentication
var BasicAuthentication = defaultClient.authentications['BasicAuthentication'];
BasicAuthentication.username = 'YOUR USERNAME'
BasicAuthentication.password = 'YOUR PASSWORD'

// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
var Oauth2_AuthorizationCode = defaultClient.authentications['Oauth2_AuthorizationCode'];
Oauth2_AuthorizationCode.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
var Oauth2_ClientCredentials = defaultClient.authentications['Oauth2_ClientCredentials'];
Oauth2_ClientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new InboxApiForNeo.TaskDefinitionCollectionApi()

var opts = { 
  'acceptLanguage': acceptLanguage_example // {String} Provide a preferred language. If a translation is available, relevant texts are returned in this language.
};

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

namespace Example
{
    public class taskDefinitionCollectionGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuthentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TaskDefinitionCollectionApi();
            var acceptLanguage = acceptLanguage_example;  // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional) 

            try
            {
                // Retrieves a list of the task definitions for the current user
                TaskDefinitions result = apiInstance.taskDefinitionCollectionGet(acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskDefinitionCollectionApi.taskDefinitionCollectionGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\TaskDefinitionCollectionApi();
$acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.

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

# Configure HTTP basic authorization: BasicAuthentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TaskDefinitionCollectionApi->new();
my $acceptLanguage = acceptLanguage_example; # String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.

eval { 
    my $result = $api_instance->taskDefinitionCollectionGet(acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaskDefinitionCollectionApi->taskDefinitionCollectionGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TaskDefinitionCollectionApi()
acceptLanguage = acceptLanguage_example # String | Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional)

try: 
    # Retrieves a list of the task definitions for the current user
    api_response = api_instance.taskDefinitionCollectionGet(acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaskDefinitionCollectionApi->taskDefinitionCollectionGet: %s\n" % e)

Parameters

Header parameters
Name Description
Accept-Language

Responses

Status: 200 - Returns a list of task definitions for the current user.

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

{error={code=TASK_BAD_REQUEST, message={lang=en, value=An error occured: 400 Bad Request}}}

Status: 401 - Unauthorized. Please provide valid authentication credentials to access the resource.

{error=unauthorized, error_description=Full authentication is required to access this resource.}

Status: 403 - The user who sent the request is not authorized to access the requested data or to perform the requested action.

{error={code=TASK_USER_NOT_AUTHORIZED, message={lang=en, value=An error occured: 403 Forbidden}}}

Status: 404 - The requested object could not be found.

{error={code=TASK_NOT_FOUND, message={lang=en, value=An error occured: 404 Not Found}}}

Status: 405 - The action to be executed is not supported by the OData service.

{error={message={lang=en, value=An error occured: 405 Method Not Allowed}}}

Status: 406 - The requested object cannot be returned in the specified format according to the accept headers.

{error={message={lang=en, value=An error occured: 406 Not Acceptable}}}

Status: 500 - An error occurred while processing the request.

{error={code=TASK_INVALID_STATE_TRANSITION, message={lang=en, value=An error occured: 500 Internal Server Error}}}

/TaskDefinitionCollection(SAP__Origin=%27{SAP__Origin}%27,TaskDefinitionID=%27{TaskDefinitionID}%27)/CustomAttributeDefinitionData

Retrieves a list of custom attributes for a task definition.


/TaskDefinitionCollection(SAP__Origin=%27{SAP__Origin}%27,TaskDefinitionID=%27{TaskDefinitionID}%27)/CustomAttributeDefinitionData

Usage

curl -X GET -H "Accept: application/json,application/xml" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://sandbox.api.sap.com/workflow-service/odata/v1/tcm/TaskDefinitionCollection(SAP__Origin=%27{SAP__Origin}%27,TaskDefinitionID=%27{TaskDefinitionID}%27)/CustomAttributeDefinitionData?$format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskDefinitionCollectionApi;

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

public class TaskDefinitionCollectionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuthentication
        HttpBasicAuth BasicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuthentication");
        BasicAuthentication.setUsername("YOUR USERNAME");
        BasicAuthentication.setPassword("YOUR PASSWORD");

        // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
        OAuth Oauth2_AuthorizationCode = (OAuth) defaultClient.getAuthentication("Oauth2_AuthorizationCode");
        Oauth2_AuthorizationCode.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
        OAuth Oauth2_ClientCredentials = (OAuth) defaultClient.getAuthentication("Oauth2_ClientCredentials");
        Oauth2_ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        TaskDefinitionCollectionApi apiInstance = new TaskDefinitionCollectionApi();
        String sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
        String taskDefinitionID = taskDefinitionID_example; // String | The ID of the task definition.
        String acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
        String $format = $format_example; // String | Specify the format of the result. 
        try {
            TaskCustomAttributeDefinitions result = apiInstance.taskDefinitionCollectionSAPOriginSAPOriginTaskDefinitionIDTaskDefinitionIDCustomAttributeDefinitionDataGet(sAPOrigin, taskDefinitionID, acceptLanguage, $format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskDefinitionCollectionApi#taskDefinitionCollectionSAPOriginSAPOriginTaskDefinitionIDTaskDefinitionIDCustomAttributeDefinitionDataGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskDefinitionCollectionApi;

public class TaskDefinitionCollectionApiExample {

    public static void main(String[] args) {
        TaskDefinitionCollectionApi apiInstance = new TaskDefinitionCollectionApi();
        String sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
        String taskDefinitionID = taskDefinitionID_example; // String | The ID of the task definition.
        String acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
        String $format = $format_example; // String | Specify the format of the result. 
        try {
            TaskCustomAttributeDefinitions result = apiInstance.taskDefinitionCollectionSAPOriginSAPOriginTaskDefinitionIDTaskDefinitionIDCustomAttributeDefinitionDataGet(sAPOrigin, taskDefinitionID, acceptLanguage, $format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskDefinitionCollectionApi#taskDefinitionCollectionSAPOriginSAPOriginTaskDefinitionIDTaskDefinitionIDCustomAttributeDefinitionDataGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_AuthorizationCode)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_ClientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *sAPOrigin = sAPOrigin_example; // The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
String *taskDefinitionID = taskDefinitionID_example; // The ID of the task definition.
String *acceptLanguage = acceptLanguage_example; // Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional)
String *$format = $format_example; // Specify the format of the result.  (optional) (default to xml)

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

// Retrieves a list of custom attributes for a task definition
[apiInstance taskDefinitionCollectionSAPOriginSAPOriginTaskDefinitionIDTaskDefinitionIDCustomAttributeDefinitionDataGetWith:sAPOrigin
    taskDefinitionID:taskDefinitionID
    acceptLanguage:acceptLanguage
    $format:$format
              completionHandler: ^(TaskCustomAttributeDefinitions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InboxApiForNeo = require('inbox_api_for_neo');
var defaultClient = InboxApiForNeo.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuthentication
var BasicAuthentication = defaultClient.authentications['BasicAuthentication'];
BasicAuthentication.username = 'YOUR USERNAME'
BasicAuthentication.password = 'YOUR PASSWORD'

// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
var Oauth2_AuthorizationCode = defaultClient.authentications['Oauth2_AuthorizationCode'];
Oauth2_AuthorizationCode.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
var Oauth2_ClientCredentials = defaultClient.authentications['Oauth2_ClientCredentials'];
Oauth2_ClientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new InboxApiForNeo.TaskDefinitionCollectionApi()

var sAPOrigin = sAPOrigin_example; // {String} The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).

var taskDefinitionID = taskDefinitionID_example; // {String} The ID of the task definition.

var opts = { 
  'acceptLanguage': acceptLanguage_example, // {String} Provide a preferred language. If a translation is available, relevant texts are returned in this language.
  '$format': $format_example // {String} Specify the format of the result. 
};

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

namespace Example
{
    public class taskDefinitionCollectionSAPOriginSAPOriginTaskDefinitionIDTaskDefinitionIDCustomAttributeDefinitionDataGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuthentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TaskDefinitionCollectionApi();
            var sAPOrigin = sAPOrigin_example;  // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
            var taskDefinitionID = taskDefinitionID_example;  // String | The ID of the task definition.
            var acceptLanguage = acceptLanguage_example;  // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional) 
            var $format = $format_example;  // String | Specify the format of the result.  (optional)  (default to xml)

            try
            {
                // Retrieves a list of custom attributes for a task definition
                TaskCustomAttributeDefinitions result = apiInstance.taskDefinitionCollectionSAPOriginSAPOriginTaskDefinitionIDTaskDefinitionIDCustomAttributeDefinitionDataGet(sAPOrigin, taskDefinitionID, acceptLanguage, $format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskDefinitionCollectionApi.taskDefinitionCollectionSAPOriginSAPOriginTaskDefinitionIDTaskDefinitionIDCustomAttributeDefinitionDataGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\TaskDefinitionCollectionApi();
$sAPOrigin = sAPOrigin_example; // String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
$taskDefinitionID = taskDefinitionID_example; // String | The ID of the task definition.
$acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
$$format = $format_example; // String | Specify the format of the result. 

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

# Configure HTTP basic authorization: BasicAuthentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TaskDefinitionCollectionApi->new();
my $sAPOrigin = sAPOrigin_example; # String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
my $taskDefinitionID = taskDefinitionID_example; # String | The ID of the task definition.
my $acceptLanguage = acceptLanguage_example; # String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
my $$format = $format_example; # String | Specify the format of the result. 

eval { 
    my $result = $api_instance->taskDefinitionCollectionSAPOriginSAPOriginTaskDefinitionIDTaskDefinitionIDCustomAttributeDefinitionDataGet(sAPOrigin => $sAPOrigin, taskDefinitionID => $taskDefinitionID, acceptLanguage => $acceptLanguage, $format => $$format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaskDefinitionCollectionApi->taskDefinitionCollectionSAPOriginSAPOriginTaskDefinitionIDTaskDefinitionIDCustomAttributeDefinitionDataGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TaskDefinitionCollectionApi()
sAPOrigin = sAPOrigin_example # String | The SID discriminator. Set to 'NA' for all entities. For more information, see the Task Consumption Model documentation in SAP Note [2304317](https://launchpad.support.sap.com/#/notes/2304317/E).
taskDefinitionID = taskDefinitionID_example # String | The ID of the task definition.
acceptLanguage = acceptLanguage_example # String | Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional)
$format = $format_example # String | Specify the format of the result.  (optional) (default to xml)

try: 
    # Retrieves a list of custom attributes for a task definition
    api_response = api_instance.taskDefinitionCollectionSAPOriginSAPOriginTaskDefinitionIDTaskDefinitionIDCustomAttributeDefinitionDataGet(sAPOrigin, taskDefinitionID, acceptLanguage=acceptLanguage, $format=$format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaskDefinitionCollectionApi->taskDefinitionCollectionSAPOriginSAPOriginTaskDefinitionIDTaskDefinitionIDCustomAttributeDefinitionDataGet: %s\n" % e)

Parameters

Path parameters
Name Description
SAP__Origin*
TaskDefinitionID*
Header parameters
Name Description
Accept-Language
Query parameters
Name Description
$format

Responses

Status: 200 - Returns a list of custom attributes for a task definition.

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

{error={code=TASK_BAD_REQUEST, message={lang=en, value=An error occured: 400 Bad Request}}}

Status: 401 - Unauthorized. Please provide valid authentication credentials to access the resource.

{error=unauthorized, error_description=Full authentication is required to access this resource.}

Status: 403 - The user who sent the request is not authorized to access the requested data or to perform the requested action.

{error={code=TASK_USER_NOT_AUTHORIZED, message={lang=en, value=An error occured: 403 Forbidden}}}

Status: 404 - The requested object could not be found.

{error={code=TASK_NOT_FOUND, message={lang=en, value=An error occured: 404 Not Found}}}

Status: 405 - The action to be executed is not supported by the OData service.

{error={message={lang=en, value=An error occured: 405 Method Not Allowed}}}

Status: 406 - The requested object cannot be returned in the specified format according to the accept headers.

{error={message={lang=en, value=An error occured: 406 Not Acceptable}}}

Status: 500 - An error occurred while processing the request.

{error={code=TASK_INVALID_STATE_TRANSITION, message={lang=en, value=An error occured: 500 Internal Server Error}}}

/TaskDefinitionCollection/$count

Retrieves the number of task definitions for the current user.


/TaskDefinitionCollection/$count

Usage

curl -X GET -H "Accept: application/json,application/xml" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://sandbox.api.sap.com/workflow-service/odata/v1/tcm/TaskDefinitionCollection/$count"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskDefinitionCollectionApi;

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

public class TaskDefinitionCollectionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuthentication
        HttpBasicAuth BasicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuthentication");
        BasicAuthentication.setUsername("YOUR USERNAME");
        BasicAuthentication.setPassword("YOUR PASSWORD");

        // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
        OAuth Oauth2_AuthorizationCode = (OAuth) defaultClient.getAuthentication("Oauth2_AuthorizationCode");
        Oauth2_AuthorizationCode.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
        OAuth Oauth2_ClientCredentials = (OAuth) defaultClient.getAuthentication("Oauth2_ClientCredentials");
        Oauth2_ClientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        TaskDefinitionCollectionApi apiInstance = new TaskDefinitionCollectionApi();
        try {
            'Integer' result = apiInstance.taskDefinitionCollectioncountGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskDefinitionCollectionApi#taskDefinitionCollectioncountGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskDefinitionCollectionApi;

public class TaskDefinitionCollectionApiExample {

    public static void main(String[] args) {
        TaskDefinitionCollectionApi apiInstance = new TaskDefinitionCollectionApi();
        try {
            'Integer' result = apiInstance.taskDefinitionCollectioncountGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskDefinitionCollectionApi#taskDefinitionCollectioncountGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuthentication)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_AuthorizationCode)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Configure OAuth2 access token for authorization: (authentication scheme: Oauth2_ClientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


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

// Retrieves the number of task definitions for the current user
[apiInstance taskDefinitionCollectioncountGetWithCompletionHandler: 
              ^('Integer' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InboxApiForNeo = require('inbox_api_for_neo');
var defaultClient = InboxApiForNeo.ApiClient.instance;

// Configure HTTP basic authorization: BasicAuthentication
var BasicAuthentication = defaultClient.authentications['BasicAuthentication'];
BasicAuthentication.username = 'YOUR USERNAME'
BasicAuthentication.password = 'YOUR PASSWORD'

// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
var Oauth2_AuthorizationCode = defaultClient.authentications['Oauth2_AuthorizationCode'];
Oauth2_AuthorizationCode.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
var Oauth2_ClientCredentials = defaultClient.authentications['Oauth2_ClientCredentials'];
Oauth2_ClientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new InboxApiForNeo.TaskDefinitionCollectionApi()

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

namespace Example
{
    public class taskDefinitionCollectioncountGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BasicAuthentication
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TaskDefinitionCollectionApi();

            try
            {
                // Retrieves the number of task definitions for the current user
                'Integer' result = apiInstance.taskDefinitionCollectioncountGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskDefinitionCollectionApi.taskDefinitionCollectioncountGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuthentication
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\TaskDefinitionCollectionApi();

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

# Configure HTTP basic authorization: BasicAuthentication
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TaskDefinitionCollectionApi->new();

eval { 
    my $result = $api_instance->taskDefinitionCollectioncountGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaskDefinitionCollectionApi->taskDefinitionCollectioncountGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuthentication
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: Oauth2_AuthorizationCode
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: Oauth2_ClientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TaskDefinitionCollectionApi()

try: 
    # Retrieves the number of task definitions for the current user
    api_response = api_instance.taskDefinitionCollectioncountGet()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaskDefinitionCollectionApi->taskDefinitionCollectioncountGet: %s\n" % e)

Parameters

Responses

Status: 200 - Returns the number of task definitions for the current user.

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

{error={code=TASK_BAD_REQUEST, message={lang=en, value=An error occured: 400 Bad Request}}}

Status: 401 - Unauthorized. Please provide valid authentication credentials to access the resource.

{error=unauthorized, error_description=Full authentication is required to access this resource.}

Status: 403 - The user who sent the request is not authorized to access the requested data or to perform the requested action.

{error={code=TASK_USER_NOT_AUTHORIZED, message={lang=en, value=An error occured: 403 Forbidden}}}

Status: 404 - The requested object could not be found.

{error={code=TASK_NOT_FOUND, message={lang=en, value=An error occured: 404 Not Found}}}

Status: 405 - The action to be executed is not supported by the OData service.

{error={message={lang=en, value=An error occured: 405 Method Not Allowed}}}

Status: 406 - The requested object cannot be returned in the specified format according to the accept headers.

{error={message={lang=en, value=An error occured: 406 Not Acceptable}}}

Status: 500 - An error occurred while processing the request.