tm_af_descendant_structures: Get descendant structures by parent structure ID

In TrendMiner/trendminer: R client for the 'TrendMiner' API

Description

Retrieves the entire structure subtree underneath parent_id and returns it as a data frame.

Usage

tm_af_descendant_structures(token, parent_id, ...)

Arguments

token	A valid access token
parent_id	Parent structure ID in UUID format
...	Additional arguments passed on to the underlying HTTP method. This might be necessary if you need to set some curl options explicitly via config.

Details

tm_af_descendant_structures() leverages tm_af_child_structures() in recursive calls to fetch the entire subtree structure underneath parent_id. Use tm_af_descendant_structures() with caution in case you have a broad and deeply nested asset structure underneath parent_id.

Value

A data frame with all descendant structures of parent_id.

Examples

## Not run: 
token <- tm_token()
roots <- tm_af_root_structures(token)

# Get descendant subtree structure underneath second root structure
tm_af_descendant_structures(token, roots$structureId[2])

# Get descendant subtree by specific parent structure id
tm_af_descendant_structures(token, "4e58e3ca-e57d-47b5-8619-20d39626116e")

## End(Not run)

TrendMiner/trendminer documentation built on Jan. 30, 2020, 12:21 a.m.