Projects
GET
hubs/:hub_id/projects/:project_id/hub
Returns the hub for a given project_id
.
New! Autodesk Construction Cloud platform (ACC). Note that this endpoint is compatible with ACC projects. For more information about the Autodesk Construction Cloud APIs, see the Autodesk Construction Cloud documentation.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/project/v1/hubs/:hub_id/projects/:project_id/hub |
Authentication Context | user context optional |
Required OAuth Scopes | data:read |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via either a two-legged or three-legged OAuth flow. |
x-user-id string | In a two-legged authentication context, the app has access to all users specified by the administrator in the SaaS integrations UI. By providing this header, the API call will be limited to act on behalf of only the user specified. |
* Required
Request
URI Parameters
hub_id string | The unique identifier of a hub. |
project_id string | The unique identifier of a project.
For BIM 360 Docs, the project ID in the Data Management API corresponds to the project ID in the BIM 360 API. To convert a project ID in the BIM 360 API into a project ID in the Data Management API you need to add a “b." prefix. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9. |
Response
HTTP Status Code Summary
200 OK | Successful retrieval of a specific hub. |
400 Bad Request | The request could not be understood by the server due to malformed syntax or missing request headers. The client SHOULD NOT repeat the request without modifications. The response body may give an indication of what is wrong with the request. |
403 Forbidden | The request was successfully validated but permission is not granted or the application has not been white-listed. Do not try again unless you solve permissions first. |
404 Not Found | The specified resource was not found. |
Response
Body Structure (200)
Expand all
jsonapi object | The JSON API object. |
version enum:string | The version of JSON API. Will always be: 1.0 |
links object | Information on links to this resource. |
self object | An object containing an API link property. |
href string | A hyperlink reference to this resource. |
data object | The object containing information on the hub. |
type enum:string | The type of this resource. Will always be: hubs |
id string | The id of the resource. |
attributes object | The attributes of the hub. |
name string | Displayable name of the hub. |
extension object | The extension object of the data. |
type string | The type of the schema that the resource’s data object adheres to. |
version string | The version of the schema that the data is adhering to. |
schema object | An object containing an API link property. |
href string | A hyperlink reference to this resource. |
data object | Additional properties that the resource’s data possesses. |
region enum:string | Specifies where the hub is stored. Possible values are:
Note: Beta features are subject to change. Please avoid using them in production environments. |
relationships object | The resources that share a relationship with this hub. |
projects object | Information on resources that are found under this resource. |
links object | The object containing information on links of related resources. |
related object | An object containing an API link property. |
href string | A hyperlink reference to this resource. |
pimCollection object | Information on the id and type properties of a resource. This is available only for Fusion Team hubs and A360 Personal hubs. |
data object | An object containing the id and type properties of a resource. |
id string | The id of the resource. |
type string | The type of this resource. |
links object | Information on links to this resource. |
self object | An object containing an API link property. |
href string | A hyperlink reference to this resource. |
Example
Successful retrieval of a specific hub.
Request
curl -v 'https://developer.api.autodesk.com/project/v1/hubs/:hub_id/projects/:project_id/hub' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"jsonapi": {
"version": "1.0"
},
"links": {
"self": {
"href": "/project/v1/hubs/a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjE"
}
},
"data": {
"type": "hubs",
"id": "a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjE",
"attributes": {
"name": "my hub",
"extension": {
"data": {},
"version": "1.0",
"type": "hubs:autodesk.core:Hub",
"schema": {
"href": "/schema/v1/versions/hubs%3Aautodesk.core%3AHub-1.0"
}
},
"region": "US"
},
"relationships": {
"projects": {
"links": {
"related": {
"href": "/project/v1/hubs/a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjE/projects"
}
}
},
"pimCollection": {
"data": {
"type": "collection",
"id": "co.d41d8cd00998ecf8427e"
}
}
},
"links": {
"self": {
"href": "/project/v1/hubs/a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjE"
}
}
}
}
Show More