You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We'd like to propose extending getMyDataCollectionItems with the same search capabilities of getCollectionItems (see related feature request: #489). The existing behavior and parameters should remain unchanged.
Collection information
Add a showCollections option. When enabled, the /mydata/retrieve request should include show_collections=true and dataset results should expose their associated collections as CollectionSummary[].
(Same as proposed for getCollectionItems)
Metadata fields
Add support for:
metadataFields, accepting multiple values in the metadataBlockName:fieldName format
keepRawFields, controlling whether metadata values are preserved or transformed to Markdown
(Same as proposed for getCollectionItems)
Filter queries
Add support for the /mydata/retrieve fq parameter using:
filterQueries?: string | string[]
(Same as proposed for getCollectionItems)
Sorting
Add standalone sort and order options corresponding to the existing SortType and OrderType values. These should be passed through as the /mydata/retrieve sort and order query parameters.
Design consideration
I considered reusing CollectionSearchCriteria to implement the fq, sort and order support, but it also contains searchText and itemTypes, which getMyDataCollectionItems already accepts as separate parameters (searchText and collectionItemTypes), so reusing it would create duplicate/conflicting inputs, creating a confusing use case interface. So I think standalone filterQueries, sort, and order parameters make more sense.
If CollectionSearchCriteria is to be reused, the searchText and collectionItemTypes params should be removed, but that would be a backwards-incompatible change.
Activity