Siebel REST API Guide > Overview of Using the Siebel REST API >

About URI Parameters


When constructing a URI, there are a number of optional parameters available to manage response results. Some parameters are described in Table 3.

Table 3. URI Parameters
Parameter
Description

PageSize

Integer that tells the Siebel Server how many records to return. If you query for all the Siebel contacts whose last name starts with the letter A and you do not want to get too many records (for performance reasons), then you can restrict the number of records returned. You restrict the number of records returned by setting the PageSize parameter to a reasonable number. All records that match the search criteria are returned.

For example, PageSize=20 returns only twenty contact records, even if more exist in the Siebel database. If fewer records exist that match that search criteria, then all records are returned (but no more than twenty).

NOTE:  It is recommended that you retrieve the lowest number of records required for any one call. The more records that are returned, the larger the message and the slower the response. The maximum number of records cannot exceed 100.

StartRowNum

Used when there is a need to start returning records at a specific row. For example, StartRowNum=100 starts at row 100 of the record set. The first number in a record set is zero, therefore, this request starts at record 99 (given you start counting from one for the first record).

This parameter is useful for paging through a record set N records at a time. For example, if there are 100 records in a record set, but you want to retrieve only ten at a time, then enter StartRowNum=0 and PageSize=10 on the first call, then StartRowNum=10 on the next call, then StartRowNum=20 on the next call, and so on.

The syntax for using URI parameters is the parameter name followed by an equal sign (=) with the value of the parameter, and each parameter is separated from other parameters by an ampersand (&). For example, if you want to set the PageSize parameter to 100 and the startrow parameter to 0 (zero), then you enter: Pagesize=100&StartRowNum=0

Siebel REST API Guide Copyright © 2016, Oracle and/or its affiliates. All rights reserved. Legal Notices.