Subcollection

kind: collectionstate

A subcollection is a Collection that’s attached to a higher-level Resource object. Subcollections are almost exactly the same as collections; the exception is that they can only be accessed via the resource they’re attached to (the ‘parent’ resource). A subcollection can be identified by the value isSubcollection: true, followed by an items attribute listing the subcollection’s resources. Just as with collections, you can use get_collection() to get a list of the resources in the subcollection.

Note

In the above example, the subcollection object – members_s – ends in _s because the subcollection resource object name (members) is already plural.

The JSON returned for a pool with one member is shown below. Note the highlighted rows, which indicate the subcollection.