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
Copy file name to clipboardExpand all lines: docs/useCases.md
+58Lines changed: 58 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -215,6 +215,64 @@ This use case supports the following optional parameters depending on the search
215
215
-**offset**: (number) Offset for pagination.
216
216
-**collectionSearchCriteria**: ([CollectionSearchCriteria](../src/collections/domain/models/CollectionSearchCriteria.ts)) Supports filtering the collection items by different properties.
217
217
218
+
#### List My Data Collection Items
219
+
220
+
Returns an instance of [MyDataCollectionItemSubset](../src/collections/domain/models/CollectionItemSubset.ts) that contains reduced information for each collection item for which the calling user has a role.
The `roleIds` parameter is an array of role identifiers that the user has in the collection items. At least one roleId must be specified.
261
+
The `collectionItemTypes` parameter is an array of collection item types to filter the results. At least one collectionItemType must be specified.
262
+
The `publishingStatuses` parameter is an array of publishing statuses to filter the results. At least one publishingStatus must be specified.
263
+
264
+
This use case supports the following optional parameters depending on the search goals:
265
+
266
+
The `searchText` parameter is an optional string to filter the results by.
267
+
The `otherUserName` parameter is an optional string to return the collection items of another user. If not set, the calling user will be used. Only superusers can use this parameter.
268
+
The `MyDataCollectionItemSubset`returned instance contains a property called `totalItemCount` which is necessary for pagination.
269
+
270
+
This use case supports the following optional parameters depending on the search goals:
271
+
272
+
-**limit**: (number) Limit for pagination.
273
+
-**offset**: (number) Offset for pagination.
274
+
-**collectionSearchCriteria**: ([CollectionSearchCriteria](../src/collections/domain/models/CollectionSearchCriteria.ts)) Supports filtering the collection items by different properties.
275
+
218
276
#### Get Collection Featured Items
219
277
220
278
Returns a [CollectionFeaturedItem](../src/collections/domain/models/CollectionFeaturedItem.ts) array containing the featured items of the requested collection, given the collection identifier or alias.
0 commit comments