Request

Response

    Queries

    elementsByFolder

    GraphQL: Query

    Retrieves elements from given folder, using additional RSQL filters if provided.

    Template for Query:

    query GetElementsByFolder($projectId: ID!, $folderId: ID!, $filter: ElementFilterInput, $pagination: PaginationInput) {
      elementsByFolder(projectId: $projectId, folderId: $folderId, filter: $filter, pagination: $pagination) {
        # ElementsByFolder Fields
      }
    }
    

    Template for Query Variables:

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


    Arguments

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

    Possible Returns

    Value TypeDescription
    Elements Contains a list of Elements returned in response to a query.


    Examples

    Example 1

    Retrieves elements of category ‘Windows’ across elementgroups under a folder by folder ID.

    Query:

    query GetElementsByFolder($folderId: ID!, $filter: ElementFilterInput, $pagination: PaginationInput) {
      elementsByFolder(folderId: $folderId, filter: $filter, pagination: $pagination) {
        pagination {
          pageSize
          cursor
        }
        results {
          id
          name
        }
      }
    }
    
    Show More

    Query Variables:

    {
      "folderId": "Zm9sZH5iLmU0ZmJkMzE1LTJkYzUtNDAyNi04Y2EzLTgwZjA5ZDI0ZmY0Mn5iLjdhZGJmOWZkLWRlYmItNDI5Yy1iZmU1LTMyYTNjMjJjMDY5NX51cm46YWRzay53aXBzdGc6ZnMuZm9sZGVyOmNvLlhvSG9RY3pHUm9LczVZRm4yUDNpWlE",
      "filter": {
        "query": "property.name.category==Windows and 'property.name.Element Context'==Instance"
      },
      "pagination": {
        "limit": 5
      }
    }
    
    Show More

    Response:

    {
      "data": {
        "elementsByFolder": {
          "pagination": {
            "pageSize": 5,
            "cursor": "YWRjdXJzfk5VTEx-QlE9PX41"
          },
          "results": [
            {
              "id": "YWVjZX5FMnRqOFJFOXRsSlRQNU9WVzBiaDZ4X0wyQ35QQllLNWlOb1NsQ283QVpEOVdUM0V3XzEyM2ViN2M",
              "name": "32.10-sparing tbv installaties_1400x600"
            },
            {
              "id": "YWVjZX5FMnRqOFJFOXRsSlRQNU9WVzBiaDZ4X0wyQ35QQllLNWlOb1NsQ283QVpEOVdUM0V3XzEyM2ViN2Q",
              "name": "32.10-sparing tbv installaties_1100x650"
            },
            {
              "id": "YWVjZX5FMnRqOFJFOXRsSlRQNU9WVzBiaDZ4X0wyQ35QQllLNWlOb1NsQ283QVpEOVdUM0V3XzEyM2ViODY",
              "name": "32.10-sparing tbv installaties_500x300"
            },
            {
              "id": "YWVjZX5FMnRqOFJFOXRsSlRQNU9WVzBiaDZ4X0wyQ35QQllLNWlOb1NsQ283QVpEOVdUM0V3XzEyM2ViOGE",
              "name": "32.10-sparing tbv installaties_625x150"
            },
            {
              "id": "YWVjZX5FMnRqOFJFOXRsSlRQNU9WVzBiaDZ4X0wyQ35QQllLNWlOb1NsQ283QVpEOVdUM0V3XzEyM2ViOGM",
              "name": "32.10-sparing tbv installaties_400x150"
            }
          ]
        }
      }
    }
    
    Show More