Paged APIs
Many times your response will include large amounts of data that you may wish to display using pagination. Each resource has a Paged template to simplify this process. You include the page details in the Pagination header.
Pagination Header | Definition |
---|---|
pageNumber | "pageNumber": 1 |
pageSize | "pageSize": 20 |
Output Format
The OutputFormat Headers allows your to specify the format of the response. The following formats are available:
dataFlow- Response is formatted in a format consumable by a Data Flow
instance- The default response format returns items in an array with all properties
result- Useful when submitting mutlitple transactions in a patch since this will itemize each transaction by result.
The format field is mandatory for all output formats, however type and perEnvelope are only required for dataFlow output.
Output Format Header | |
---|---|
format | "format": "dataFlow" |
type | "type": "create" |
perEnvelope | "perEnvelope": 20 |