tm_af_child_structures: Get child structures by parent structure ID

Description Usage Arguments Value Examples

Description

Gets the structures that have a parent defined by parent_id and returns them in a data frame.

Usage

1
tm_af_child_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.

Value

A data frame with child structures of parent_id or an empty list in case parent_id is a leaf node.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## Not run: 
token <- tm_token()
roots <- tm_af_root_structures(token)

# Get child structures of the first root structure
tm_af_child_structures(token, roots$structureId[1])

# Get child structures by specific parent structure ID
tm_af_child_structures(token, "e5225244-c6de-48c2-87da-5b51b65062e8")

## End(Not run)

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