Function getCollectionItems

  • Retrieves items from a collection that the user has access to.

    Parameters

    • collectionId: string

      The collection's unique identifier. (This query also supports 'favorites' as the collectionID).

    • query: {
          limit?: number;
          name?: string;
          next?: string;
          noActions?: boolean;
          prev?: string;
          query?: string;
          resourceId?: string;
          resourceLink?: string;
          resourceType?: ItemResourceTypeEnum;
          shared?: boolean;
          sort?:
              | "-name"
              | "+name"
              | "+createdAt"
              | "-createdAt"
              | "+updatedAt"
              | "-updatedAt";
          spaceId?: string;
      }

      an object with query parameters

      • Optionallimit?: number

        The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive).

      • Optionalname?: string
      • Optionalnext?: string
      • OptionalnoActions?: boolean
      • Optionalprev?: string
      • Optionalquery?: string
      • OptionalresourceId?: string
      • OptionalresourceLink?: string
      • OptionalresourceType?: ItemResourceTypeEnum
      • Optionalshared?: boolean

        Whether or not to return items in a shared space.

      • Optionalsort?: "-name" | "+name" | "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt"
      • OptionalspaceId?: string
    • Optionaloptions: ApiCallOptions

    Returns Promise<GetCollectionItemsHttpResponse>

    GetCollectionItemsHttpError