Class: module:api/HubsApi

module:api/HubsApi(apiClient)

new module:api/HubsApi(apiClient)

Constructs a new HubsApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use, default to module:ApiClient#instance if unspecified.
Source:

Methods

getHub(hubId, oauth2client, credentials)

Returns data on a specific hub_id.

Parameters:
Name Type Description
hubId String

the hub id for the current operation data is of type: {module:model/Hub}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getHub2(hubId, opts, oauth2client, credentials)

Returns data on a specific hub_id.

Parameters:
Name Type Description
hubId String

the hub id for the current operation
opts Object

Optional parameters

Properties
Name Type Description
xuserid String

API call will be limited to act on behalf of only the user specified data is of type: {module:model/Hub}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getHubs(opts, opts['filter[*]<-modifier>', oauth2client, credentials)

Returns a collection of accessible hubs for this member. A Hub represents an A360 Team/Personal hub or a BIM 360 account.

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
xuserid String

API call will be limited to act on behalf of only the user specified
filterId Array.<String>

filter by the id of the ref target
filterName Array.<String>

filter by the name of the ref target
filterExtensionType Array.<String>

filter by the extension type
opts['filter[*]<-modifier>' Array.<*>

generic filter / <-modifier> is optional data is of type: {module:model/Hubs}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source: