Function getItems

Parameters

• query: {
      collectionId?: string;
      createdByUserId?: string;
      id?: string;
      limit?: number;
      name?: string;
      next?: string;
      noActions?: boolean;
      notCreatedByUserId?: string;
      notOwnerId?: string;
      ownerId?: string;
      prev?: string;
      query?: string;
      resourceId?: string;
      resourceIds?: string;
      resourceLink?: string;
      resourceSubType?: string;
      resourceType?: ItemResourceTypeEnum;
      shared?: boolean;
      sort?:
          | "-name"
          | "+name"
          | "+createdAt"
          | "-createdAt"
          | "+updatedAt"
          | "-updatedAt"
          | "+recentlyUsed"
          | "-recentlyUsed";
      spaceId?: string;
      spaceType?: SpaceTypeEnum;
  }

  an object with query parameters

  • OptionalcollectionId?: string

    The collection's unique identifier. Used to filter for items with a specific tag (collection type public), or collection.

  • OptionalcreatedByUserId?: string

    User's unique identifier.

  • Optionalid?: string

    The item's unique identifier.

  • 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

    The case-insensitive string used to search for a resource by name.

  • Optionalnext?: string

    The cursor to the next page of resources. Provide either the next or prev cursor, but not both.

  • OptionalnoActions?: boolean

    If set to true, the user's available actions for each item will not be evaluated meaning the actions-array will be omitted from the response (reduces response time).

  • OptionalnotCreatedByUserId?: string

    User's unique identifier.

  • OptionalnotOwnerId?: string

    Owner identifier.

  • OptionalownerId?: string

    Owner identifier.

  • Optionalprev?: string

    The cursor to the previous page of resources. Provide either the next or prev cursor, but not both.

  • Optionalquery?: string

    The case-insensitive string used to search for a resource by name or description.

  • OptionalresourceId?: string

    The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.

  • OptionalresourceIds?: string

    The case-sensitive strings used to search for an item by resourceIds. The maximum number of resourceIds it supports is 100. If resourceIds is provided, then resourceType must be provided. For example '?resourceIds=appId1,appId2'

  • OptionalresourceLink?: string

    The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.

  • OptionalresourceSubType?: string

    the case-sensitive string used to filter items by resourceSubType(s). For example '?resourceSubType=chart-monitoring,qix-df,qvd'. Will return a 400 error if used in conjuction with the square bracket syntax for resourceSubType filtering in the 'resourceType' query parameter.

  • OptionalresourceType?: ItemResourceTypeEnum

    The case-sensitive string used to filter items by resourceType(s). For example '?resourceType=app,qvapp'. Additionally, a optional resourceSubType filter can be added to each resourceType. For example '?resourceType=app[qvd,chart-monitoring],qvapp'. An trailing comma can be used to include the empty resourceSubType, e.g. '?resourceType=app[qvd,chart-monitoring,]', or, to include only empty resourceSubTypes, '?resourceType=app[]' This syntax replaces the 'resourceSubType' query param, and using both in the same query will result in a 400 error.

  • Optionalshared?: boolean

    Deprecated

    Whether or not to return items in a shared space.

  • Optionalsort?:
        | "-name"
        | "+name"
        | "+createdAt"
        | "-createdAt"
        | "+updatedAt"
        | "-updatedAt"
        | "+recentlyUsed"
        | "-recentlyUsed"

    The property of a resource to sort on (default sort is +createdAt). The supported properties are createdAt, updatedAt, recentlyUsed and name. A property must be prefixed by + or - to indicate ascending or descending sort order respectively.

  • OptionalspaceId?: string

    The space's unique identifier (supports 'personal' as spaceId).

  • OptionalspaceType?: SpaceTypeEnum

    The case-sensitive string used to filter items on space type(s). For example '?spaceType=shared,personal'.
• Optionaloptions: ApiCallOptions