Retrieves user task instances by parameters. If no parameters are specified, all instances with status READY, RESERVED, CANCELED, or COMPLETED are returned.
Parameters for different attributes of the instance are evaluated using the logical 'and' operator. If a parameter is specified multiple times,
results are matched using the logical 'or' operator, unless noted otherwise. Empty parameters are treated as if they were not specified.
By default, returned tasks are sorted by creation time in ascending order.
Roles permitted to execute this operation:
- Global roles: WorkflowViewer, WorkflowAdmin
- Instance-specific roles: viewerUsers, viewerGroups, adminUsers, adminGroups [Prerequisite: You are assigned to the WorkflowParticipant global role.]
curl -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://sandbox.api.sap.com/workflow-service/rest/v1/task-instances?$skip=&$top=&$inlinecount=&$expand=&$orderby=&workflowInstanceId=&workflowDefinitionId=&processor=&id=&activityId=&description=&subject=&createdAt=&createdFrom=&createdUpTo=&claimedAt=&claimedFrom=&claimedUpTo=&completedAt=&completedFrom=&completedUpTo=&lastChangedAt=&lastChangedFrom=&lastChangedUpTo=&dueDate=&dueDateFrom=&dueDateUpTo=&priority=&status=&recipientUsers=&recipientGroups=&containsText=&attributes.ExampleCustomAttribute=&definitionId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserTaskInstancesApi;
import java.io.File;
import java.util.*;
public class UserTaskInstancesApiExample {
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");
UserTaskInstancesApi apiInstance = new UserTaskInstancesApi();
String acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
Integer $skip = 56; // Integer | 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. You can use this parameter only once.
Refer also to the $top parameter.
Integer $top = 56; // Integer | The number of records you want to show.
You can get 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. You can use this parameter only once.
Refer also to the $skip parameter.
String $inlinecount = $inlinecount_example; // String | Specify whether the total count of the task instances, which match the search criteria, should be returned as a value
of the X-Total-Count response header. Note that this header is not approved by default in the Neo HTML5 runtime and must be added to the 'headerWhitelist' attribute of the neo-app.json file. To enable the header, use the 'allpages' setting. To disable the header, use the 'none' setting.
The values are case-sensitive. You can use this parameter only once.
String $expand = $expand_example; // String | You can request custom task attributes to become part of the task output by specifying the value 'attributes' for the '$expand' parameter.
Otherwise, if the '$expand' parameter is not specified, the 'attributes' field is not included into task output. Note that labels as well as the order of the custom task attributes in which they are returned, are taken from the latest versions of the workflow definitions where these attributes are present.
String $orderby = $orderby_example; // String | The attribute and direction by which tasks are sorted. The sort attribute and direction are separated by a space.
The parameter value is case-sensitive. You can only specify one ordering parameter, which contains attribute and direction.
To stabilize the order of tasks the implicit second ordering parameter 'createdAt asc' is applied.
* claimedAt asc - Ascending, task claim time from the oldest to the most recent, tasks with status READY (not yet claimed) first.
* claimedAt desc - Descending, from the most recently claimed tasks to the oldest ones, tasks with status READY (not yet claimed) last.
* completedAt asc - Ascending, task completion or cancelation time from the oldest to the most recent, not yet COMPLETED tasks first.
* completedAt desc - Descending, from the most recently COMPLETED or CANCELED tasks to the oldest ones, not yet COMPLETED tasks last.
* createdAt asc - Ascending, task creation time from the oldest to the most recent.
* createdAt desc - Descending, from the most recently created tasks to the oldest ones.
* lastChangedAt asc - Ascending, task last change time from the oldest to the most recent.
* lastChangedAt desc - Descending, from the most recently changed tasks to the oldest ones.
* dueDate asc - Ascending, tasks due date from the oldest to the most distant in future ones, tasks without due date first.
* dueDate desc - Descending, tasks due date from the most distant in future to the oldest ones, tasks without due date last.
* subject asc - Ascending, from A to Z case-sensitive.
* subject desc - Descending, from Z to A case-sensitive.
* description asc - Ascending, from A to Z case-sensitive, tasks without description first.
* description desc - Descending, from Z to A case-sensitive, tasks without description last.
* activityId asc - Ascending, from A to Z case-sensitive.
* activityId desc - Descending, from Z to A case-sensitive.
* id asc - Ascending, from A to Z case-sensitive.
* id desc - Descending, from Z to A case-sensitive.
* processor asc - Ascending, from A to Z case-sensitive, tasks without processor first.
* processor desc - Descending, from Z to A case-sensitive, tasks without processor last.
* workflowDefinitionId asc - Ascending, from A to Z case-sensitive.
* workflowDefinitionId desc - Descending, from Z to A case-sensitive.
* workflowInstanceId asc - Ascending, from A to Z case-sensitive.
* workflowInstanceId desc - Descending, from Z to A case-sensitive.
* priority asc - Ascending, tasks priority from lowest to highest.
* priority desc - Descending, tasks priority from highest to lowest.
String workflowInstanceId = workflowInstanceId_example; // String | The workflow instance ID for which the user task instances are returned. The workflow instance ID is 36 characters long.
String workflowDefinitionId = workflowDefinitionId_example; // String | The workflow definition ID for which the user task instances are returned.
String processor = processor_example; // String | The processor of the user task instance.
String id = id_example; // String | The unique ID of the user task instance. The user task instance ID is 36 characters long.
String activityId = activityId_example; // String | The activityId of the user task instance. This field represents the ID of the user task definition.
String description = description_example; // String | The description of the user task instance in UTF-8 encoding. You must not specify texts that contain commas with this parameter.
String subject = subject_example; // String | The subject of the user task instance in UTF-8 encoding. You must not specify texts that contain commas with this parameter.
String createdAt = createdAt_example; // String | Time when the user task instance has been created.
Evaluated using the logical 'or' operator with the values of the 'createdFrom' and 'createdUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String createdFrom = createdFrom_example; // String | The start time (inclusive) of the time range when the user task instance was created.
Must be less or equal to the value of the 'createdUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'createdAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String createdUpTo = createdUpTo_example; // String | The end time (inclusive) of the time range when the user task instance was created.
Must be greater or equal to the value of the 'createdFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'createdAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String claimedAt = claimedAt_example; // String | Time when the user task instance was claimed.
Evaluated using the logical 'or' operator with the values of the 'claimedFrom' and 'claimedUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String claimedFrom = claimedFrom_example; // String | The start time (inclusive) of the time range when the user task instance was claimed.
Must be less or equal to the value of the 'claimedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'claimedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String claimedUpTo = claimedUpTo_example; // String | The end time (inclusive) of the time range when the user task instance was claimed.
Must be greater or equal to the value of the 'claimedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'claimedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String completedAt = completedAt_example; // String | Time when the user task instance was COMPLETED or CANCELED.
Evaluated using the logical 'or' operator with the values of the 'completedFrom' and 'completedUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String completedFrom = completedFrom_example; // String | The start time (inclusive) of the time range when the user task instance was COMPLETED or CANCELED.
Must be less or equal to the value of the 'completedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'completedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String completedUpTo = completedUpTo_example; // String | The end time (inclusive) of the time range when the user task instance was COMPLETED or CANCELED.
Must be greater or equal to the value of the 'completedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'completedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String lastChangedAt = lastChangedAt_example; // String | Time when the user task instance has been changed for the last time.
Evaluated using the logical 'or' operator with the values of the 'lastChangedFrom' and 'lastChangedTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String lastChangedFrom = lastChangedFrom_example; // String | The start time (inclusive) of the time range when the user task instance was changed for the last time.
Must be less or equal to the value of the 'lastChangedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'lastChangedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String lastChangedUpTo = lastChangedUpTo_example; // String | The end time (inclusive) of the time range when the user task instance was changed for the last time.
Must be greater or equal to the value of the 'lastChangedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'lastChangedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String dueDate = dueDate_example; // String | The due date of the user task instance.
Evaluated using the logical 'or' operator with the values of the 'dueDateFrom' and 'dueDateUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String dueDateFrom = dueDateFrom_example; // String | The start time (inclusive) of the due date time range for the user task instance.
Must be less or equal to the value of the 'dueDateUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'dueDate' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String dueDateUpTo = dueDateUpTo_example; // String | The end time (inclusive) of the due date time range for the user task instance.
Must be greater or equal to the 'dueDateFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'dueDate' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String priority = priority_example; // String | The priority of the user task instance.
The values are case-insensitive.
String status = status_example; // String | The status of the user task instance.
The values are case-insensitive.
String recipientUsers = recipientUsers_example; // String | The users who must be among the recipient users of the user task instance. A user task instance has to match at least one of the recipient users specified.
Specify the users by repeating this parameter multiple times, with one user each.
String recipientGroups = recipientGroups_example; // String | The groups which must be among the recipient groups of the user task instance. A user task instance has to match at least one of the recipient groups specified.
Specify the groups by repeating this parameter multiple times, with one user each.
String containsText = containsText_example; // String | Text, which should be contained in at least one of the following fields of the user task instance:
* subject
* description
* activityId
* id
* processor
* workflowDefinitionId
* workflowInstanceId
Performed filtering is case-insensitive. You must not use this parameter more than once.
String attributes.ExampleCustomAttribute = attributes.ExampleCustomAttribute_example; // String | Example of a parameter that filters task instances by the value of the custom task attribute with the ID 'ExampleCustomAttribute'.
You can specify parameters for other attributes in an analogous way.
If you specify a parameter several times, the logical operators apply as outlined in the overall description of this API.
If custom task attributes with different IDs are present in the URL, only tasks which contain all of them with the values specified will be returned as a response to the request.
If a query by custom task attributes matches too many task definitions, you have to limit the query further. Refer, for example, to parameter 'definitionId'.
String definitionId = definitionId_example; // String | The definition ID of the user task.
It consists of the ID of the task defined in the workflow definition (task definition ID) as well as the workflow definition ID delimited by an '@' sign.
For optimal performance, specify this parameter when searching for tasks by custom task attributes.
If the custom task attribute IDs from the query match more than 50 task definitions, you have to specify one or more task definition IDs when searching for tasks by custom task attributes.
try {
array[TaskInstance] result = apiInstance.v1TaskInstancesGet(acceptLanguage, $skip, $top, $inlinecount, $expand, $orderby, workflowInstanceId, workflowDefinitionId, processor, id, activityId, description, subject, createdAt, createdFrom, createdUpTo, claimedAt, claimedFrom, claimedUpTo, completedAt, completedFrom, completedUpTo, lastChangedAt, lastChangedFrom, lastChangedUpTo, dueDate, dueDateFrom, dueDateUpTo, priority, status, recipientUsers, recipientGroups, containsText, attributes.ExampleCustomAttribute, definitionId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserTaskInstancesApi#v1TaskInstancesGet");
e.printStackTrace();
}
}
}
import io.swagger.client.api.UserTaskInstancesApi;
public class UserTaskInstancesApiExample {
public static void main(String[] args) {
UserTaskInstancesApi apiInstance = new UserTaskInstancesApi();
String acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
Integer $skip = 56; // Integer | 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. You can use this parameter only once.
Refer also to the $top parameter.
Integer $top = 56; // Integer | The number of records you want to show.
You can get 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. You can use this parameter only once.
Refer also to the $skip parameter.
String $inlinecount = $inlinecount_example; // String | Specify whether the total count of the task instances, which match the search criteria, should be returned as a value
of the X-Total-Count response header. Note that this header is not approved by default in the Neo HTML5 runtime and must be added to the 'headerWhitelist' attribute of the neo-app.json file. To enable the header, use the 'allpages' setting. To disable the header, use the 'none' setting.
The values are case-sensitive. You can use this parameter only once.
String $expand = $expand_example; // String | You can request custom task attributes to become part of the task output by specifying the value 'attributes' for the '$expand' parameter.
Otherwise, if the '$expand' parameter is not specified, the 'attributes' field is not included into task output. Note that labels as well as the order of the custom task attributes in which they are returned, are taken from the latest versions of the workflow definitions where these attributes are present.
String $orderby = $orderby_example; // String | The attribute and direction by which tasks are sorted. The sort attribute and direction are separated by a space.
The parameter value is case-sensitive. You can only specify one ordering parameter, which contains attribute and direction.
To stabilize the order of tasks the implicit second ordering parameter 'createdAt asc' is applied.
* claimedAt asc - Ascending, task claim time from the oldest to the most recent, tasks with status READY (not yet claimed) first.
* claimedAt desc - Descending, from the most recently claimed tasks to the oldest ones, tasks with status READY (not yet claimed) last.
* completedAt asc - Ascending, task completion or cancelation time from the oldest to the most recent, not yet COMPLETED tasks first.
* completedAt desc - Descending, from the most recently COMPLETED or CANCELED tasks to the oldest ones, not yet COMPLETED tasks last.
* createdAt asc - Ascending, task creation time from the oldest to the most recent.
* createdAt desc - Descending, from the most recently created tasks to the oldest ones.
* lastChangedAt asc - Ascending, task last change time from the oldest to the most recent.
* lastChangedAt desc - Descending, from the most recently changed tasks to the oldest ones.
* dueDate asc - Ascending, tasks due date from the oldest to the most distant in future ones, tasks without due date first.
* dueDate desc - Descending, tasks due date from the most distant in future to the oldest ones, tasks without due date last.
* subject asc - Ascending, from A to Z case-sensitive.
* subject desc - Descending, from Z to A case-sensitive.
* description asc - Ascending, from A to Z case-sensitive, tasks without description first.
* description desc - Descending, from Z to A case-sensitive, tasks without description last.
* activityId asc - Ascending, from A to Z case-sensitive.
* activityId desc - Descending, from Z to A case-sensitive.
* id asc - Ascending, from A to Z case-sensitive.
* id desc - Descending, from Z to A case-sensitive.
* processor asc - Ascending, from A to Z case-sensitive, tasks without processor first.
* processor desc - Descending, from Z to A case-sensitive, tasks without processor last.
* workflowDefinitionId asc - Ascending, from A to Z case-sensitive.
* workflowDefinitionId desc - Descending, from Z to A case-sensitive.
* workflowInstanceId asc - Ascending, from A to Z case-sensitive.
* workflowInstanceId desc - Descending, from Z to A case-sensitive.
* priority asc - Ascending, tasks priority from lowest to highest.
* priority desc - Descending, tasks priority from highest to lowest.
String workflowInstanceId = workflowInstanceId_example; // String | The workflow instance ID for which the user task instances are returned. The workflow instance ID is 36 characters long.
String workflowDefinitionId = workflowDefinitionId_example; // String | The workflow definition ID for which the user task instances are returned.
String processor = processor_example; // String | The processor of the user task instance.
String id = id_example; // String | The unique ID of the user task instance. The user task instance ID is 36 characters long.
String activityId = activityId_example; // String | The activityId of the user task instance. This field represents the ID of the user task definition.
String description = description_example; // String | The description of the user task instance in UTF-8 encoding. You must not specify texts that contain commas with this parameter.
String subject = subject_example; // String | The subject of the user task instance in UTF-8 encoding. You must not specify texts that contain commas with this parameter.
String createdAt = createdAt_example; // String | Time when the user task instance has been created.
Evaluated using the logical 'or' operator with the values of the 'createdFrom' and 'createdUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String createdFrom = createdFrom_example; // String | The start time (inclusive) of the time range when the user task instance was created.
Must be less or equal to the value of the 'createdUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'createdAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String createdUpTo = createdUpTo_example; // String | The end time (inclusive) of the time range when the user task instance was created.
Must be greater or equal to the value of the 'createdFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'createdAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String claimedAt = claimedAt_example; // String | Time when the user task instance was claimed.
Evaluated using the logical 'or' operator with the values of the 'claimedFrom' and 'claimedUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String claimedFrom = claimedFrom_example; // String | The start time (inclusive) of the time range when the user task instance was claimed.
Must be less or equal to the value of the 'claimedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'claimedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String claimedUpTo = claimedUpTo_example; // String | The end time (inclusive) of the time range when the user task instance was claimed.
Must be greater or equal to the value of the 'claimedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'claimedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String completedAt = completedAt_example; // String | Time when the user task instance was COMPLETED or CANCELED.
Evaluated using the logical 'or' operator with the values of the 'completedFrom' and 'completedUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String completedFrom = completedFrom_example; // String | The start time (inclusive) of the time range when the user task instance was COMPLETED or CANCELED.
Must be less or equal to the value of the 'completedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'completedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String completedUpTo = completedUpTo_example; // String | The end time (inclusive) of the time range when the user task instance was COMPLETED or CANCELED.
Must be greater or equal to the value of the 'completedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'completedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String lastChangedAt = lastChangedAt_example; // String | Time when the user task instance has been changed for the last time.
Evaluated using the logical 'or' operator with the values of the 'lastChangedFrom' and 'lastChangedTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String lastChangedFrom = lastChangedFrom_example; // String | The start time (inclusive) of the time range when the user task instance was changed for the last time.
Must be less or equal to the value of the 'lastChangedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'lastChangedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String lastChangedUpTo = lastChangedUpTo_example; // String | The end time (inclusive) of the time range when the user task instance was changed for the last time.
Must be greater or equal to the value of the 'lastChangedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'lastChangedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String dueDate = dueDate_example; // String | The due date of the user task instance.
Evaluated using the logical 'or' operator with the values of the 'dueDateFrom' and 'dueDateUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String dueDateFrom = dueDateFrom_example; // String | The start time (inclusive) of the due date time range for the user task instance.
Must be less or equal to the value of the 'dueDateUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'dueDate' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String dueDateUpTo = dueDateUpTo_example; // String | The end time (inclusive) of the due date time range for the user task instance.
Must be greater or equal to the 'dueDateFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'dueDate' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
String priority = priority_example; // String | The priority of the user task instance.
The values are case-insensitive.
String status = status_example; // String | The status of the user task instance.
The values are case-insensitive.
String recipientUsers = recipientUsers_example; // String | The users who must be among the recipient users of the user task instance. A user task instance has to match at least one of the recipient users specified.
Specify the users by repeating this parameter multiple times, with one user each.
String recipientGroups = recipientGroups_example; // String | The groups which must be among the recipient groups of the user task instance. A user task instance has to match at least one of the recipient groups specified.
Specify the groups by repeating this parameter multiple times, with one user each.
String containsText = containsText_example; // String | Text, which should be contained in at least one of the following fields of the user task instance:
* subject
* description
* activityId
* id
* processor
* workflowDefinitionId
* workflowInstanceId
Performed filtering is case-insensitive. You must not use this parameter more than once.
String attributes.ExampleCustomAttribute = attributes.ExampleCustomAttribute_example; // String | Example of a parameter that filters task instances by the value of the custom task attribute with the ID 'ExampleCustomAttribute'.
You can specify parameters for other attributes in an analogous way.
If you specify a parameter several times, the logical operators apply as outlined in the overall description of this API.
If custom task attributes with different IDs are present in the URL, only tasks which contain all of them with the values specified will be returned as a response to the request.
If a query by custom task attributes matches too many task definitions, you have to limit the query further. Refer, for example, to parameter 'definitionId'.
String definitionId = definitionId_example; // String | The definition ID of the user task.
It consists of the ID of the task defined in the workflow definition (task definition ID) as well as the workflow definition ID delimited by an '@' sign.
For optimal performance, specify this parameter when searching for tasks by custom task attributes.
If the custom task attribute IDs from the query match more than 50 task definitions, you have to specify one or more task definition IDs when searching for tasks by custom task attributes.
try {
array[TaskInstance] result = apiInstance.v1TaskInstancesGet(acceptLanguage, $skip, $top, $inlinecount, $expand, $orderby, workflowInstanceId, workflowDefinitionId, processor, id, activityId, description, subject, createdAt, createdFrom, createdUpTo, claimedAt, claimedFrom, claimedUpTo, completedAt, completedFrom, completedUpTo, lastChangedAt, lastChangedFrom, lastChangedUpTo, dueDate, dueDateFrom, dueDateUpTo, priority, status, recipientUsers, recipientGroups, containsText, attributes.ExampleCustomAttribute, definitionId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserTaskInstancesApi#v1TaskInstancesGet");
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)
Integer *$skip = 56; // 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. You can use this parameter only once.
Refer also to the $top parameter. (optional) (default to 0)
Integer *$top = 56; // The number of records you want to show.
You can get 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. You can use this parameter only once.
Refer also to the $skip parameter. (optional) (default to 100)
String *$inlinecount = $inlinecount_example; // Specify whether the total count of the task instances, which match the search criteria, should be returned as a value
of the X-Total-Count response header. Note that this header is not approved by default in the Neo HTML5 runtime and must be added to the 'headerWhitelist' attribute of the neo-app.json file. To enable the header, use the 'allpages' setting. To disable the header, use the 'none' setting.
The values are case-sensitive. You can use this parameter only once. (optional) (default to none)
String *$expand = $expand_example; // You can request custom task attributes to become part of the task output by specifying the value 'attributes' for the '$expand' parameter.
Otherwise, if the '$expand' parameter is not specified, the 'attributes' field is not included into task output. Note that labels as well as the order of the custom task attributes in which they are returned, are taken from the latest versions of the workflow definitions where these attributes are present.
(optional)
String *$orderby = $orderby_example; // The attribute and direction by which tasks are sorted. The sort attribute and direction are separated by a space.
The parameter value is case-sensitive. You can only specify one ordering parameter, which contains attribute and direction.
To stabilize the order of tasks the implicit second ordering parameter 'createdAt asc' is applied.
* claimedAt asc - Ascending, task claim time from the oldest to the most recent, tasks with status READY (not yet claimed) first.
* claimedAt desc - Descending, from the most recently claimed tasks to the oldest ones, tasks with status READY (not yet claimed) last.
* completedAt asc - Ascending, task completion or cancelation time from the oldest to the most recent, not yet COMPLETED tasks first.
* completedAt desc - Descending, from the most recently COMPLETED or CANCELED tasks to the oldest ones, not yet COMPLETED tasks last.
* createdAt asc - Ascending, task creation time from the oldest to the most recent.
* createdAt desc - Descending, from the most recently created tasks to the oldest ones.
* lastChangedAt asc - Ascending, task last change time from the oldest to the most recent.
* lastChangedAt desc - Descending, from the most recently changed tasks to the oldest ones.
* dueDate asc - Ascending, tasks due date from the oldest to the most distant in future ones, tasks without due date first.
* dueDate desc - Descending, tasks due date from the most distant in future to the oldest ones, tasks without due date last.
* subject asc - Ascending, from A to Z case-sensitive.
* subject desc - Descending, from Z to A case-sensitive.
* description asc - Ascending, from A to Z case-sensitive, tasks without description first.
* description desc - Descending, from Z to A case-sensitive, tasks without description last.
* activityId asc - Ascending, from A to Z case-sensitive.
* activityId desc - Descending, from Z to A case-sensitive.
* id asc - Ascending, from A to Z case-sensitive.
* id desc - Descending, from Z to A case-sensitive.
* processor asc - Ascending, from A to Z case-sensitive, tasks without processor first.
* processor desc - Descending, from Z to A case-sensitive, tasks without processor last.
* workflowDefinitionId asc - Ascending, from A to Z case-sensitive.
* workflowDefinitionId desc - Descending, from Z to A case-sensitive.
* workflowInstanceId asc - Ascending, from A to Z case-sensitive.
* workflowInstanceId desc - Descending, from Z to A case-sensitive.
* priority asc - Ascending, tasks priority from lowest to highest.
* priority desc - Descending, tasks priority from highest to lowest. (optional) (default to createdAt asc)
String *workflowInstanceId = workflowInstanceId_example; // The workflow instance ID for which the user task instances are returned. The workflow instance ID is 36 characters long. (optional)
String *workflowDefinitionId = workflowDefinitionId_example; // The workflow definition ID for which the user task instances are returned. (optional)
String *processor = processor_example; // The processor of the user task instance. (optional)
String *id = id_example; // The unique ID of the user task instance. The user task instance ID is 36 characters long. (optional)
String *activityId = activityId_example; // The activityId of the user task instance. This field represents the ID of the user task definition. (optional)
String *description = description_example; // The description of the user task instance in UTF-8 encoding. You must not specify texts that contain commas with this parameter. (optional)
String *subject = subject_example; // The subject of the user task instance in UTF-8 encoding. You must not specify texts that contain commas with this parameter. (optional)
String *createdAt = createdAt_example; // Time when the user task instance has been created.
Evaluated using the logical 'or' operator with the values of the 'createdFrom' and 'createdUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
String *createdFrom = createdFrom_example; // The start time (inclusive) of the time range when the user task instance was created.
Must be less or equal to the value of the 'createdUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'createdAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
String *createdUpTo = createdUpTo_example; // The end time (inclusive) of the time range when the user task instance was created.
Must be greater or equal to the value of the 'createdFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'createdAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
String *claimedAt = claimedAt_example; // Time when the user task instance was claimed.
Evaluated using the logical 'or' operator with the values of the 'claimedFrom' and 'claimedUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
String *claimedFrom = claimedFrom_example; // The start time (inclusive) of the time range when the user task instance was claimed.
Must be less or equal to the value of the 'claimedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'claimedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
String *claimedUpTo = claimedUpTo_example; // The end time (inclusive) of the time range when the user task instance was claimed.
Must be greater or equal to the value of the 'claimedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'claimedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
String *completedAt = completedAt_example; // Time when the user task instance was COMPLETED or CANCELED.
Evaluated using the logical 'or' operator with the values of the 'completedFrom' and 'completedUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
String *completedFrom = completedFrom_example; // The start time (inclusive) of the time range when the user task instance was COMPLETED or CANCELED.
Must be less or equal to the value of the 'completedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'completedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
String *completedUpTo = completedUpTo_example; // The end time (inclusive) of the time range when the user task instance was COMPLETED or CANCELED.
Must be greater or equal to the value of the 'completedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'completedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
String *lastChangedAt = lastChangedAt_example; // Time when the user task instance has been changed for the last time.
Evaluated using the logical 'or' operator with the values of the 'lastChangedFrom' and 'lastChangedTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
String *lastChangedFrom = lastChangedFrom_example; // The start time (inclusive) of the time range when the user task instance was changed for the last time.
Must be less or equal to the value of the 'lastChangedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'lastChangedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
String *lastChangedUpTo = lastChangedUpTo_example; // The end time (inclusive) of the time range when the user task instance was changed for the last time.
Must be greater or equal to the value of the 'lastChangedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'lastChangedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
String *dueDate = dueDate_example; // The due date of the user task instance.
Evaluated using the logical 'or' operator with the values of the 'dueDateFrom' and 'dueDateUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
String *dueDateFrom = dueDateFrom_example; // The start time (inclusive) of the due date time range for the user task instance.
Must be less or equal to the value of the 'dueDateUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'dueDate' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
String *dueDateUpTo = dueDateUpTo_example; // The end time (inclusive) of the due date time range for the user task instance.
Must be greater or equal to the 'dueDateFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'dueDate' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
String *priority = priority_example; // The priority of the user task instance.
The values are case-insensitive.
(optional)
String *status = status_example; // The status of the user task instance.
The values are case-insensitive.
(optional)
String *recipientUsers = recipientUsers_example; // The users who must be among the recipient users of the user task instance. A user task instance has to match at least one of the recipient users specified.
Specify the users by repeating this parameter multiple times, with one user each.
(optional)
String *recipientGroups = recipientGroups_example; // The groups which must be among the recipient groups of the user task instance. A user task instance has to match at least one of the recipient groups specified.
Specify the groups by repeating this parameter multiple times, with one user each.
(optional)
String *containsText = containsText_example; // Text, which should be contained in at least one of the following fields of the user task instance:
* subject
* description
* activityId
* id
* processor
* workflowDefinitionId
* workflowInstanceId
Performed filtering is case-insensitive. You must not use this parameter more than once.
(optional)
String *attributes.ExampleCustomAttribute = attributes.ExampleCustomAttribute_example; // Example of a parameter that filters task instances by the value of the custom task attribute with the ID 'ExampleCustomAttribute'.
You can specify parameters for other attributes in an analogous way.
If you specify a parameter several times, the logical operators apply as outlined in the overall description of this API.
If custom task attributes with different IDs are present in the URL, only tasks which contain all of them with the values specified will be returned as a response to the request.
If a query by custom task attributes matches too many task definitions, you have to limit the query further. Refer, for example, to parameter 'definitionId'.
(optional)
String *definitionId = definitionId_example; // The definition ID of the user task.
It consists of the ID of the task defined in the workflow definition (task definition ID) as well as the workflow definition ID delimited by an '@' sign.
For optimal performance, specify this parameter when searching for tasks by custom task attributes.
If the custom task attribute IDs from the query match more than 50 task definitions, you have to specify one or more task definition IDs when searching for tasks by custom task attributes.
(optional)
UserTaskInstancesApi *apiInstance = [[UserTaskInstancesApi alloc] init];
// Retrieve instances by query parameters
[apiInstance v1TaskInstancesGetWith:acceptLanguage
$skip:$skip
$top:$top
$inlinecount:$inlinecount
$expand:$expand
$orderby:$orderby
workflowInstanceId:workflowInstanceId
workflowDefinitionId:workflowDefinitionId
processor:processor
id:id
activityId:activityId
description:description
subject:subject
createdAt:createdAt
createdFrom:createdFrom
createdUpTo:createdUpTo
claimedAt:claimedAt
claimedFrom:claimedFrom
claimedUpTo:claimedUpTo
completedAt:completedAt
completedFrom:completedFrom
completedUpTo:completedUpTo
lastChangedAt:lastChangedAt
lastChangedFrom:lastChangedFrom
lastChangedUpTo:lastChangedUpTo
dueDate:dueDate
dueDateFrom:dueDateFrom
dueDateUpTo:dueDateUpTo
priority:priority
status:status
recipientUsers:recipientUsers
recipientGroups:recipientGroups
containsText:containsText
attributes.ExampleCustomAttribute:attributes.ExampleCustomAttribute
definitionId:definitionId
completionHandler: ^(array[TaskInstance] output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var WorkflowApiForNeo = require('workflow_api_for_neo');
var defaultClient = WorkflowApiForNeo.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 WorkflowApiForNeo.UserTaskInstancesApi()
var opts = {
'acceptLanguage': acceptLanguage_example, // {String} Provide a preferred language. If a translation is available, relevant texts are returned in this language.
'$skip': 56, // {Integer} 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. You can use this parameter only once.
Refer also to the $top parameter.
'$top': 56, // {Integer} The number of records you want to show.
You can get 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. You can use this parameter only once.
Refer also to the $skip parameter.
'$inlinecount': $inlinecount_example, // {String} Specify whether the total count of the task instances, which match the search criteria, should be returned as a value
of the X-Total-Count response header. Note that this header is not approved by default in the Neo HTML5 runtime and must be added to the 'headerWhitelist' attribute of the neo-app.json file. To enable the header, use the 'allpages' setting. To disable the header, use the 'none' setting.
The values are case-sensitive. You can use this parameter only once.
'$expand': $expand_example, // {String} You can request custom task attributes to become part of the task output by specifying the value 'attributes' for the '$expand' parameter.
Otherwise, if the '$expand' parameter is not specified, the 'attributes' field is not included into task output. Note that labels as well as the order of the custom task attributes in which they are returned, are taken from the latest versions of the workflow definitions where these attributes are present.
'$orderby': $orderby_example, // {String} The attribute and direction by which tasks are sorted. The sort attribute and direction are separated by a space.
The parameter value is case-sensitive. You can only specify one ordering parameter, which contains attribute and direction.
To stabilize the order of tasks the implicit second ordering parameter 'createdAt asc' is applied.
* claimedAt asc - Ascending, task claim time from the oldest to the most recent, tasks with status READY (not yet claimed) first.
* claimedAt desc - Descending, from the most recently claimed tasks to the oldest ones, tasks with status READY (not yet claimed) last.
* completedAt asc - Ascending, task completion or cancelation time from the oldest to the most recent, not yet COMPLETED tasks first.
* completedAt desc - Descending, from the most recently COMPLETED or CANCELED tasks to the oldest ones, not yet COMPLETED tasks last.
* createdAt asc - Ascending, task creation time from the oldest to the most recent.
* createdAt desc - Descending, from the most recently created tasks to the oldest ones.
* lastChangedAt asc - Ascending, task last change time from the oldest to the most recent.
* lastChangedAt desc - Descending, from the most recently changed tasks to the oldest ones.
* dueDate asc - Ascending, tasks due date from the oldest to the most distant in future ones, tasks without due date first.
* dueDate desc - Descending, tasks due date from the most distant in future to the oldest ones, tasks without due date last.
* subject asc - Ascending, from A to Z case-sensitive.
* subject desc - Descending, from Z to A case-sensitive.
* description asc - Ascending, from A to Z case-sensitive, tasks without description first.
* description desc - Descending, from Z to A case-sensitive, tasks without description last.
* activityId asc - Ascending, from A to Z case-sensitive.
* activityId desc - Descending, from Z to A case-sensitive.
* id asc - Ascending, from A to Z case-sensitive.
* id desc - Descending, from Z to A case-sensitive.
* processor asc - Ascending, from A to Z case-sensitive, tasks without processor first.
* processor desc - Descending, from Z to A case-sensitive, tasks without processor last.
* workflowDefinitionId asc - Ascending, from A to Z case-sensitive.
* workflowDefinitionId desc - Descending, from Z to A case-sensitive.
* workflowInstanceId asc - Ascending, from A to Z case-sensitive.
* workflowInstanceId desc - Descending, from Z to A case-sensitive.
* priority asc - Ascending, tasks priority from lowest to highest.
* priority desc - Descending, tasks priority from highest to lowest.
'workflowInstanceId': workflowInstanceId_example, // {String} The workflow instance ID for which the user task instances are returned. The workflow instance ID is 36 characters long.
'workflowDefinitionId': workflowDefinitionId_example, // {String} The workflow definition ID for which the user task instances are returned.
'processor': processor_example, // {String} The processor of the user task instance.
'id': id_example, // {String} The unique ID of the user task instance. The user task instance ID is 36 characters long.
'activityId': activityId_example, // {String} The activityId of the user task instance. This field represents the ID of the user task definition.
'description': description_example, // {String} The description of the user task instance in UTF-8 encoding. You must not specify texts that contain commas with this parameter.
'subject': subject_example, // {String} The subject of the user task instance in UTF-8 encoding. You must not specify texts that contain commas with this parameter.
'createdAt': createdAt_example, // {String} Time when the user task instance has been created.
Evaluated using the logical 'or' operator with the values of the 'createdFrom' and 'createdUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
'createdFrom': createdFrom_example, // {String} The start time (inclusive) of the time range when the user task instance was created.
Must be less or equal to the value of the 'createdUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'createdAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
'createdUpTo': createdUpTo_example, // {String} The end time (inclusive) of the time range when the user task instance was created.
Must be greater or equal to the value of the 'createdFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'createdAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
'claimedAt': claimedAt_example, // {String} Time when the user task instance was claimed.
Evaluated using the logical 'or' operator with the values of the 'claimedFrom' and 'claimedUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
'claimedFrom': claimedFrom_example, // {String} The start time (inclusive) of the time range when the user task instance was claimed.
Must be less or equal to the value of the 'claimedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'claimedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
'claimedUpTo': claimedUpTo_example, // {String} The end time (inclusive) of the time range when the user task instance was claimed.
Must be greater or equal to the value of the 'claimedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'claimedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
'completedAt': completedAt_example, // {String} Time when the user task instance was COMPLETED or CANCELED.
Evaluated using the logical 'or' operator with the values of the 'completedFrom' and 'completedUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
'completedFrom': completedFrom_example, // {String} The start time (inclusive) of the time range when the user task instance was COMPLETED or CANCELED.
Must be less or equal to the value of the 'completedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'completedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
'completedUpTo': completedUpTo_example, // {String} The end time (inclusive) of the time range when the user task instance was COMPLETED or CANCELED.
Must be greater or equal to the value of the 'completedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'completedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
'lastChangedAt': lastChangedAt_example, // {String} Time when the user task instance has been changed for the last time.
Evaluated using the logical 'or' operator with the values of the 'lastChangedFrom' and 'lastChangedTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
'lastChangedFrom': lastChangedFrom_example, // {String} The start time (inclusive) of the time range when the user task instance was changed for the last time.
Must be less or equal to the value of the 'lastChangedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'lastChangedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
'lastChangedUpTo': lastChangedUpTo_example, // {String} The end time (inclusive) of the time range when the user task instance was changed for the last time.
Must be greater or equal to the value of the 'lastChangedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'lastChangedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
'dueDate': dueDate_example, // {String} The due date of the user task instance.
Evaluated using the logical 'or' operator with the values of the 'dueDateFrom' and 'dueDateUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
'dueDateFrom': dueDateFrom_example, // {String} The start time (inclusive) of the due date time range for the user task instance.
Must be less or equal to the value of the 'dueDateUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'dueDate' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
'dueDateUpTo': dueDateUpTo_example, // {String} The end time (inclusive) of the due date time range for the user task instance.
Must be greater or equal to the 'dueDateFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'dueDate' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
'priority': priority_example, // {String} The priority of the user task instance.
The values are case-insensitive.
'status': status_example, // {String} The status of the user task instance.
The values are case-insensitive.
'recipientUsers': recipientUsers_example, // {String} The users who must be among the recipient users of the user task instance. A user task instance has to match at least one of the recipient users specified.
Specify the users by repeating this parameter multiple times, with one user each.
'recipientGroups': recipientGroups_example, // {String} The groups which must be among the recipient groups of the user task instance. A user task instance has to match at least one of the recipient groups specified.
Specify the groups by repeating this parameter multiple times, with one user each.
'containsText': containsText_example, // {String} Text, which should be contained in at least one of the following fields of the user task instance:
* subject
* description
* activityId
* id
* processor
* workflowDefinitionId
* workflowInstanceId
Performed filtering is case-insensitive. You must not use this parameter more than once.
'attributes.ExampleCustomAttribute': attributes.ExampleCustomAttribute_example, // {String} Example of a parameter that filters task instances by the value of the custom task attribute with the ID 'ExampleCustomAttribute'.
You can specify parameters for other attributes in an analogous way.
If you specify a parameter several times, the logical operators apply as outlined in the overall description of this API.
If custom task attributes with different IDs are present in the URL, only tasks which contain all of them with the values specified will be returned as a response to the request.
If a query by custom task attributes matches too many task definitions, you have to limit the query further. Refer, for example, to parameter 'definitionId'.
'definitionId': definitionId_example // {String} The definition ID of the user task.
It consists of the ID of the task defined in the workflow definition (task definition ID) as well as the workflow definition ID delimited by an '@' sign.
For optimal performance, specify this parameter when searching for tasks by custom task attributes.
If the custom task attribute IDs from the query match more than 50 task definitions, you have to specify one or more task definition IDs when searching for tasks by custom task attributes.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.v1TaskInstancesGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class v1TaskInstancesGetExample
{
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 UserTaskInstancesApi();
var acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional)
var $skip = 56; // Integer | 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. You can use this parameter only once.
Refer also to the $top parameter. (optional) (default to 0)
var $top = 56; // Integer | The number of records you want to show.
You can get 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. You can use this parameter only once.
Refer also to the $skip parameter. (optional) (default to 100)
var $inlinecount = $inlinecount_example; // String | Specify whether the total count of the task instances, which match the search criteria, should be returned as a value
of the X-Total-Count response header. Note that this header is not approved by default in the Neo HTML5 runtime and must be added to the 'headerWhitelist' attribute of the neo-app.json file. To enable the header, use the 'allpages' setting. To disable the header, use the 'none' setting.
The values are case-sensitive. You can use this parameter only once. (optional) (default to none)
var $expand = $expand_example; // String | You can request custom task attributes to become part of the task output by specifying the value 'attributes' for the '$expand' parameter.
Otherwise, if the '$expand' parameter is not specified, the 'attributes' field is not included into task output. Note that labels as well as the order of the custom task attributes in which they are returned, are taken from the latest versions of the workflow definitions where these attributes are present.
(optional)
var $orderby = $orderby_example; // String | The attribute and direction by which tasks are sorted. The sort attribute and direction are separated by a space.
The parameter value is case-sensitive. You can only specify one ordering parameter, which contains attribute and direction.
To stabilize the order of tasks the implicit second ordering parameter 'createdAt asc' is applied.
* claimedAt asc - Ascending, task claim time from the oldest to the most recent, tasks with status READY (not yet claimed) first.
* claimedAt desc - Descending, from the most recently claimed tasks to the oldest ones, tasks with status READY (not yet claimed) last.
* completedAt asc - Ascending, task completion or cancelation time from the oldest to the most recent, not yet COMPLETED tasks first.
* completedAt desc - Descending, from the most recently COMPLETED or CANCELED tasks to the oldest ones, not yet COMPLETED tasks last.
* createdAt asc - Ascending, task creation time from the oldest to the most recent.
* createdAt desc - Descending, from the most recently created tasks to the oldest ones.
* lastChangedAt asc - Ascending, task last change time from the oldest to the most recent.
* lastChangedAt desc - Descending, from the most recently changed tasks to the oldest ones.
* dueDate asc - Ascending, tasks due date from the oldest to the most distant in future ones, tasks without due date first.
* dueDate desc - Descending, tasks due date from the most distant in future to the oldest ones, tasks without due date last.
* subject asc - Ascending, from A to Z case-sensitive.
* subject desc - Descending, from Z to A case-sensitive.
* description asc - Ascending, from A to Z case-sensitive, tasks without description first.
* description desc - Descending, from Z to A case-sensitive, tasks without description last.
* activityId asc - Ascending, from A to Z case-sensitive.
* activityId desc - Descending, from Z to A case-sensitive.
* id asc - Ascending, from A to Z case-sensitive.
* id desc - Descending, from Z to A case-sensitive.
* processor asc - Ascending, from A to Z case-sensitive, tasks without processor first.
* processor desc - Descending, from Z to A case-sensitive, tasks without processor last.
* workflowDefinitionId asc - Ascending, from A to Z case-sensitive.
* workflowDefinitionId desc - Descending, from Z to A case-sensitive.
* workflowInstanceId asc - Ascending, from A to Z case-sensitive.
* workflowInstanceId desc - Descending, from Z to A case-sensitive.
* priority asc - Ascending, tasks priority from lowest to highest.
* priority desc - Descending, tasks priority from highest to lowest. (optional) (default to createdAt asc)
var workflowInstanceId = workflowInstanceId_example; // String | The workflow instance ID for which the user task instances are returned. The workflow instance ID is 36 characters long. (optional)
var workflowDefinitionId = workflowDefinitionId_example; // String | The workflow definition ID for which the user task instances are returned. (optional)
var processor = processor_example; // String | The processor of the user task instance. (optional)
var id = id_example; // String | The unique ID of the user task instance. The user task instance ID is 36 characters long. (optional)
var activityId = activityId_example; // String | The activityId of the user task instance. This field represents the ID of the user task definition. (optional)
var description = description_example; // String | The description of the user task instance in UTF-8 encoding. You must not specify texts that contain commas with this parameter. (optional)
var subject = subject_example; // String | The subject of the user task instance in UTF-8 encoding. You must not specify texts that contain commas with this parameter. (optional)
var createdAt = createdAt_example; // String | Time when the user task instance has been created.
Evaluated using the logical 'or' operator with the values of the 'createdFrom' and 'createdUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
var createdFrom = createdFrom_example; // String | The start time (inclusive) of the time range when the user task instance was created.
Must be less or equal to the value of the 'createdUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'createdAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
var createdUpTo = createdUpTo_example; // String | The end time (inclusive) of the time range when the user task instance was created.
Must be greater or equal to the value of the 'createdFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'createdAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
var claimedAt = claimedAt_example; // String | Time when the user task instance was claimed.
Evaluated using the logical 'or' operator with the values of the 'claimedFrom' and 'claimedUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
var claimedFrom = claimedFrom_example; // String | The start time (inclusive) of the time range when the user task instance was claimed.
Must be less or equal to the value of the 'claimedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'claimedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
var claimedUpTo = claimedUpTo_example; // String | The end time (inclusive) of the time range when the user task instance was claimed.
Must be greater or equal to the value of the 'claimedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'claimedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
var completedAt = completedAt_example; // String | Time when the user task instance was COMPLETED or CANCELED.
Evaluated using the logical 'or' operator with the values of the 'completedFrom' and 'completedUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
var completedFrom = completedFrom_example; // String | The start time (inclusive) of the time range when the user task instance was COMPLETED or CANCELED.
Must be less or equal to the value of the 'completedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'completedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
var completedUpTo = completedUpTo_example; // String | The end time (inclusive) of the time range when the user task instance was COMPLETED or CANCELED.
Must be greater or equal to the value of the 'completedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'completedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
var lastChangedAt = lastChangedAt_example; // String | Time when the user task instance has been changed for the last time.
Evaluated using the logical 'or' operator with the values of the 'lastChangedFrom' and 'lastChangedTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
var lastChangedFrom = lastChangedFrom_example; // String | The start time (inclusive) of the time range when the user task instance was changed for the last time.
Must be less or equal to the value of the 'lastChangedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'lastChangedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
var lastChangedUpTo = lastChangedUpTo_example; // String | The end time (inclusive) of the time range when the user task instance was changed for the last time.
Must be greater or equal to the value of the 'lastChangedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'lastChangedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
var dueDate = dueDate_example; // String | The due date of the user task instance.
Evaluated using the logical 'or' operator with the values of the 'dueDateFrom' and 'dueDateUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
var dueDateFrom = dueDateFrom_example; // String | The start time (inclusive) of the due date time range for the user task instance.
Must be less or equal to the value of the 'dueDateUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'dueDate' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
var dueDateUpTo = dueDateUpTo_example; // String | The end time (inclusive) of the due date time range for the user task instance.
Must be greater or equal to the 'dueDateFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'dueDate' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
var priority = priority_example; // String | The priority of the user task instance.
The values are case-insensitive.
(optional)
var status = status_example; // String | The status of the user task instance.
The values are case-insensitive.
(optional)
var recipientUsers = recipientUsers_example; // String | The users who must be among the recipient users of the user task instance. A user task instance has to match at least one of the recipient users specified.
Specify the users by repeating this parameter multiple times, with one user each.
(optional)
var recipientGroups = recipientGroups_example; // String | The groups which must be among the recipient groups of the user task instance. A user task instance has to match at least one of the recipient groups specified.
Specify the groups by repeating this parameter multiple times, with one user each.
(optional)
var containsText = containsText_example; // String | Text, which should be contained in at least one of the following fields of the user task instance:
* subject
* description
* activityId
* id
* processor
* workflowDefinitionId
* workflowInstanceId
Performed filtering is case-insensitive. You must not use this parameter more than once.
(optional)
var attributes.ExampleCustomAttribute = attributes.ExampleCustomAttribute_example; // String | Example of a parameter that filters task instances by the value of the custom task attribute with the ID 'ExampleCustomAttribute'.
You can specify parameters for other attributes in an analogous way.
If you specify a parameter several times, the logical operators apply as outlined in the overall description of this API.
If custom task attributes with different IDs are present in the URL, only tasks which contain all of them with the values specified will be returned as a response to the request.
If a query by custom task attributes matches too many task definitions, you have to limit the query further. Refer, for example, to parameter 'definitionId'.
(optional)
var definitionId = definitionId_example; // String | The definition ID of the user task.
It consists of the ID of the task defined in the workflow definition (task definition ID) as well as the workflow definition ID delimited by an '@' sign.
For optimal performance, specify this parameter when searching for tasks by custom task attributes.
If the custom task attribute IDs from the query match more than 50 task definitions, you have to specify one or more task definition IDs when searching for tasks by custom task attributes.
(optional)
try
{
// Retrieve instances by query parameters
array[TaskInstance] result = apiInstance.v1TaskInstancesGet(acceptLanguage, $skip, $top, $inlinecount, $expand, $orderby, workflowInstanceId, workflowDefinitionId, processor, id, activityId, description, subject, createdAt, createdFrom, createdUpTo, claimedAt, claimedFrom, claimedUpTo, completedAt, completedFrom, completedUpTo, lastChangedAt, lastChangedFrom, lastChangedUpTo, dueDate, dueDateFrom, dueDateUpTo, priority, status, recipientUsers, recipientGroups, containsText, attributes.ExampleCustomAttribute, definitionId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserTaskInstancesApi.v1TaskInstancesGet: " + 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\UserTaskInstancesApi();
$acceptLanguage = acceptLanguage_example; // String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
$$skip = 56; // Integer | 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. You can use this parameter only once.
Refer also to the $top parameter.
$$top = 56; // Integer | The number of records you want to show.
You can get 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. You can use this parameter only once.
Refer also to the $skip parameter.
$$inlinecount = $inlinecount_example; // String | Specify whether the total count of the task instances, which match the search criteria, should be returned as a value
of the X-Total-Count response header. Note that this header is not approved by default in the Neo HTML5 runtime and must be added to the 'headerWhitelist' attribute of the neo-app.json file. To enable the header, use the 'allpages' setting. To disable the header, use the 'none' setting.
The values are case-sensitive. You can use this parameter only once.
$$expand = $expand_example; // String | You can request custom task attributes to become part of the task output by specifying the value 'attributes' for the '$expand' parameter.
Otherwise, if the '$expand' parameter is not specified, the 'attributes' field is not included into task output. Note that labels as well as the order of the custom task attributes in which they are returned, are taken from the latest versions of the workflow definitions where these attributes are present.
$$orderby = $orderby_example; // String | The attribute and direction by which tasks are sorted. The sort attribute and direction are separated by a space.
The parameter value is case-sensitive. You can only specify one ordering parameter, which contains attribute and direction.
To stabilize the order of tasks the implicit second ordering parameter 'createdAt asc' is applied.
* claimedAt asc - Ascending, task claim time from the oldest to the most recent, tasks with status READY (not yet claimed) first.
* claimedAt desc - Descending, from the most recently claimed tasks to the oldest ones, tasks with status READY (not yet claimed) last.
* completedAt asc - Ascending, task completion or cancelation time from the oldest to the most recent, not yet COMPLETED tasks first.
* completedAt desc - Descending, from the most recently COMPLETED or CANCELED tasks to the oldest ones, not yet COMPLETED tasks last.
* createdAt asc - Ascending, task creation time from the oldest to the most recent.
* createdAt desc - Descending, from the most recently created tasks to the oldest ones.
* lastChangedAt asc - Ascending, task last change time from the oldest to the most recent.
* lastChangedAt desc - Descending, from the most recently changed tasks to the oldest ones.
* dueDate asc - Ascending, tasks due date from the oldest to the most distant in future ones, tasks without due date first.
* dueDate desc - Descending, tasks due date from the most distant in future to the oldest ones, tasks without due date last.
* subject asc - Ascending, from A to Z case-sensitive.
* subject desc - Descending, from Z to A case-sensitive.
* description asc - Ascending, from A to Z case-sensitive, tasks without description first.
* description desc - Descending, from Z to A case-sensitive, tasks without description last.
* activityId asc - Ascending, from A to Z case-sensitive.
* activityId desc - Descending, from Z to A case-sensitive.
* id asc - Ascending, from A to Z case-sensitive.
* id desc - Descending, from Z to A case-sensitive.
* processor asc - Ascending, from A to Z case-sensitive, tasks without processor first.
* processor desc - Descending, from Z to A case-sensitive, tasks without processor last.
* workflowDefinitionId asc - Ascending, from A to Z case-sensitive.
* workflowDefinitionId desc - Descending, from Z to A case-sensitive.
* workflowInstanceId asc - Ascending, from A to Z case-sensitive.
* workflowInstanceId desc - Descending, from Z to A case-sensitive.
* priority asc - Ascending, tasks priority from lowest to highest.
* priority desc - Descending, tasks priority from highest to lowest.
$workflowInstanceId = workflowInstanceId_example; // String | The workflow instance ID for which the user task instances are returned. The workflow instance ID is 36 characters long.
$workflowDefinitionId = workflowDefinitionId_example; // String | The workflow definition ID for which the user task instances are returned.
$processor = processor_example; // String | The processor of the user task instance.
$id = id_example; // String | The unique ID of the user task instance. The user task instance ID is 36 characters long.
$activityId = activityId_example; // String | The activityId of the user task instance. This field represents the ID of the user task definition.
$description = description_example; // String | The description of the user task instance in UTF-8 encoding. You must not specify texts that contain commas with this parameter.
$subject = subject_example; // String | The subject of the user task instance in UTF-8 encoding. You must not specify texts that contain commas with this parameter.
$createdAt = createdAt_example; // String | Time when the user task instance has been created.
Evaluated using the logical 'or' operator with the values of the 'createdFrom' and 'createdUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
$createdFrom = createdFrom_example; // String | The start time (inclusive) of the time range when the user task instance was created.
Must be less or equal to the value of the 'createdUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'createdAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
$createdUpTo = createdUpTo_example; // String | The end time (inclusive) of the time range when the user task instance was created.
Must be greater or equal to the value of the 'createdFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'createdAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
$claimedAt = claimedAt_example; // String | Time when the user task instance was claimed.
Evaluated using the logical 'or' operator with the values of the 'claimedFrom' and 'claimedUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
$claimedFrom = claimedFrom_example; // String | The start time (inclusive) of the time range when the user task instance was claimed.
Must be less or equal to the value of the 'claimedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'claimedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
$claimedUpTo = claimedUpTo_example; // String | The end time (inclusive) of the time range when the user task instance was claimed.
Must be greater or equal to the value of the 'claimedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'claimedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
$completedAt = completedAt_example; // String | Time when the user task instance was COMPLETED or CANCELED.
Evaluated using the logical 'or' operator with the values of the 'completedFrom' and 'completedUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
$completedFrom = completedFrom_example; // String | The start time (inclusive) of the time range when the user task instance was COMPLETED or CANCELED.
Must be less or equal to the value of the 'completedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'completedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
$completedUpTo = completedUpTo_example; // String | The end time (inclusive) of the time range when the user task instance was COMPLETED or CANCELED.
Must be greater or equal to the value of the 'completedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'completedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
$lastChangedAt = lastChangedAt_example; // String | Time when the user task instance has been changed for the last time.
Evaluated using the logical 'or' operator with the values of the 'lastChangedFrom' and 'lastChangedTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
$lastChangedFrom = lastChangedFrom_example; // String | The start time (inclusive) of the time range when the user task instance was changed for the last time.
Must be less or equal to the value of the 'lastChangedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'lastChangedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
$lastChangedUpTo = lastChangedUpTo_example; // String | The end time (inclusive) of the time range when the user task instance was changed for the last time.
Must be greater or equal to the value of the 'lastChangedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'lastChangedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
$dueDate = dueDate_example; // String | The due date of the user task instance.
Evaluated using the logical 'or' operator with the values of the 'dueDateFrom' and 'dueDateUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
$dueDateFrom = dueDateFrom_example; // String | The start time (inclusive) of the due date time range for the user task instance.
Must be less or equal to the value of the 'dueDateUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'dueDate' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
$dueDateUpTo = dueDateUpTo_example; // String | The end time (inclusive) of the due date time range for the user task instance.
Must be greater or equal to the 'dueDateFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'dueDate' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
$priority = priority_example; // String | The priority of the user task instance.
The values are case-insensitive.
$status = status_example; // String | The status of the user task instance.
The values are case-insensitive.
$recipientUsers = recipientUsers_example; // String | The users who must be among the recipient users of the user task instance. A user task instance has to match at least one of the recipient users specified.
Specify the users by repeating this parameter multiple times, with one user each.
$recipientGroups = recipientGroups_example; // String | The groups which must be among the recipient groups of the user task instance. A user task instance has to match at least one of the recipient groups specified.
Specify the groups by repeating this parameter multiple times, with one user each.
$containsText = containsText_example; // String | Text, which should be contained in at least one of the following fields of the user task instance:
* subject
* description
* activityId
* id
* processor
* workflowDefinitionId
* workflowInstanceId
Performed filtering is case-insensitive. You must not use this parameter more than once.
$attributes.ExampleCustomAttribute = attributes.ExampleCustomAttribute_example; // String | Example of a parameter that filters task instances by the value of the custom task attribute with the ID 'ExampleCustomAttribute'.
You can specify parameters for other attributes in an analogous way.
If you specify a parameter several times, the logical operators apply as outlined in the overall description of this API.
If custom task attributes with different IDs are present in the URL, only tasks which contain all of them with the values specified will be returned as a response to the request.
If a query by custom task attributes matches too many task definitions, you have to limit the query further. Refer, for example, to parameter 'definitionId'.
$definitionId = definitionId_example; // String | The definition ID of the user task.
It consists of the ID of the task defined in the workflow definition (task definition ID) as well as the workflow definition ID delimited by an '@' sign.
For optimal performance, specify this parameter when searching for tasks by custom task attributes.
If the custom task attribute IDs from the query match more than 50 task definitions, you have to specify one or more task definition IDs when searching for tasks by custom task attributes.
try {
$result = $api_instance->v1TaskInstancesGet($acceptLanguage, $$skip, $$top, $$inlinecount, $$expand, $$orderby, $workflowInstanceId, $workflowDefinitionId, $processor, $id, $activityId, $description, $subject, $createdAt, $createdFrom, $createdUpTo, $claimedAt, $claimedFrom, $claimedUpTo, $completedAt, $completedFrom, $completedUpTo, $lastChangedAt, $lastChangedFrom, $lastChangedUpTo, $dueDate, $dueDateFrom, $dueDateUpTo, $priority, $status, $recipientUsers, $recipientGroups, $containsText, $attributes.ExampleCustomAttribute, $definitionId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserTaskInstancesApi->v1TaskInstancesGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserTaskInstancesApi;
# 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::UserTaskInstancesApi->new();
my $acceptLanguage = acceptLanguage_example; # String | Provide a preferred language. If a translation is available, relevant texts are returned in this language.
my $$skip = 56; # Integer | 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. You can use this parameter only once.
Refer also to the $top parameter.
my $$top = 56; # Integer | The number of records you want to show.
You can get 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. You can use this parameter only once.
Refer also to the $skip parameter.
my $$inlinecount = $inlinecount_example; # String | Specify whether the total count of the task instances, which match the search criteria, should be returned as a value
of the X-Total-Count response header. Note that this header is not approved by default in the Neo HTML5 runtime and must be added to the 'headerWhitelist' attribute of the neo-app.json file. To enable the header, use the 'allpages' setting. To disable the header, use the 'none' setting.
The values are case-sensitive. You can use this parameter only once.
my $$expand = $expand_example; # String | You can request custom task attributes to become part of the task output by specifying the value 'attributes' for the '$expand' parameter.
Otherwise, if the '$expand' parameter is not specified, the 'attributes' field is not included into task output. Note that labels as well as the order of the custom task attributes in which they are returned, are taken from the latest versions of the workflow definitions where these attributes are present.
my $$orderby = $orderby_example; # String | The attribute and direction by which tasks are sorted. The sort attribute and direction are separated by a space.
The parameter value is case-sensitive. You can only specify one ordering parameter, which contains attribute and direction.
To stabilize the order of tasks the implicit second ordering parameter 'createdAt asc' is applied.
* claimedAt asc - Ascending, task claim time from the oldest to the most recent, tasks with status READY (not yet claimed) first.
* claimedAt desc - Descending, from the most recently claimed tasks to the oldest ones, tasks with status READY (not yet claimed) last.
* completedAt asc - Ascending, task completion or cancelation time from the oldest to the most recent, not yet COMPLETED tasks first.
* completedAt desc - Descending, from the most recently COMPLETED or CANCELED tasks to the oldest ones, not yet COMPLETED tasks last.
* createdAt asc - Ascending, task creation time from the oldest to the most recent.
* createdAt desc - Descending, from the most recently created tasks to the oldest ones.
* lastChangedAt asc - Ascending, task last change time from the oldest to the most recent.
* lastChangedAt desc - Descending, from the most recently changed tasks to the oldest ones.
* dueDate asc - Ascending, tasks due date from the oldest to the most distant in future ones, tasks without due date first.
* dueDate desc - Descending, tasks due date from the most distant in future to the oldest ones, tasks without due date last.
* subject asc - Ascending, from A to Z case-sensitive.
* subject desc - Descending, from Z to A case-sensitive.
* description asc - Ascending, from A to Z case-sensitive, tasks without description first.
* description desc - Descending, from Z to A case-sensitive, tasks without description last.
* activityId asc - Ascending, from A to Z case-sensitive.
* activityId desc - Descending, from Z to A case-sensitive.
* id asc - Ascending, from A to Z case-sensitive.
* id desc - Descending, from Z to A case-sensitive.
* processor asc - Ascending, from A to Z case-sensitive, tasks without processor first.
* processor desc - Descending, from Z to A case-sensitive, tasks without processor last.
* workflowDefinitionId asc - Ascending, from A to Z case-sensitive.
* workflowDefinitionId desc - Descending, from Z to A case-sensitive.
* workflowInstanceId asc - Ascending, from A to Z case-sensitive.
* workflowInstanceId desc - Descending, from Z to A case-sensitive.
* priority asc - Ascending, tasks priority from lowest to highest.
* priority desc - Descending, tasks priority from highest to lowest.
my $workflowInstanceId = workflowInstanceId_example; # String | The workflow instance ID for which the user task instances are returned. The workflow instance ID is 36 characters long.
my $workflowDefinitionId = workflowDefinitionId_example; # String | The workflow definition ID for which the user task instances are returned.
my $processor = processor_example; # String | The processor of the user task instance.
my $id = id_example; # String | The unique ID of the user task instance. The user task instance ID is 36 characters long.
my $activityId = activityId_example; # String | The activityId of the user task instance. This field represents the ID of the user task definition.
my $description = description_example; # String | The description of the user task instance in UTF-8 encoding. You must not specify texts that contain commas with this parameter.
my $subject = subject_example; # String | The subject of the user task instance in UTF-8 encoding. You must not specify texts that contain commas with this parameter.
my $createdAt = createdAt_example; # String | Time when the user task instance has been created.
Evaluated using the logical 'or' operator with the values of the 'createdFrom' and 'createdUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
my $createdFrom = createdFrom_example; # String | The start time (inclusive) of the time range when the user task instance was created.
Must be less or equal to the value of the 'createdUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'createdAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
my $createdUpTo = createdUpTo_example; # String | The end time (inclusive) of the time range when the user task instance was created.
Must be greater or equal to the value of the 'createdFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'createdAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
my $claimedAt = claimedAt_example; # String | Time when the user task instance was claimed.
Evaluated using the logical 'or' operator with the values of the 'claimedFrom' and 'claimedUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
my $claimedFrom = claimedFrom_example; # String | The start time (inclusive) of the time range when the user task instance was claimed.
Must be less or equal to the value of the 'claimedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'claimedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
my $claimedUpTo = claimedUpTo_example; # String | The end time (inclusive) of the time range when the user task instance was claimed.
Must be greater or equal to the value of the 'claimedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'claimedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
my $completedAt = completedAt_example; # String | Time when the user task instance was COMPLETED or CANCELED.
Evaluated using the logical 'or' operator with the values of the 'completedFrom' and 'completedUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
my $completedFrom = completedFrom_example; # String | The start time (inclusive) of the time range when the user task instance was COMPLETED or CANCELED.
Must be less or equal to the value of the 'completedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'completedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
my $completedUpTo = completedUpTo_example; # String | The end time (inclusive) of the time range when the user task instance was COMPLETED or CANCELED.
Must be greater or equal to the value of the 'completedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'completedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
my $lastChangedAt = lastChangedAt_example; # String | Time when the user task instance has been changed for the last time.
Evaluated using the logical 'or' operator with the values of the 'lastChangedFrom' and 'lastChangedTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
my $lastChangedFrom = lastChangedFrom_example; # String | The start time (inclusive) of the time range when the user task instance was changed for the last time.
Must be less or equal to the value of the 'lastChangedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'lastChangedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
my $lastChangedUpTo = lastChangedUpTo_example; # String | The end time (inclusive) of the time range when the user task instance was changed for the last time.
Must be greater or equal to the value of the 'lastChangedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'lastChangedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
my $dueDate = dueDate_example; # String | The due date of the user task instance.
Evaluated using the logical 'or' operator with the values of the 'dueDateFrom' and 'dueDateUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
my $dueDateFrom = dueDateFrom_example; # String | The start time (inclusive) of the due date time range for the user task instance.
Must be less or equal to the value of the 'dueDateUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'dueDate' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
my $dueDateUpTo = dueDateUpTo_example; # String | The end time (inclusive) of the due date time range for the user task instance.
Must be greater or equal to the 'dueDateFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'dueDate' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
my $priority = priority_example; # String | The priority of the user task instance.
The values are case-insensitive.
my $status = status_example; # String | The status of the user task instance.
The values are case-insensitive.
my $recipientUsers = recipientUsers_example; # String | The users who must be among the recipient users of the user task instance. A user task instance has to match at least one of the recipient users specified.
Specify the users by repeating this parameter multiple times, with one user each.
my $recipientGroups = recipientGroups_example; # String | The groups which must be among the recipient groups of the user task instance. A user task instance has to match at least one of the recipient groups specified.
Specify the groups by repeating this parameter multiple times, with one user each.
my $containsText = containsText_example; # String | Text, which should be contained in at least one of the following fields of the user task instance:
* subject
* description
* activityId
* id
* processor
* workflowDefinitionId
* workflowInstanceId
Performed filtering is case-insensitive. You must not use this parameter more than once.
my $attributes.ExampleCustomAttribute = attributes.ExampleCustomAttribute_example; # String | Example of a parameter that filters task instances by the value of the custom task attribute with the ID 'ExampleCustomAttribute'.
You can specify parameters for other attributes in an analogous way.
If you specify a parameter several times, the logical operators apply as outlined in the overall description of this API.
If custom task attributes with different IDs are present in the URL, only tasks which contain all of them with the values specified will be returned as a response to the request.
If a query by custom task attributes matches too many task definitions, you have to limit the query further. Refer, for example, to parameter 'definitionId'.
my $definitionId = definitionId_example; # String | The definition ID of the user task.
It consists of the ID of the task defined in the workflow definition (task definition ID) as well as the workflow definition ID delimited by an '@' sign.
For optimal performance, specify this parameter when searching for tasks by custom task attributes.
If the custom task attribute IDs from the query match more than 50 task definitions, you have to specify one or more task definition IDs when searching for tasks by custom task attributes.
eval {
my $result = $api_instance->v1TaskInstancesGet(acceptLanguage => $acceptLanguage, $skip => $$skip, $top => $$top, $inlinecount => $$inlinecount, $expand => $$expand, $orderby => $$orderby, workflowInstanceId => $workflowInstanceId, workflowDefinitionId => $workflowDefinitionId, processor => $processor, id => $id, activityId => $activityId, description => $description, subject => $subject, createdAt => $createdAt, createdFrom => $createdFrom, createdUpTo => $createdUpTo, claimedAt => $claimedAt, claimedFrom => $claimedFrom, claimedUpTo => $claimedUpTo, completedAt => $completedAt, completedFrom => $completedFrom, completedUpTo => $completedUpTo, lastChangedAt => $lastChangedAt, lastChangedFrom => $lastChangedFrom, lastChangedUpTo => $lastChangedUpTo, dueDate => $dueDate, dueDateFrom => $dueDateFrom, dueDateUpTo => $dueDateUpTo, priority => $priority, status => $status, recipientUsers => $recipientUsers, recipientGroups => $recipientGroups, containsText => $containsText, attributes.ExampleCustomAttribute => $attributes.ExampleCustomAttribute, definitionId => $definitionId);
print Dumper($result);
};
if ($@) {
warn "Exception when calling UserTaskInstancesApi->v1TaskInstancesGet: $@\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.UserTaskInstancesApi()
acceptLanguage = acceptLanguage_example # String | Provide a preferred language. If a translation is available, relevant texts are returned in this language. (optional)
$skip = 56 # Integer | 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. You can use this parameter only once.
Refer also to the $top parameter. (optional) (default to 0)
$top = 56 # Integer | The number of records you want to show.
You can get 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. You can use this parameter only once.
Refer also to the $skip parameter. (optional) (default to 100)
$inlinecount = $inlinecount_example # String | Specify whether the total count of the task instances, which match the search criteria, should be returned as a value
of the X-Total-Count response header. Note that this header is not approved by default in the Neo HTML5 runtime and must be added to the 'headerWhitelist' attribute of the neo-app.json file. To enable the header, use the 'allpages' setting. To disable the header, use the 'none' setting.
The values are case-sensitive. You can use this parameter only once. (optional) (default to none)
$expand = $expand_example # String | You can request custom task attributes to become part of the task output by specifying the value 'attributes' for the '$expand' parameter.
Otherwise, if the '$expand' parameter is not specified, the 'attributes' field is not included into task output. Note that labels as well as the order of the custom task attributes in which they are returned, are taken from the latest versions of the workflow definitions where these attributes are present.
(optional)
$orderby = $orderby_example # String | The attribute and direction by which tasks are sorted. The sort attribute and direction are separated by a space.
The parameter value is case-sensitive. You can only specify one ordering parameter, which contains attribute and direction.
To stabilize the order of tasks the implicit second ordering parameter 'createdAt asc' is applied.
* claimedAt asc - Ascending, task claim time from the oldest to the most recent, tasks with status READY (not yet claimed) first.
* claimedAt desc - Descending, from the most recently claimed tasks to the oldest ones, tasks with status READY (not yet claimed) last.
* completedAt asc - Ascending, task completion or cancelation time from the oldest to the most recent, not yet COMPLETED tasks first.
* completedAt desc - Descending, from the most recently COMPLETED or CANCELED tasks to the oldest ones, not yet COMPLETED tasks last.
* createdAt asc - Ascending, task creation time from the oldest to the most recent.
* createdAt desc - Descending, from the most recently created tasks to the oldest ones.
* lastChangedAt asc - Ascending, task last change time from the oldest to the most recent.
* lastChangedAt desc - Descending, from the most recently changed tasks to the oldest ones.
* dueDate asc - Ascending, tasks due date from the oldest to the most distant in future ones, tasks without due date first.
* dueDate desc - Descending, tasks due date from the most distant in future to the oldest ones, tasks without due date last.
* subject asc - Ascending, from A to Z case-sensitive.
* subject desc - Descending, from Z to A case-sensitive.
* description asc - Ascending, from A to Z case-sensitive, tasks without description first.
* description desc - Descending, from Z to A case-sensitive, tasks without description last.
* activityId asc - Ascending, from A to Z case-sensitive.
* activityId desc - Descending, from Z to A case-sensitive.
* id asc - Ascending, from A to Z case-sensitive.
* id desc - Descending, from Z to A case-sensitive.
* processor asc - Ascending, from A to Z case-sensitive, tasks without processor first.
* processor desc - Descending, from Z to A case-sensitive, tasks without processor last.
* workflowDefinitionId asc - Ascending, from A to Z case-sensitive.
* workflowDefinitionId desc - Descending, from Z to A case-sensitive.
* workflowInstanceId asc - Ascending, from A to Z case-sensitive.
* workflowInstanceId desc - Descending, from Z to A case-sensitive.
* priority asc - Ascending, tasks priority from lowest to highest.
* priority desc - Descending, tasks priority from highest to lowest. (optional) (default to createdAt asc)
workflowInstanceId = workflowInstanceId_example # String | The workflow instance ID for which the user task instances are returned. The workflow instance ID is 36 characters long. (optional)
workflowDefinitionId = workflowDefinitionId_example # String | The workflow definition ID for which the user task instances are returned. (optional)
processor = processor_example # String | The processor of the user task instance. (optional)
id = id_example # String | The unique ID of the user task instance. The user task instance ID is 36 characters long. (optional)
activityId = activityId_example # String | The activityId of the user task instance. This field represents the ID of the user task definition. (optional)
description = description_example # String | The description of the user task instance in UTF-8 encoding. You must not specify texts that contain commas with this parameter. (optional)
subject = subject_example # String | The subject of the user task instance in UTF-8 encoding. You must not specify texts that contain commas with this parameter. (optional)
createdAt = createdAt_example # String | Time when the user task instance has been created.
Evaluated using the logical 'or' operator with the values of the 'createdFrom' and 'createdUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
createdFrom = createdFrom_example # String | The start time (inclusive) of the time range when the user task instance was created.
Must be less or equal to the value of the 'createdUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'createdAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
createdUpTo = createdUpTo_example # String | The end time (inclusive) of the time range when the user task instance was created.
Must be greater or equal to the value of the 'createdFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'createdAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
claimedAt = claimedAt_example # String | Time when the user task instance was claimed.
Evaluated using the logical 'or' operator with the values of the 'claimedFrom' and 'claimedUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
claimedFrom = claimedFrom_example # String | The start time (inclusive) of the time range when the user task instance was claimed.
Must be less or equal to the value of the 'claimedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'claimedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
claimedUpTo = claimedUpTo_example # String | The end time (inclusive) of the time range when the user task instance was claimed.
Must be greater or equal to the value of the 'claimedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'claimedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
completedAt = completedAt_example # String | Time when the user task instance was COMPLETED or CANCELED.
Evaluated using the logical 'or' operator with the values of the 'completedFrom' and 'completedUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
completedFrom = completedFrom_example # String | The start time (inclusive) of the time range when the user task instance was COMPLETED or CANCELED.
Must be less or equal to the value of the 'completedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'completedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
completedUpTo = completedUpTo_example # String | The end time (inclusive) of the time range when the user task instance was COMPLETED or CANCELED.
Must be greater or equal to the value of the 'completedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'completedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
lastChangedAt = lastChangedAt_example # String | Time when the user task instance has been changed for the last time.
Evaluated using the logical 'or' operator with the values of the 'lastChangedFrom' and 'lastChangedTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
lastChangedFrom = lastChangedFrom_example # String | The start time (inclusive) of the time range when the user task instance was changed for the last time.
Must be less or equal to the value of the 'lastChangedUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'lastChangedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
lastChangedUpTo = lastChangedUpTo_example # String | The end time (inclusive) of the time range when the user task instance was changed for the last time.
Must be greater or equal to the value of the 'lastChangedFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'lastChangedAt' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
dueDate = dueDate_example # String | The due date of the user task instance.
Evaluated using the logical 'or' operator with the values of the 'dueDateFrom' and 'dueDateUpTo' parameters if they are specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
dueDateFrom = dueDateFrom_example # String | The start time (inclusive) of the due date time range for the user task instance.
Must be less or equal to the value of the 'dueDateUpTo' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'dueDate' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
dueDateUpTo = dueDateUpTo_example # String | The end time (inclusive) of the due date time range for the user task instance.
Must be greater or equal to the 'dueDateFrom' parameter if the latter is specified.
Evaluated using the logical 'or' operator with the value of the 'dueDate' parameter if the latter is specified.
Supports two date formats:
1. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
2. yyyyMMddHHmmss.SSS
(optional)
priority = priority_example # String | The priority of the user task instance.
The values are case-insensitive.
(optional)
status = status_example # String | The status of the user task instance.
The values are case-insensitive.
(optional)
recipientUsers = recipientUsers_example # String | The users who must be among the recipient users of the user task instance. A user task instance has to match at least one of the recipient users specified.
Specify the users by repeating this parameter multiple times, with one user each.
(optional)
recipientGroups = recipientGroups_example # String | The groups which must be among the recipient groups of the user task instance. A user task instance has to match at least one of the recipient groups specified.
Specify the groups by repeating this parameter multiple times, with one user each.
(optional)
containsText = containsText_example # String | Text, which should be contained in at least one of the following fields of the user task instance:
* subject
* description
* activityId
* id
* processor
* workflowDefinitionId
* workflowInstanceId
Performed filtering is case-insensitive. You must not use this parameter more than once.
(optional)
attributes.ExampleCustomAttribute = attributes.ExampleCustomAttribute_example # String | Example of a parameter that filters task instances by the value of the custom task attribute with the ID 'ExampleCustomAttribute'.
You can specify parameters for other attributes in an analogous way.
If you specify a parameter several times, the logical operators apply as outlined in the overall description of this API.
If custom task attributes with different IDs are present in the URL, only tasks which contain all of them with the values specified will be returned as a response to the request.
If a query by custom task attributes matches too many task definitions, you have to limit the query further. Refer, for example, to parameter 'definitionId'.
(optional)
definitionId = definitionId_example # String | The definition ID of the user task.
It consists of the ID of the task defined in the workflow definition (task definition ID) as well as the workflow definition ID delimited by an '@' sign.
For optimal performance, specify this parameter when searching for tasks by custom task attributes.
If the custom task attribute IDs from the query match more than 50 task definitions, you have to specify one or more task definition IDs when searching for tasks by custom task attributes.
(optional)
try:
# Retrieve instances by query parameters
api_response = api_instance.v1TaskInstancesGet(acceptLanguage=acceptLanguage, $skip=$skip, $top=$top, $inlinecount=$inlinecount, $expand=$expand, $orderby=$orderby, workflowInstanceId=workflowInstanceId, workflowDefinitionId=workflowDefinitionId, processor=processor, id=id, activityId=activityId, description=description, subject=subject, createdAt=createdAt, createdFrom=createdFrom, createdUpTo=createdUpTo, claimedAt=claimedAt, claimedFrom=claimedFrom, claimedUpTo=claimedUpTo, completedAt=completedAt, completedFrom=completedFrom, completedUpTo=completedUpTo, lastChangedAt=lastChangedAt, lastChangedFrom=lastChangedFrom, lastChangedUpTo=lastChangedUpTo, dueDate=dueDate, dueDateFrom=dueDateFrom, dueDateUpTo=dueDateUpTo, priority=priority, status=status, recipientUsers=recipientUsers, recipientGroups=recipientGroups, containsText=containsText, attributes.ExampleCustomAttribute=attributes.ExampleCustomAttribute, definitionId=definitionId)
pprint(api_response)
except ApiException as e:
print("Exception when calling UserTaskInstancesApi->v1TaskInstancesGet: %s\n" % e)