Retrieves a list of the tasks for the current user. The request can be parameterized.
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'`).
You can only filter the Status attribute using the 'READY', 'RESERVED', 'IN_PROGRESS', and 'EXECUTED' values for comparison with the 'eq' operator. Note: 'IN_PROGRESS' and 'EXECUTED' are supported, but no tasks have this value for the Status attribute. Other SAP workflow systems that implement the same API also support the 'COMPLETED' and 'FOR_RESUBMISSION' attribute values. If you refer to these, or any other value not mentioned previously, the request fails with HTTP response code 400.
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'`).
You can only filter the Status attribute using the 'READY', 'RESERVED', 'IN_PROGRESS', and 'EXECUTED' values for comparison with the 'eq' operator. Note: 'IN_PROGRESS' and 'EXECUTED' are supported, but no tasks have this value for the Status attribute. Other SAP workflow systems that implement the same API also support the 'COMPLETED' and 'FOR_RESUBMISSION' attribute values. If you refer to these, or any other value not mentioned previously, the request fails with HTTP response code 400.
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'`).
You can only filter the Status attribute using the 'READY', 'RESERVED', 'IN_PROGRESS', and 'EXECUTED' values for comparison with the 'eq' operator. Note: 'IN_PROGRESS' and 'EXECUTED' are supported, but no tasks have this value for the Status attribute. Other SAP workflow systems that implement the same API also support the 'COMPLETED' and 'FOR_RESUBMISSION' attribute values. If you refer to these, or any other value not mentioned previously, the request fails with HTTP response code 400.
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'`).
You can only filter the Status attribute using the 'READY', 'RESERVED', 'IN_PROGRESS', and 'EXECUTED' values for comparison with the 'eq' operator. Note: 'IN_PROGRESS' and 'EXECUTED' are supported, but no tasks have this value for the Status attribute. Other SAP workflow systems that implement the same API also support the 'COMPLETED' and 'FOR_RESUBMISSION' attribute values. If you refer to these, or any other value not mentioned previously, the request fails with HTTP response code 400.
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'`).
You can only filter the Status attribute using the 'READY', 'RESERVED', 'IN_PROGRESS', and 'EXECUTED' values for comparison with the 'eq' operator. Note: 'IN_PROGRESS' and 'EXECUTED' are supported, but no tasks have this value for the Status attribute. Other SAP workflow systems that implement the same API also support the 'COMPLETED' and 'FOR_RESUBMISSION' attribute values. If you refer to these, or any other value not mentioned previously, the request fails with HTTP response code 400.
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'`).
You can only filter the Status attribute using the 'READY', 'RESERVED', 'IN_PROGRESS', and 'EXECUTED' values for comparison with the 'eq' operator. Note: 'IN_PROGRESS' and 'EXECUTED' are supported, but no tasks have this value for the Status attribute. Other SAP workflow systems that implement the same API also support the 'COMPLETED' and 'FOR_RESUBMISSION' attribute values. If you refer to these, or any other value not mentioned previously, the request fails with HTTP response code 400.
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'`).
You can only filter the Status attribute using the 'READY', 'RESERVED', 'IN_PROGRESS', and 'EXECUTED' values for comparison with the 'eq' operator. Note: 'IN_PROGRESS' and 'EXECUTED' are supported, but no tasks have this value for the Status attribute. Other SAP workflow systems that implement the same API also support the 'COMPLETED' and 'FOR_RESUBMISSION' attribute values. If you refer to these, or any other value not mentioned previously, the request fails with HTTP response code 400.
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'`).
You can only filter the Status attribute using the 'READY', 'RESERVED', 'IN_PROGRESS', and 'EXECUTED' values for comparison with the 'eq' operator. Note: 'IN_PROGRESS' and 'EXECUTED' are supported, but no tasks have this value for the Status attribute. Other SAP workflow systems that implement the same API also support the 'COMPLETED' and 'FOR_RESUBMISSION' attribute values. If you refer to these, or any other value not mentioned previously, the request fails with HTTP response code 400.
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)