Using the PageSize Parameter for Parent/Child/Grandchild Records

Inbound REST queries can set the limit for the number of records returned from a query for every level of the hierarchy. To do this, add the PageSize parameter with an integer as its argument at the desired level in the request.

Example 1

In this request the PageSize parameter is set at the parent level (since there is only one level in this request). This limits the response to 2 Account records.

  • URI: https://ServerName:port/siebel/v1.0/data/Account/Account?Fields=Id&Childlinks=None&StartRowNum=0&PageSize=2

  • HTTP Method: GET

  • Content-Type: application/json

  • Authorization: Basic

  • Request Body: None

Example 2

In this request for Contacts for a particular Account record, the PageSize parameter is set at the child level to 2 for the Contacts.

  • URI: https://ServerName:port/siebel/v1.0/data/Account/Account/1-34Z/Contact?Fields=First Name, Last Name&Childlinks=None&StartRowNum=0&PageSize=2

  • HTTP Method: GET

  • Content-Type: application/json

  • Authorization: Basic

  • Request Body: None

Example 3

This request gets the Actions for Contacts that belong to an Account. Here, we are restricting the response to two Activity records for a particular Contact. This parameter is at the grandchild level with page size for grandchild.

  • URI: https://ServerName:porthttps://<ServerAddress>:<port>/siebel/v1.0/data/Account/Account/1-34Z/Contact/1LS-AF98/Action?StartRowNum=0&PageSize=2

  • HTTP Method: GET

  • Content-Type: application/json

  • Authorization: Basic

  • Request Body: None