forge-apis

# ForgeSdk.VersionsApi All URIs are relative to *https://developer.api.autodesk.com/* Method | HTTP request | Description ------------- | ------------- | ------------- [**getVersion**](VersionsApi.md#getVersion) | **GET** /data/v1/projects/{project_id}/versions/{version_id} | [**getVersionItem**](VersionsApi.md#getVersionItem) | **GET** /data/v1/projects/{project_id}/versions/{version_id}/item | [**getVersionRefs**](VersionsApi.md#getVersionRefs) | **GET** /data/v1/projects/{project_id}/versions/{version_id}/refs | [**getVersionRelationshipsRefs**](VersionsApi.md#getVersionRelationshipsRefs) | **GET** /data/v1/projects/{project_id}/versions/{version_id}/relationships/refs | [**postVersion**](VersionsApi.md#postVersion) | **POST** /data/v1/projects/{project_id}/versions | [**postVersionRelationshipsRef**](VersionsApi.md#postVersionRelationshipsRef) | **POST** /data/v1/projects/{project_id}/versions/{version_id}/relationships/refs | <a name="getVersion"></a> # **getVersion** > Version getVersion(projectId, versionId, oauth2client, credentials) Returns the version with the given `version_id`. ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectId** | **String**| the `project id` | **versionId** | **String**| the `version id` | ### Return type [**Version**](Version.md) ### Authorization [oauth2_access_code](../README.md#authentication) ### HTTP request headers - **Content-Type**: application/vnd.api+json - **Accept**: application/vnd.api+json, application/json <a name="getVersionItem"></a> # **getVersionItem** > Item getVersionItem(projectId, versionId, oauth2client, credentials) Returns the item the given version is associated with. ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectId** | **String**| the `project id` | **versionId** | **String**| the `version id` | ### Return type [**Item**](Item.md) ### Authorization [oauth2_access_code](../README.md#authentication) ### HTTP request headers - **Content-Type**: application/vnd.api+json - **Accept**: application/vnd.api+json, application/json <a name="getVersionRefs"></a> # **getVersionRefs** > JsonApiCollection getVersionRefs(projectId, versionId, opts, oauth2client, credentials) 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). ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectId** | **String**| the `project id` | **versionId** | **String**| the `version id` | **filterType** | [**[String]**](String.md)| filter by the `type` of the `ref` target | [optional] **filterId** | [**[String]**](String.md)| filter by the `id` of the `ref` target | [optional] **filterExtensionType** | [**[String]**](String.md)| filter by the extension type | [optional] ### Return type [**JsonApiCollection**](JsonApiCollection.md) ### Authorization [oauth2_access_code](../README.md#authentication) ### HTTP request headers - **Content-Type**: application/vnd.api+json - **Accept**: application/vnd.api+json, application/json <a name="getVersionRelationshipsRefs"></a> # **getVersionRelationshipsRefs** > Refs getVersionRelationshipsRefs(projectId, versionId, opts, oauth2client, credentials) 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). ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectId** | **String**| the `project id` | **versionId** | **String**| the `version id` | **filterType** | [**[String]**](String.md)| filter by the `type` of the `ref` target | [optional] **filterId** | [**[String]**](String.md)| filter by the `id` of the `ref` target | [optional] **filterRefType** | [**[String]**](String.md)| filter by `refType` | [optional] **filterDirection** | **String**| filter by the direction of the reference | [optional] **filterExtensionType** | [**[String]**](String.md)| filter by the extension type | [optional] ### Return type [**Refs**](Refs.md) ### Authorization [oauth2_access_code](../README.md#authentication) ### HTTP request headers - **Content-Type**: application/vnd.api+json - **Accept**: application/vnd.api+json, application/json <a name="postVersion"></a> # **postVersion** > VersionCreated postVersion(projectId, body, oauth2client, credentials) Creates a new version of an item in the 'data' domain service. ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectId** | **String**| the `project id` | **body** | [**CreateVersion**](CreateVersion.md)| describe the version to be created | ### Return type [**VersionCreated**](VersionCreated.md) ### Authorization [oauth2_access_code](../README.md#authentication) ### HTTP request headers - **Content-Type**: application/vnd.api+json - **Accept**: application/vnd.api+json, application/json <a name="postVersionRelationshipsRef"></a> # **postVersionRelationshipsRef** > postVersionRelationshipsRef(projectId, versionId, body, oauth2client, credentials) Creates a custom relationship between a version and another resource within the 'data' domain service (folder, item, or version). ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectId** | **String**| the `project id` | **versionId** | **String**| the `version id` | **body** | [**CreateRef**](CreateRef.md)| describe the ref to be created | ### Return type null (empty response body) ### Authorization [oauth2_access_code](../README.md#authentication) ### HTTP request headers - **Content-Type**: application/vnd.api+json - **Accept**: application/vnd.api+json, application/json