Use the API to change the maximum number of pending workflow tasks displayed on your library homepage

This article is for developers with a full understanding of how to work with our API. 

Important note about the API explorer
When you follow the link we provide to the API explorer, you'll see a red warning.
API_image01.png
The API itself is not deprecated. It's the Google API explorer that is deprecated. All the processes described in our API articles function correctly and safely if you use this Google API explorer. 


By default, the maximum number of pending workflow tasks displayed on your library homepage is 100. A custom configuration flag is available to change the limit for a specific library or a whole domain to a maximum of 1000.

Learn more: Browse the workflow tasks in your library.

Important:
– To change the limit at the domain level, you must be super administrator; to change the limit at the library level, you must be library administrator or super administrator.
– This setting is available through the API only. It isn't available in the interface.
– Custom configurations at the library level take precedence over those set at the domain level. For example, if you set the limit at 500 at the domain level and 200 for one library, the limit will be 500 for all libraries on your domain except the one in which it is set at 200. 

Learn more: Use the API to check which custom configuration flags are set on your domain or library.

In this article:

Automatically generated table of contents


Set the custom configuration at the domain level 

1. As an AODocs super administrator, follow one of these links to the AODocs API:

  • US instance:

https://apis-explorer.appspot.com/apis-explorer/?base=https://ao-docs.appspot.com/api#s/domain/v1beta1/domain.configuration.set

  • EU instance:

https://apis-explorer.appspot.com/apis-explorer/?base=https://aodocs-core-eu-1.ey.r.appspot.com/api#s/domain/v1beta1/domain.configuration.set

Note: Dedicated instances have their own URLs. Learn more: What are AODocs instances?

2. Enter the flag name: workbasketSearchRequestMaxResult.

3. In the Request body field, enter a value between 10 and 1000 next to configurationFlagValue.

4. Click Authorize and execute. The response is displayed in the lower part of the screen.

image01.png

Note: To remove a custom configuration, use the same process, and enter the value 100in the Request body field. This is the default limit.


Set the custom configuration at the library level

1. As a library administrator, follow one of these links to the AODocs API:

  • US instance:

https://apis-explorer.appspot.com/apis-explorer/?base=https://ao-docs.appspot.com/api#p/library/v1beta1/library.configuration.set

  • EU instance:

https://apis-explorer.appspot.com/apis-explorer/?base=https://aodocs-core-eu-1.ey.r.appspot.com/api#s/library/v1beta1/library.configuration.set

Note: Dedicated instances have their own URLs. Learn more: What are AODocs instances?

2. Enter the ID of the library in which you want to add the custom configuration. Learn how to identify the library ID

3. Enter the flag name: workbasketSearchRequestMaxResult.

4. In the Request body field, enter a value between 10 and 1000 next to configurationFlagValue.

5. Click Authorize and execute. The response is displayed in the lower part of the screen.

image02.png

Note: To remove a custom configuration, use the same process, and enter the value 100in the Request body field. This is the default limit.

Was this article helpful? 0 out of 0 found this helpful
If you didn’t find what you were looking for, don’t hesitate to leave a comment!
Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.