pagedBundles

Returns a list of all the Bundles available to the authenticated user making this request. This will include:

1. bundles that are created by the logged-in user's account
2. bundles that are shared with the logged-in user's account. These shared bundles will have a sharingMode other than PRIVATE

An example of the request is as follows:

query {
    pagedBundles {
        bundles {
            id
            name
            description
            ownerAccountId
            publisher {
            id
            name
            }
            sharingMode
            createdBy
            createdDate
            modifiedBy
            modifiedDate
            bundleOwner
        }
        totalBundlesCount
    }
}

Additionally, you can control which bundles will be included in the response by using an optional input BundlesQueryInput. It has the following properties

1. BundleListingType (optional)

   The BundleListingType has the following two values:

   1. CREATED_BY_MY_ACCOUNT - Return only those bundles that are created by logged-in user's account
   2. SHARED_WITH_MY_ACCOUNT - Return only those bundles that are shared with logged-in user's account. These shared bundles will have a sharingMode other than PRIVATE
   3. Not specifying any value for BundleListingType will return all the Bundles available to the authenticated user making this request.

2. page (optional) This call supports pagination and through this parameter specify the page whose data is to be requested. Should be between 0 and 100 (boundary included).

3. bundlesPerPage (optional) The number of bundles to be displayed per page. Should be a positive integer up to 100.

4. sortColumn (optional) The sort column name.

5. sortOrder (optional) The SortOrder has the following two values:

   1. ASC - Return the list of bundles by the provided sort column in the ascending order
   2. DESC - Return the list of bundles by the provided sort column in the descending order

6. searchText (optional) The search text which is used in bundle name or bundle description

An example of the request is as follows:

        query{
            pagedBundles(input: {
                bundleListingType: CREATED_BY_MY_ACCOUNT,
                page:0,
                bundlesPerPage:10,
                sortColumn: "name",
                sortOrder: ASC,
                searchText: "test bundle"
            }){
                bundles {
                    id
                    name
                    description
                    ownerAccountId
                    publisher {
                    id
                    name
                    }
                    sharingMode
                    createdBy
                    createdDate
                    modifiedBy
                    modifiedDate
                    bundleOwner
                }
                totalBundlesCount
            }
        }

pagedBundles(
  input: BundlesQueryInput
): PaginatedBundle

Arguments

pagedBundles.input ● BundlesQueryInput input bundles

Type

PaginatedBundle object bundles