new module:api/CommandsApi(apiClient)
Constructs a new CommandsApi.
Parameters:
| Name | Type | Description |
|---|---|---|
apiClient |
module:ApiClient | Optional API client implementation to use, default to module:ApiClient#instance if unspecified. |
- Source:
Methods
_commandsApiCall(projectId, opts, body, oauth2client, credentials)
private method
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
projectId |
String | the project id |
||||||
opts |
Object | Optional parameters Properties
|
||||||
body |
Object | API payload |
||||||
oauth2client |
Object | oauth2client for the call |
||||||
credentials |
Object | credentials for the call |
- Source:
checkPermission(projectId, opts, body, oauth2client, credentials)
Checks if a user has permission to perform specified actions on specified resources.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
projectId |
String | the project id |
||||||
opts |
Object | Optional parameters Properties
|
||||||
body |
Object | API payload |
||||||
oauth2client |
Object | oauth2client for the call |
||||||
credentials |
Object | credentials for the call |
- Source:
createFolder(projectId, opts, body, oauth2client, credentials)
Creates folders in BIM 360 Docs.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
projectId |
String | the project id |
||||||
opts |
Object | Optional parameters Properties
|
||||||
body |
Object | API payload |
||||||
oauth2client |
Object | oauth2client for the call |
||||||
credentials |
Object | credentials for the call |
- Deprecated:
- Please use the POST /folders API instead (FoldersApi.postFolder2())
- Source:
getPublishModelJob(projectId, opts, body, oauth2client, credentials)
Verifies whether a Collaboration for Revit (C4R) model needs to be published to BIM 360 Docs.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
projectId |
String | the project id |
||||||
opts |
Object | Optional parameters Properties
|
||||||
body |
Object | API payload |
||||||
oauth2client |
Object | oauth2client for the call |
||||||
credentials |
Object | credentials for the call |
- Source:
listItems(projectId, opts, body, oauth2client, credentials)
Retrieves metadata for up to 50 specified items. For example, an item name, or the date it was created. It returns the tip (latest) version of the items.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
projectId |
String | the project id |
||||||
opts |
Object | Optional parameters Properties
|
||||||
body |
Object | API payload |
||||||
oauth2client |
Object | oauth2client for the call |
||||||
credentials |
Object | credentials for the call |
- Source:
listRefs(projectId, opts, body, oauth2client, credentials)
Retrieves the custom relationships between specified versions of items and other resources in the data domain service (folders, items, and versions). You can retrieve the relationships of up to 50 versions.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
projectId |
String | the project id |
||||||
opts |
Object | Optional parameters Properties
|
||||||
body |
Object | API payload |
||||||
oauth2client |
Object | oauth2client for the call |
||||||
credentials |
Object | credentials for the call |
- Source:
publishModel(projectId, opts, body, oauth2client, credentials)
Publishes the latest version of a Collaboration for Revit (C4R) model to BIM 360 Docs.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
projectId |
String | the project id |
||||||
opts |
Object | Optional parameters Properties
|
||||||
body |
Object | API payload |
||||||
oauth2client |
Object | oauth2client for the call |
||||||
credentials |
Object | credentials for the call |
- Source: