Read Records of Specified Object (Extended Version)
|
Method
|
POST
|
|
URL
|
/v2/<object_full_identifier>/extended_read
|
|
Parameters
|
fields, incomingRelationships, filter, sort, limit, offset, exclude_total_count, data_format, suppress_ror
|
|
Response Content Type
|
application/json
|
 |
This is an extended version of the Read Records of Specified Object method. In cases where parameter values are too complex to include in URLs, you can use this POST method with JSON code in the request body where each field represents a parameter. You can set parameters in both the URL and request body, as long as the same parameters are not used in both locations. This topic documents only the added functionality.
|
|
Parameter
|
Description
|
Data Type
|
Example
|
|---|---|---|---|
|
incomingRelationships
|
Incoming relationships of the object to use to retrieve related records.
Related records can be configured with the following parameters:
• fields
• filter
• sort
• limit
• offset
|
JSON
|
Retrieve all Showcase records sorted by name in descending order, and for each record, retrieve the first two related Showcase Details records when sorted by name in ascending order:
{
"incomingRelationships": { "io_showcase_detail_showcase": { "sort": "io_name asc", "limit": 2 } } } |