Class: module:api/ProjectsApi

module:api/ProjectsApi(apiClient)

new module:api/ProjectsApi(apiClient)

Constructs a new ProjectsApi.

Parameters:
Name Type Description
apiClient module:ApiClient

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

Methods

getDownload(projectId, downloadId, opts, oauth2client, credentials)

Returns the details for a specific download.

Parameters:
Name Type Description
projectId String

the project id
downloadId String

The unique identifier of a download job.
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/TopFolders}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

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

Returns a collection of projects for a given hub_id. A project represents an A360 project or a BIM 360 project which is set up under an A360 hub or BIM 360 account, respectively. Within a hub or an account, multiple projects can be created to be used.

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
filterId Array.<String>

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

filter by the extension type
pageNumber Array.<Integer>

Specify the page number.
pageLimit Array.<Integer>

Specify the maximal number of elements per page.
opts['filter[*]<-modifier>' Array.<*>

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

oauth2client for the call
credentials Object

credentials for the call
Source:

getJob(projectId, jobId, opts, oauth2client, credentials)

Returns the job_id object.

Parameters:
Name Type Description
projectId String

the project id
jobId String

The unique identifier of a job.
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/TopFolders}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getProject(hubId, projectId, oauth2client, credentials)

Returns a project for a given project_id.

Parameters:
Name Type Description
hubId String

the hub id for the current operation
projectId String

the project id data is of type: {module:model/Project}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getProject2(hubId, projectId, opts, oauth2client, credentials)

Returns a project for a given project_id.

Parameters:
Name Type Description
hubId String

the hub id for the current operation
projectId String

the project id
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/Project}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getProjectHub(hubId, projectId, oauth2client, credentials)

Returns the hub for a given project_id.

Parameters:
Name Type Description
hubId String

the hub id for the current operation
projectId String

the project id data is of type: {module:model/Hub}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getProjectHub2(hubId, projectId, opts, oauth2client, credentials)

Returns the hub for a given project_id.

Parameters:
Name Type Description
hubId String

the hub id for the current operation
projectId String

the project id
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:

getProjectTopFolders(hubId, projectId, oauth2client, credentials)

Returns the details of the highest level folders the user has access to for a given project

Parameters:
Name Type Description
hubId String

the hub id for the current operation
projectId String

the project id data is of type: {module:model/TopFolders}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getProjectTopFolders2(hubId, projectId, opts, oauth2client, credentials)

Returns the details of the highest level folders the user has access to for a given project

Parameters:
Name Type Description
hubId String

the hub id for the current operation
projectId String

the project id
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/TopFolders}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

postDownload(projectId, body, opts, oauth2client, credentials)

Request the creation of a new download for a specific and supported file type.

Parameters:
Name Type Description
projectId String

the project id
body module:model/CreateStorage

describe the file the storage is created for
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/StorageCreated}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

postStorage(projectId, body, oauth2client, credentials)

Creates a storage location in the OSS where data can be uploaded to.

Parameters:
Name Type Description
projectId String

the project id
body module:model/CreateStorage

describe the file the storage is created for data is of type: {module:model/StorageCreated}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

postStorage2(projectId, body, opts, oauth2client, credentials)

Creates a storage location in the OSS where data can be uploaded to.

Parameters:
Name Type Description
projectId String

the project id
body module:model/CreateStorage

describe the file the storage is created for
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/StorageCreated}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source: