Request

Response

    Queries

    elementGroupsByFolderAndSubFolders

    query

    Retrieves elementGroups in the given folder and it's sub-folders recursively, using additional RSQL filters if provided.

    Template for Query:

    query GetElementGroupsByFolderAndSubFolders($projectId: ID!, $folderId: ID!, $filter: ElementGroupFilterInput, $pagination: PaginationInput) {
      elementGroupsByFolderAndSubFolders(projectId: $projectId, folderId: $folderId, filter: $filter, pagination: $pagination) {
        # ElementGroupsByFolderAndSubFolders Fields
      }
    }
    

    Template for Query Variables:

    {
      "projectId" : "<SOME-ID-TYPE-SCALAR-VALUE>",
      "folderId" : "<SOME-ID-TYPE-SCALAR-VALUE>",
      "filter" : "<SOME-ELEMENTGROUPFILTER-INPUT-TYPE-VALUE>",
      "pagination" : "<SOME-PAGINATION-INPUT-TYPE-VALUE>"
    }
    


    Arguments

    projectId*
    ID! non-null
    Project to retrieve elementGroups from.
    folderId*
    ID! non-null
    Folder to recursively retrieve elementGroups from.
    filterRSQL filter to use for searching elementGroups.
    paginationSpecifies how to split the response into multiple pages.
    * Required

    Possible Returns

    Value TypeDescription
    ElementGroups! non-null Contains a list of ElementGroups returned in response to a query.


    Examples