Class: module:api/FoldersApi

module:api/FoldersApi(apiClient)

new module:api/FoldersApi(apiClient)

Constructs a new FoldersApi.

Parameters:
Name Type Description
apiClient module:ApiClient

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

Methods

getFolder(projectId, folderId, oauth2client, credentials)

Returns the folder by ID for any folder within a given project. All folders or sub-folders within a project are associated with their own unique ID, including the root folder.

Parameters:
Name Type Description
projectId String

the project id
folderId String

the folder id data is of type: {module:model/Folder}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getFolder2(projectId, folderId, opts, oauth2client, credentials)

Returns the folder by ID for any folder within a given project. All folders or sub-folders within a project are associated with their own unique ID, including the root folder.

Parameters:
Name Type Description
projectId String

the project id
folderId String

the folder 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
ifModifiedSince String

If the requested object has not been modified since the time specified in this field, an entity will not be returned from the server; instead, a 304 (not modified) response will be returned without any message body. data is of type: {module:model/Folder}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getFolderContents(projectId, folderId, opts, opts['filter[*]<-modifier>', oauth2client, credentials)

Returns a collection of items and folders within a folder. Items represent word documents, fusion design files, drawings, spreadsheets, etc.

Parameters:
Name Type Description
projectId String

the project id
folderId String

the folder 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
filterType Array.<String>

filter by the type of the ref target
filterId Array.<String>

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

filter by the extension type
pageNumber Integer

specify the page number
pageLimit Integer

specify the maximal number of elements per page
includeHidden Boolean

Refers to items and folders that were deleted from BIM 360 Docs projects.
opts['filter[*]<-modifier>' Array.<*>

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

oauth2client for the call
credentials Object

credentials for the call
Source:

getFolderParent(projectId, folderId, oauth2client, credentials)

Returns the parent folder (if it exists). In a project, subfolders and resource items are stored under a folder except the root folder which does not have a parent of its own.

Parameters:
Name Type Description
projectId String

the project id
folderId String

the folder id data is of type: {module:model/Folder}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getFolderParent2(projectId, folderId, opts, oauth2client, credentials)

Returns the parent folder (if it exists). In a project, subfolders and resource items are stored under a folder except the root folder which does not have a parent of its own.

Parameters:
Name Type Description
projectId String

the project id
folderId String

the folder 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/Folder}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getFolderRefs(projectId, folderId, opts, opts['filter[*]<-modifier>', oauth2client, credentials)

Returns the resources (items, folders, and versions) which have a custom relationship with the given folder_id. Custom relationships can be established between a folder and other resources within the 'data' domain service (folders, items, and versions).

Parameters:
Name Type Description
projectId String

the project id
folderId String

the folder 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
filterType Array.<String>

filter by the type of the ref target
filterId Array.<String>

filter by the id 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/JsonApiCollection}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

Returns a collection of links for the given folder_id. Custom relationships can be established between a folder and other external resources residing outside the data domain service. A link’s href defines the target URI to access a resource.

Parameters:
Name Type Description
projectId String

the project id
folderId String

the folder 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
filterType Array.<String>

filter by the type of the ref target
filterId Array.<String>

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

filter by the extension type
filterMimeType Array.<String>

Filter by mime type.
opts['filter[*]<-modifier>' Array.<*>

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

oauth2client for the call
credentials Object

credentials for the call
Source:

getFolderRelationshipsRefs(projectId, folderId, opts, opts['filter[*]<-modifier>', oauth2client, credentials)

Returns the custom relationships that are associated to the given folder_id. Custom relationships can be established between a folder and other resources within the 'data' domain service (folders, items, and versions).

Parameters:
Name Type Description
projectId String

the project id
folderId String

the folder 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
filterType Array.<String>

filter by the type of the ref target
filterId Array.<String>

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

filter by refType
filterDirection module:model/String

filter by the direction of the reference
filterExtensionType Array.<String>

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

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

oauth2client for the call
credentials Object

credentials for the call
Source:

patchFolder(projectId, folderId, opts, body, oauth2client, credentials)

Modifies folder names. You can also use this endpoint to delete and restore BIM 360 Docs folders by using the hidden attribute.

Parameters:
Name Type Description
projectId String

the project id
folderId String

the folder 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
body Object

describe the ref to be created
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

postFolder(projectId, body, oauth2client, credentials)

Creates a new folder in the data domain service

Parameters:
Name Type Description
projectId String

the project id
body module:model/CreateFolder

describe the folder to be created
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

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

Creates a new folder in the data domain service

Parameters:
Name Type Description
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
body module:model/CreateFolder

describe the folder to be created
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

postFolderRelationshipsRef(projectId, folderId, body, oauth2client, credentials)

Creates a custom relationship between a folder and another resource within the 'data' domain service (folder, item, or version).

Parameters:
Name Type Description
projectId String

the project id
folderId String

the folder id
body module:model/CreateRef

describe the ref to be created
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

postFolderRelationshipsRef2(projectId, folderId, opts, body, oauth2client, credentials)

Creates a custom relationship between a folder and another resource within the 'data' domain service (folder, item, or version).

Parameters:
Name Type Description
projectId String

the project id
folderId String

the folder 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
body module:model/CreateRef

describe the ref to be created
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

Filters the data of a folder and recursively in the subfolders of any project accessible to you.

Parameters:
Name Type Description
projectId String

the project id
folderId String

the folder id
opts Object

Optional parameters
opts['filter[*]<-modifier>' Array.<*>

generic filter / <-modifier> is optional
opts.pageNumber Integer

specify the page number data is of type: {module:model/Refs}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source: