Class: module:api/ItemsApi

module:api/ItemsApi(apiClient)

new module:api/ItemsApi(apiClient)

Constructs a new ItemsApi.

Parameters:
Name Type Description
apiClient module:ApiClient

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

Methods

getItem(projectId, itemId, oauth2client, credentials)

Returns a resource item by ID for any item within a given project. Resource items represent word documents, fusion design files, drawings, spreadsheets, etc.

Parameters:
Name Type Description
projectId String

the project id
itemId String

the item id data is of type: {module:model/Item}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getItem2(projectId, itemId, opts, oauth2client, credentials)

Returns a resource item by ID for any item within a given project. Resource items represent word documents, fusion design files, drawings, spreadsheets, etc.

Parameters:
Name Type Description
projectId String

the project id
itemId String

the item 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
includePathInProject Boolean

Specify whether to return pathInProject attribute in response for BIM 360 Docs projects. data is of type: {module:model/Item}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getItemParentFolder(projectId, itemId, oauth2client, credentials)

Returns the "parent" folder for the given item.

Parameters:
Name Type Description
projectId String

the project id
itemId String

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

oauth2client for the call
credentials Object

credentials for the call
Source:

getItemParentFolder2(projectId, itemId, opts, oauth2client, credentials)

Returns the "parent" folder for the given item.

Parameters:
Name Type Description
projectId String

the project id
itemId String

the item 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:

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

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

Parameters:
Name Type Description
projectId String

the project id
itemId String

the item 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 the custom relationships that are associated to the given item_id. Custom relationships can be established between an item and other resources within the 'data' domain service (folders, items, and versions).

Parameters:
Name Type Description
projectId String

the project id
itemId String

the item 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/Refs}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

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

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

Parameters:
Name Type Description
projectId String

the project id
itemId String

the item 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:

getItemTip(projectId, itemId, oauth2client, credentials)

Returns the &quot;tip&quot; version for the given item. Multiple versions of a resource item can be uploaded in a project. The tip version is the most recent one.

Parameters:
Name Type Description
projectId String

the project id
itemId String

the item id data is of type: {module:model/Version}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getItemTip2(projectId, itemId, opts, oauth2client, credentials)

Returns the &quot;tip&quot; version for the given item. Multiple versions of a resource item can be uploaded in a project. The tip version is the most recent one.

Parameters:
Name Type Description
projectId String

the project id
itemId String

the item 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/Version}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

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

Returns versions for the given item. Multiple versions of a resource item can be uploaded in a project.

Parameters:
Name Type Description
projectId String

the project id
itemId String

the item 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
filterVersionNumber Array.<Integer>

filter by versionNumber
opts['filter[*]<-modifier>' Array.<*>

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

specify the page number
opts.pageLimit Integer

specify the maximal number of elements per page data is of type: {module:model/Versions}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

patchItem(projectId, itemId, opts, body, oauth2client, credentials)

Updates the properties of the given item_id object.

Parameters:
Name Type Description
projectId String

the project id
itemId String

the item 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:

postItem(projectId, body, oauth2client, credentials)

Creates a new item in the 'data' domain service.

Parameters:
Name Type Description
projectId String

the project id
body module:model/CreateItem

describe the item to be created data is of type: {module:model/ItemCreated}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

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

Creates a new item in the 'data' domain service.

Parameters:
Name Type Description
projectId String

the project id
body module:model/CreateItem

describe the item to be created
opts Object

Optional parameters

Properties
Name Type Description
xuserid String

API call will be limited to act on behalf of only the user specified
copyFrom String

Only relevant for copying files to BIM 360 Docs - the version ID (URN) of the file to copy. data is of type: {module:model/ItemCreated}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

postItemRelationshipsRef(projectId, itemId, body, oauth2client, credentials)

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

Parameters:
Name Type Description
projectId String

the project id
itemId String

the item id
body module:model/CreateRef

describe the ref to be created
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

postItemRelationshipsRef2(projectId, itemId, opts, body, oauth2client, credentials)

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

Parameters:
Name Type Description
projectId String

the project id
itemId String

the item 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: