PageSize

Used only for the GET operation. The PageSize parameter is the 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. The default value is 10. If you do not set a value for this parameter, then query will return only 10 records.

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 only for the GET operation. The StartRowNum parameter is 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).

The default value and returns the records from beginning.

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.

fields

Used for only GET or Query operations to specify a comma-separated list of property names (fields) that are required in the REST API response. The response contains only the files given in this list irrespective of fields available in the source being queried.

searchspec

Used to include search specifications in the REST API response.

ViewMode

Used as an access control that controls users access to data and application functionality. Values include:

• Personal
• Sales Rep
• Organization
• Group
• Catalog

For more information about access controls, see About Access Controls for Siebel Business Component REST Requests.

childlinks

Used for only GET or Query operations to specify a comma-separated list of child business components that require links returned in the REST API response. The response returns only links to child objects specified in this parameter value.

For an example of childlinks, see Querying for a Siebel CRM Repository Resource That Returns Child Links Only for Lists.