Read Hierarchical Records of an Object (Extended Version)
|
Method
|
POST
|
|
URL
|
/v2/<object_full_identifier>/<record_UUID>/hierarchy
|
|
Parameters
|
fields, incomingRelationships, filter, sort, limit, offset, exclude_total_count, data_format, hie_field, direction
|
|
Response Content Type
|
application/json
|
 |
This is an extended version of the Read Hierarchical Records of an 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 a Role record and its descendants with the first two related Showcase records when sorted by name in descending order:
/v2/io_role/147f8dd1-e2c8-4dcd-8a67-7c9db6d5bbdd/hierarchy
Request body:
{
"incomingRelationships": { "io_showcase_related_role": { "fields": "io_name", "filter": "io_deleted=true or io_deleted=false", "sort": "io_name desc", "limit": "2" } } } |