How can we help?
{{docApp.searchError}}
{{product.name}}
Searching in {{docApp.searchFilterBySpecificBookTitle}}
{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}}
in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.
You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Description
This operation gets a list of tasks.
API Details
- Status:
- The required privilege level to invoke this method is
user
- The supported database role for this method is
none
System Rights | Database Rights | Mail Rights | Calendar Rights |
---|---|---|---|
sys.b.manageTasks |
--- |
--- |
--- |
Request Parameters
The taskGetList method takes the following input parameters. It is important to note that the parameters must be passed to the method in the same order as they appear here in order to satisfy the requirement of the input validation checks.
Name | Type | Attributes | Description |
---|---|---|---|
application |
appNameType |
Optional | Specify the application to filter the list of task(s) returned. |
statusFilter |
Array<taskStateType> |
Optional | Specify the task status to filter the list of task(s) returned. |
taskFilter |
Array<taskFilterType> |
Optional Default= all |
Specify the task type to filter the tasks associated with your account. |
returnTypes |
taskListReturnType |
Optional Default= all |
Control which types of task object to return. |
category |
xs:string |
Optional | The category of task. |
objectRefUrn |
xs:anyURI |
Optional | Application defined object reference URN, mainly used for storing Entity reference URN |
scheduleRef |
xs:unsignedInt |
Optional | Filter list by schedule reference |
Response Parameters
Name | Type | Attributes | Description |
---|---|---|---|
task |
Array<taskInfoType> |
Optional | Information about a task |
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document