All URIs are relative to https://developer.api.autodesk.com/
| Method | HTTP request | Description |
|---|---|---|
| getVersion | GET /data/v1/projects/{project_id}/versions/{version_id} | |
| getVersionItem | GET /data/v1/projects/{project_id}/versions/{version_id}/item | |
| getVersionRefs | GET /data/v1/projects/{project_id}/versions/{version_id}/refs | |
| getVersionRelationshipsRefs | GET /data/v1/projects/{project_id}/versions/{version_id}/relationships/refs | |
| postVersionRelationshipsRef | POST /data/v1/projects/{project_id}/versions/{version_id}/relationships/refs |
Version getVersion(projectId, versionId)
Returns the version with the given `version_id`.
| Name | Type | Description | Notes |
|---|---|---|---|
| projectId | String | the `project id` | |
| versionId | String | the `version id` |
- Content-Type: application/vnd.api+json
- Accept: application/vnd.api+json, application/json
Item getVersionItem(projectId, versionId)
Returns the item the given version is associated with.
| Name | Type | Description | Notes |
|---|---|---|---|
| projectId | String | the `project id` | |
| versionId | String | the `version id` |
- Content-Type: application/vnd.api+json
- Accept: application/vnd.api+json, application/json
JsonApiCollection getVersionRefs(projectId, versionId, filterType, filterId, filterExtensionType)
Returns the resources (`items`, `folders`, and `versions`) which have a custom relationship with the given `version_id`. Custom relationships can be established between a version of an item and other resources within the 'data' domain service (folders, items, and versions).
| Name | Type | Description | Notes |
|---|---|---|---|
| projectId | String | the `project id` | |
| versionId | String | the `version id` | |
| filterType | List<String> | filter by the `type` of the `ref` target | [optional] |
| filterId | List<String> | filter by the `id` of the `ref` target | [optional] |
| filterExtensionType | List<String> | filter by the extension type | [optional] |
- Content-Type: application/vnd.api+json
- Accept: application/vnd.api+json, application/json
Refs getVersionRelationshipsRefs(projectId, versionId, filterType, filterId, filterRefType, filterDirection, filterExtensionType)
Returns the custom relationships that are associated to the given `version_id`. Custom relationships can be established between a version of an item and other resources within the 'data' domain service (folders, items, and versions).
| Name | Type | Description | Notes |
|---|---|---|---|
| projectId | String | the `project id` | |
| versionId | String | the `version id` | |
| filterType | List<String> | filter by the `type` of the `ref` target | [optional] |
| filterId | List<String> | filter by the `id` of the `ref` target | [optional] |
| filterRefType | List<String> | filter by `refType` | [optional] |
| filterDirection | String | filter by the direction of the reference | [optional] [enum: from, to] |
| filterExtensionType | List<String> | filter by the extension type | [optional] |
- Content-Type: application/vnd.api+json
- Accept: application/vnd.api+json, application/json
postVersionRelationshipsRef(projectId, versionId, body)
Creates a custom relationship between a version and another resource within the 'data' domain service (folder, item, or version).
| Name | Type | Description | Notes |
|---|---|---|---|
| projectId | String | the `project id` | |
| versionId | String | the `version id` | |
| body | CreateRef | describe the ref to be created |
null (empty response body)
- Content-Type: application/vnd.api+json
- Accept: application/vnd.api+json, application/json