Request

Response

    Queries

    hubByDataManagementAPIId

    query

    Retrieves an object representing a hub by its external id.

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

    Template for Query:

    query GetHubByDataManagementAPIId($dataManagementAPIHubId: ID!) {
      hubByDataManagementAPIId(dataManagementAPIHubId: $dataManagementAPIHubId) {
        # Hub Fields
      }
    }
    

    Arguments

    dataManagementAPIHubId*
    ID! non-null
    The external 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 hub members.


    Examples

    Example 1

    Retrieves a hub by legacy DataManagementAPI Hub ID.

    Query:

    query GetHub($dataManagementAPIHubId: ID!) {
     hubByDataManagementAPIId(dataManagementAPIHubId: $dataManagementAPIHubId) {
       id
       name
       __typename
       alternativeIdentifiers {
         dataManagementAPIHubId
       }
     }
     }
    
    Show More

    Query Variables:

    {
     "dataManagementAPIHubId": "a.YnVzaW5lc3M6eW9wbWFpbDkxNjM"
    }
    

    Response:

    {
       "data": {
           "hubByDataManagementAPIId": {
               "id": "urn:adsk.ace:beta.scope:02dd340f-3e84-4db8-b6a1-56a964a202c7",
               "name": "Manufacturing Data Model API Version 3",
               "__typename": "Hub",
               "alternativeIdentifiers": {
                   "dataManagementAPIHubId": "a.YnVzaW5lc3M6eW9wbWFpbDkxNjM"
               }
           }
       }
    }
    
    Show More