Expand Hierarchical Objects
Overview
Expand queries can expand the root item and child items of hierarchical objects. You can use dotted notation to perform the following functions:
- Expand assets, attribute & action definitions at the transaction level, translations & menu items at the attribute level, and translations at the menu item level.
- Recursively expand linked child objects using
childname*.all
. - Activate selective fields during expand and recursive expand.
URL Format for Collection Resource Parameters
Expand Query Parameters
-
actionDefs
- Return the Transaction and only the action definition items./rest/v17/commerceProcesses/transaction/documents/quote?expand=actionDefs
-
all
- Expand an asset object and its children./rest/v17/dynamicResource/assets?expand=all
-
attributes,attributes.menuItems,attributes.menuItems.translations
Return attributes, attribute menu items, and attribute menu item translations./rest/v17/commerceProcesses/transaction/documents/quote?expand=attributes,attributes.menuItems,attributes.menuItems.translations
-
childAssests.all
- Expand a child asset object and its children./rest/v17/dynamicResource/assets?expand=childAssests.all
-
childAssets*.all
- Recursively expand an asset object and all children assets./rest/v17/dynamicResource/assets?expand=childAssets*.all
-
childAssets*.all& fields=childAssets.partNumber
- Recursively expand and activate specified fields. It will only activate and retrieve fields specified in the query./rest/v17/dynamicResource/assets?expand=childAssets*.all&fields=childAssets.partNumber
-
childAssets.wrongname.all
- Expand a non-existing object. Child wrongname at path childAssets.wrongname does not exist or is not accessible in childAssets object for current use./rest/v17/dynamic/assets?expand=childAssets.wrongname.all