Pagination in Orchestrator

Help Documentation
, ,
1

Hello,

Can someone shed some light on what does pagination limit configuration do in Orchestrator configuration?

Orchestrator - UiPath.Orchestrator.dll.config

Pagination

link

Pagination.Limits.Enabled

Set to true by default for Cloud Platform and clean installs of on-premise Orchestrator instances. Adds a default $top value for all calls to API endpoints with pagination parameters (e.g. odata/Users).

2

$top

This clause helps you limit the amount of data you retrieve. It has an upper cap that is determined by the endpoint you are making calls to and the number of such resources that exist on you Orchestrator instances.

For example, this request /odata/Environments?$top=10 returns the first 10 environments available in the Community Edition of Orchestrator. However, if only 5 environments exist, only those are retrieved.

For most of the API endpoints, the limit is 100 due to performance issues. The value count will be displayed on the Rest API response under @odata.count.

Then you can use it with $skip

This clause enables you to skip the first n number of items, in an indicated filter.

More details here Orchestrator - Building API Requests

1 Like
3

Thanks @marian.platonov .

In a case where I use an API to trigger jobs, is it correct to assume that by setting this option I can limit the number jobs getting triggered by the API?

4

No.

$top will limit only the display of the retrieved data.

For further limit, you will need to use the extra filtering using $filter.

1 Like
5

Understood! Is there a similar configuration which can limit the number of API calls or number of jobs triggered, within a given span of time? Let’s say, to avoid DoS attacks?

6

This topic was automatically closed 3 days after the last reply. New replies are no longer allowed.