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}}

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!

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

/ task / userGetApprovals

  • Article
  • 1 minutes to read

Description

This operation allows a user to get a list of approvals they need to action.

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is slave
System Rights Database Rights Mail Rights Calendar Rights
sys.b.manageTasks
 --- --- ---

Request Parameters

The userGetApprovals 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
listType userApprovalListType Required The type of approval list to return - either ‘outstanding’ (all pending approvals) or ‘overdue’ (only overdue approvals).
contentFilter xs:string Optional Optional text filter to search in approval title and details.
orderBy orderByColumnType Optional Specify a column to order by. Supported columns are [h_created_on | h_due_date | h_updated_on | h_assigned_on]. Default is h_due_date ASC.
pageInfo pageInfoType Optional Controls the paging. If element is not specified, paging is disabled.

Response Parameters

Name Type Attributes Description
approvals Array<taskInfoType> Optional Information about an approval
maxPages numberType Optional A number indicating the maximum number of pages that could be returned.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document