Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI Web API

Restrictions on number of items per call

  • Last UpdatedMar 20, 2025
  • 1 minute read

Set up a configuration item to restrict the number of items returned per call. This prevents unnecessarily large returns. The type of items returned depends on the nature of the call. For example, your maximum items could consist of elements, attributes, or time-series data values depending on how your call is defined.

The following configuration item is available:

MaxReturnedItemsPerCall

Restricts the number of items returned per call. Add or set the configuration item in PI System Explorer:

Field

Description or value

Value Type

Int32

Value

Enter a numeric string that represents the upper bound for the items returned per call. Minimum value is 1. Maximum value is 2,147,483,647. The default value is 150,000.

Responses are paged so long as each page request returns a number of items that are less than the maximum number set by this parameter.

If a call exceeds the maximum number of items set by this parameter, a response is returned with HTTP status 400 Parameter (name) is greater than the maximum allowed (maximum defined number).

TitleResults for “How to create a CRG?”Also Available in