Skip to content

Latest commit

 

History

History
184 lines (107 loc) · 4.94 KB

ProjectsApi.md

File metadata and controls

184 lines (107 loc) · 4.94 KB

ProjectsApi

All URIs are relative to https://developer.api.autodesk.com/

Method HTTP request Description
getHubProjects GET /project/v1/hubs/{hub_id}/projects
getProject GET /project/v1/hubs/{hub_id}/projects/{project_id}
getProjectHub GET /project/v1/hubs/{hub_id}/projects/{project_id}/hub
postStorage POST /data/v1/projects/{project_id}/storage
postVersion POST /data/v1/projects/{project_id}/versions
topFolders GET /project/v1/hubs/{hub_id}/projects/{project_id}/hub

getHubProjects

Projects getHubProjects(hubId, filterId, filterExtensionType)

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 Notes
hubId String the `hub id` for the current operation
filterId List<String> filter by the `id` of the `ref` target [optional]
filterExtensionType List<String> filter by the extension type [optional]

Return type

Projects

Authorization

oauth2_access_code

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json, application/json

getProject

Project getProject(hubId, projectId)

Returns a project for a given `project_id`.

Parameters

Name Type Description Notes
hubId String the `hub id` for the current operation
projectId String the `project id`

Return type

Project

Authorization

oauth2_access_code

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json, application/json

getProjectHub

Hub getProjectHub(hubId, projectId)

Returns the hub for a given `project_id`.

Parameters

Name Type Description Notes
hubId String the `hub id` for the current operation
projectId String the `project id`

Return type

Hub

Authorization

oauth2_access_code

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json, application/json

postStorage

StorageCreated postStorage(projectId, body)

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

Parameters

Name Type Description Notes
projectId String the `project id`
body CreateStorage describe the file the storage is created for

Return type

StorageCreated

Authorization

oauth2_access_code

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json, application/json

postVersion

VersionCreated postVersion(projectId, body)

Creates a new version of an item in the 'data' domain service.

Parameters

Name Type Description Notes
projectId String the `project id`
body CreateVersion describe the version to be created

Return type

VersionCreated

Authorization

oauth2_access_code

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json, application/json

topFolders

Get topFolders(hubId, projectId)

Get the top folders for a Hub and a Project.

Parameters

Name Type Description Notes
hubId String the `hub id`
projectId String the `project id`

Return type

Folder

Authorization

oauth2_access_code

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json, application/json