Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

/ task / taskGetList

  • Article
  • 1 minutes to read

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.

Note

When sending a JSON request payload to the API, the order of parameters is not significant. However, for XML request payloads, parameters must be provided in the exact order specified in this documentation to comply with input validation requirements.

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.
reference Array<taskReferenceType> Optional The task reference type.
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
orderBy orderByColumnType Optional Specify a column to order by. Supported columns are [h_created_on | h_completed_on | h_start_date | h_due_date | h_updated_on | h_assigned_on]

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