item_list_children: Return IDs for all child items

In sbtools: USGS ScienceBase Tools

Return IDs for all child items

Description

Returns a list of child IDs for a ScienceBase item

Usage

item_list_children(
  sb_id,
  fields = c("id", "title"),
  ...,
  session = current_session(),
  limit = 20
)

Arguments

sb_id	An sbitem object or a character ScienceBase ID corresponding to the item
fields	A character vector of requested data fields. Defaults to 'id' and 'title'. Full list of possible fields is available online in SB documentation.
...	Additional parameters are passed on to GET, POST, HEAD, PUT, or DELETE
session	Session object from authenticate_sb. Defaults to anonymous or last authenticated session
limit	Max children returned.

Value

List of sbitem for each child item.

Examples

## Not run: 
item_list_children(user_id())

## End(Not run)


item_list_children(as.sbitem('5060b03ae4b00fc20c4f3c8b'))
item_list_children(item_get('5060b03ae4b00fc20c4f3c8b'))

sbtools documentation built on May 1, 2023, 1:07 a.m.