OSLC pagination

The Netcool®/Impact OSLC provider supports pagination to make the retrieval of large amounts of data easier and more efficient.

Pagination is enabled by default for data items and policies whose variables contain data items. To manually configure pagination, add the following query parameters to the URL:
?oslc.paging=true&oslc.page=<pagenumber>&oslc.pageSize=<pagesize>
  • oslc.paging=true enables pagination. This setting is enabled by default. To disable pagination, use oslc_paging=false.
  • oslc.page=<pagenumber> is the page number. This property is set to page 1 by default.
  • oslc.pageSize=<pagesize> is the page size. This property is set to 100 by default.

Administrators can add the following statement to the NCI_server.props configuration file to set the default limit for the page size:

impact.oslc.pagesize=<pagesize>

If this property is not defined, it is set to 100 by default.

If the page size in the URL is greater than the limit that is defined in the NCI_server.props configuration file, the size is limited to that set in the NCI_server.props configuration file.

You can also add the oslc_paging=false property to the URL to disable pagination. If this property is set, the entire result set is returned. If any additional pagination properties are defined, these properties are ignored. If you disable pagination and you also enable large data model support, this can have an adverse affect on performance.

Response information

Two properties are added to the response information: oslc:nextPage and oslc:totalCount.

The oslc:nextPage property is not returned when there is no next page. If the page size of the result is smaller than the specified page size property, no next page property is returned.

The oslc:totalCount property gives the total count information across all the pages.

Example

For example, the following URL represents the alert variables that belong to the GetByFilter function events:

http://example.com:16310/NCICLUSTER_NCI_oslc/policy/events/alerts?
oslc.paging=true&oslc.page=2&oslc.pageSize=25

In the URL, pagination is enabled. The variable results are contained in page two. The page size is limited to 25.