Request

Response

    Queries

    hub

    GraphQL: Query

    Retrieves an object representing a hub.

    A Hub is a container of projects, shared resources, and users with a common context.

    Template for Query:

    query GetHub($hubId: ID!) {
      hub(hubId: $hubId) {
        # Hub Fields
      }
    }
    

    Template for Query Variables:

    {
      "hubId" : "<SOME-ID-TYPE-SCALAR-VALUE>"
    }
    


    Arguments

    hubId*
    ID! non-null
    The ID of the hub to return.
    * Required

    Possible Returns

    Value TypeDescription
    Hub Represents a hub. A hub is a container of projects, shared resources, and users with a common context.


    Examples

    Example 1

    Retrieves a hub by ID along with its projects.

    Query:

    query GetHub($hubId: ID!) {
      hub(hubId: $hubId){
          id
          name
          projects {
              results{
                  id
                  name
              }
           }
        }
     }
    
    Show More

    Query Variables:

    {
     "hubId": "b.768cae14-76b3-4531-9030-25212dab4e48"
    }
    

    Response:

    {
      "data": {
          "hub": {
              "id": "b.768cae14-76b3-4531-9030-25212dab4e48",
              "name": "Construction Records Testing",
              "projects": {
                  "results": [
                      {
                          "id": "cHJvan5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjIyYTVkYzQ3LWNhMTktNDIzMS05ZjNlLTE1N2ViZDQ4NDJmZg",
                          "name": "DataExchange-Graph"
                      },
                      {
                          "id": "cHJvan5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjViYWI0YWUzLTRjM2QtNDMxYi05NWQzLWViMjJlOGU1MDg5NA",
                          "name": "Data Exchanges"
                      }
                  ]
              }
          }
        }
      }
    
    Show More