Initializes new client with specific authentication method.
Authentication object,
containing either client_id
and client_secret
properties (for 2-legged authentication),
or a single token
property (for 2-legged or 3-legged authentication with pre-generated access token).
Creates new BIM360 issue. Requires 3-legged token. https://forge.autodesk.com/en/docs/bim360/v1/reference/http/field-issues-POST.
ID of container storing all issues for a specific projects.
New issue attributes.
New issue details.
Creates new attachment associated with a BIM360 issue. https://forge.autodesk.com/en/docs/bim360/v1/reference/http/field-issues-attachments-POST.
ID of container storing all issues for a specific projects.
New issue attachment.
Creates new comment associated with a BIM360 issue. https://forge.autodesk.com/en/docs/bim360/v1/reference/http/field-issues-comments-POST.
ID of container storing all issues for a specific projects.
Issue ID.
New issue comment.
Creates next version of uploaded files (items).
The project Id.
The name of the file.
The ID of the item.
The storage location Id.
Specific version of an item.
Creates a storage location in the OSS where data can be uploaded to.
Project Id.
Displayable name of the resource.
The type of this resource. Possible values: folders, items.
Id of the resource.
A storage location.
Creates versions of uploaded files (items) and makes copies of existing files.
The project Id.
Displayable name of an item.
The folder Id.
The storage location Id.
Specific version of an item.
Returns the folder by ID for any folder within a given project. (https://forge.autodesk.com/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-GET/).
Project ID.
Folder ID.
Folder details.
Gets details of specific hub (https://forge.autodesk.com/en/docs/data/v2/reference/http/hubs-hub_id-GET).
Hub ID.
Hub details or null if there isn't one.
Retrieves ID of container for issues of specific BIM360 project.
Hub ID.
Project ID.
Issue container ID if there is one, otherwise null.
Obtains detail information about BIM360 issue. Requires 3-legged token. https://forge.autodesk.com/en/docs/bim360/v1/reference/http/field-issues-:id-GET.
ID of container storing all issues for a specific projects.
Issue ID.
Issue details.
Gets details of an item (https://forge.autodesk.com/en/docs/data/v2/reference/http/projects-project_id-items-item_id-GET).
Project ID.
Item ID.
Item details.
Retrieves ID of container for locations of specific BIM360 project. Note: this API is not yet officially documented and supported!
Hub ID.
Project ID.
Location container ID if there is one, otherwise null.
Gets details of specific project (https://forge.autodesk.com/en/docs/data/v2/reference/http/hubs-hub_id-projects-project_id-GET).
Hub ID.
Project ID.
Hub details or null if there isn't one.
Gets "tip" version of a folder item (https://forge.autodesk.com/en/docs/data/v2/reference/http/projects-project_id-items-item_id-tip-GET).
Project ID.
Item ID.
Tip version of the item.
Query the details of a specific user. https://forge.autodesk.com/en/docs/bim360/v1/reference/http/users-:user_id-GET.
The account ID of the users. This corresponds to hub ID in the Data Management API. To convert a hub ID into an account ID you need to remove the “b.” prefix. For example, a hub ID of b.c8b0c73d-3ae9 translates to an account ID of c8b0c73d-3ae9.
User ID.
User details.
Gets specific version of a folder item (https://forge.autodesk.com/en/docs/data/v2/reference/http/projects-project_id-versions-version_id-GET).
Project ID.
Item ID (@deprecated, will be removed in next major version).
Version ID.
Specific version of folder item.
Gets contents of a folder (https://forge.autodesk.com/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-contents-GET).
Project ID.
Folder ID.
List of folder contents.
Gets a list of all hubs accessible to given credentials (https://forge.autodesk.com/en/docs/data/v2/reference/http/hubs-GET).
List of hubs.
Lists all attachments associated with a BIM360 issue. Requires 3-legged token. https://forge.autodesk.com/en/docs/bim360/v1/reference/http/field-issues-attachments-GET.
ID of container storing all issues for a specific projects.
Issue ID.
Issue attachments.
Lists all comments associated with a BIM360 issue. Requires 3-legged token. https://forge.autodesk.com/en/docs/bim360/v1/reference/http/field-issues-:id-comments-GET.
ID of container storing all issues for a specific projects.
Issue ID.
Issue comments.
Retrieves a list of supported root causes that you can allocate to an issue. https://forge.autodesk.com/en/docs/bim360/v1/reference/http/root-causes-GET.
ID of container storing all issues for a specific projects.
Issue root causes.
Lists issue types in specific container. https://forge.autodesk.com/en/docs/bim360/v1/reference/http/ng-issue-types-GET.
ID of container storing all issues for a specific projects.
List of issues types.
Lists all issues in a BIM360 project. Requires 3-legged token. https://forge.autodesk.com/en/docs/bim360/v1/reference/http/field-issues-GET.
ID of container storing all issues for a specific projects.
List of matching issues.
Retrieves details about the locations (nodes) for a project. Note: this API is not yet officially documented and supported!
Location container ID retrieved using getLocationContainerID.
Location nodes.
Gets a list of all projects in a hub (https://forge.autodesk.com/en/docs/data/v2/reference/http/hubs-hub_id-projects-GET).
Hub ID.
List of projects.
Gets a list of top folders in a project (https://forge.autodesk.com/en/docs/data/v2/reference/http/hubs-hub_id-projects-project_id-topFolders-GET).
Hub ID.
Project ID.
List of folder records.
Lists all users in BIM 360 account, or just users matching specific criteria. https://forge.autodesk.com/en/docs/bim360/v1/reference/http/users-GET. https://forge.autodesk.com/en/docs/bim360/v1/reference/http/users-search-GET.
The account ID of the users. This corresponds to hub ID in the Data Management API. To convert a hub ID into an account ID you need to remove the “b.” prefix. For example, a hub ID of b.c8b0c73d-3ae9 translates to an account ID of c8b0c73d-3ae9.
List of users.
Gets versions of a folder item (https://forge.autodesk.com/en/docs/data/v2/reference/http/projects-project_id-items-item_id-versions-GET).
Project ID.
Item ID.
List of item versions.
Updates existing BIM360 issue. Requires 3-legged token. https://forge.autodesk.com/en/docs/bim360/v1/reference/http/field-issues-:id-PATCH.
ID of container storing all issues for a specific projects.
ID of updated issue.
Issue attributes to update.
Updated issue details.
Generated using TypeDoc
Client providing access to Autodesk Forge BIM360 APIs.