getPage

Purpose

Retrieves the specified range of data records in a view. The selected view defines the sorting and filtering of output. The amount of processing and time required to get complete results can vary widely, depending on whether it fetches related records and the number of rows you specify per page.

HTTP Method

GET

URL

https://app.infiniteblue.com/rest/api/getPage

URL Parameters

sessionId

The session ID obtained from the body of the response when calling login.

viewId

The original view ID.

startRow

The number of the row from which to start output. Defaults to 0.

rowsPerPage

The number of data records in the output. Defaults to the user-specified number of records per page.

composite

The number of levels for related records to be included recursively in the output. Defaults to 0.

objNames

A comma-separated list of object names. If present, only objects from this list are included in the output.

fieldList

A comma-separated list of field names. If present, only fields from this list are included in the output.

filterName

Name of the field to filter the output using the “equals” option (replaces the filter set in the view, if any).

filterValue

Value of the field to filter the output using the "equals" option.

onlyViewFields

When true, the output only includes fields in the specified view. When false, the output includes all fields in the object definition.

output

Optional parameter specifying the output format, one of: xml (default) or json.

Note:
  • The format of date or date/time fields is governed by the shared property UseISODateFormatInRESTJSON and can be configured from System Console > System > Shared Properties > General > API. For more information, see Shared Properties.
  • The shared property mentioned above is applicable only if the output is in JSON format.

Permissions Required

View permission for the requested object type.

Response

The set of data records in the view in the requested range

Example

Output example in XML format (no recursive output for related records): 

  <?xml version="1.0" encoding="utf-8" ?>
        <resp status="ok">
        <data id="131227" objName="person">
        <Field name="firstName">Bill</Field>
        <Field name="lastName">Smith</Field>
        </data>
        <data id="131228" objName="person">
        <Field name="firstName">John</Field>
        <Field name="lastName">Roth</Field>
        </data>
        </resp>

Output example in JSON format (no recursive output for related records):

[
{"objName": "lead", "id": 131227, "firstName": "Bill", "lastName": "Smith" },
{"objName": "lead", "id": 131228, "firstName": "John", "lastName": "Roth" }
        ]