Request

Response

    Queries

    elementGroupsByProject

    GraphQL: Query

    Retrieves elementGroups in the given project, using additional RSQL filters if provided.

    Template for Query:

    query GetElementGroupsByProject($projectId: ID!, $filter: ElementGroupFilterInput, $pagination: PaginationInput) {
      elementGroupsByProject(projectId: $projectId, filter: $filter, pagination: $pagination) {
        # ElementGroupsByProject Fields
      }
    }
    

    Template for Query Variables:

    {
      "projectId" : "<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.
    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