Interface: SpecificPropertiesPayloadPagination
Specifies how to split the response into multiple pages, and return the response one page at a time.
Export
SpecificPropertiesPayloadPagination
Properties
limit
limit:
number
The maximum number of properties to return in a single page. Use this attribute with theoffset
attribute to split the properties into multiple pages. To fetch the first page, specifyoffset
=0 (do not skip any properties). To fetch the second page, specifyoffset
= value oflimit
you specified for the first page. So, the server skips the search results returned on the first page. In general,offset
=previous_offset
+previous_limit
. This attribute is 20 by default. The minimum value is 1 and the maximum is 1000.
Memberof
SpecificPropertiesPayloadPagination
Defined in
aps-sdk-node/modelderivative/source/model/specificPropertiesPayloadPagination.ts:20
offset
offset:
number
The number of properties to skip. Use this attribute with thelimit
attribute to split the properties into multiple pages. To fetch the first page, specifyoffset
=0 (do not skip any properties). To fetch the second page, specifyoffset
= value oflimit
you specified for the first page. So, the server skips the properties returned on the first page. In general,offset
=previous_offset
+previous_limit
. This attribute is 0 by default. The minimum value is 0.
Memberof
SpecificPropertiesPayloadPagination
Defined in
aps-sdk-node/modelderivative/source/model/specificPropertiesPayloadPagination.ts:14