forge-apis

# ForgeSdk.ItemsApi All URIs are relative to *https://developer.api.autodesk.com/* Method | HTTP request | Description ------------- | ------------- | ------------- [**getItem**](ItemsApi.md#getItem) | **GET** /data/v1/projects/{project_id}/items/{item_id} | [**getItemParentFolder**](ItemsApi.md#getItemParentFolder) | **GET** /data/v1/projects/{project_id}/items/{item_id}/parent | [**getItemRefs**](ItemsApi.md#getItemRefs) | **GET** /data/v1/projects/{project_id}/items/{item_id}/refs | [**getItemRelationshipsRefs**](ItemsApi.md#getItemRelationshipsRefs) | **GET** /data/v1/projects/{project_id}/items/{item_id}/relationships/refs | [**getItemTip**](ItemsApi.md#getItemTip) | **GET** /data/v1/projects/{project_id}/items/{item_id}/tip | [**getItemVersions**](ItemsApi.md#getItemVersions) | **GET** /data/v1/projects/{project_id}/items/{item_id}/versions | [**postItem**](ItemsApi.md#postItem) | **POST** /data/v1/projects/{project_id}/items | [**postItemRelationshipsRef**](ItemsApi.md#postItemRelationshipsRef) | **POST** /data/v1/projects/{project_id}/items/{item_id}/relationships/refs | <a name="getItem"></a> # **getItem** > Item getItem(projectId, itemId, oauth2client, credentials) Returns a resource item by ID for any item within a given project. Resource items represent word documents, fusion design files, drawings, spreadsheets, etc. ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectId** | **String**| the `project id` | **itemId** | **String**| the `item 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="getItemParentFolder"></a> # **getItemParentFolder** > Folder getItemParentFolder(projectId, itemId, oauth2client, credentials) Returns the \"parent\" folder for the given item. ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectId** | **String**| the `project id` | **itemId** | **String**| the `item id` | ### Return type [**Folder**](Folder.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="getItemRefs"></a> # **getItemRefs** > JsonApiCollection getItemRefs(projectId, itemId, opts, oauth2client, credentials) Returns the resources (`items`, `folders`, and `versions`) which have a custom relationship with the given `item_id`. Custom relationships can be established between an item and other resources within the 'data' domain service (folders, items, and versions). ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectId** | **String**| the `project id` | **itemId** | **String**| the `item 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="getItemRelationshipsRefs"></a> # **getItemRelationshipsRefs** > Refs getItemRelationshipsRefs(projectId, itemId, opts, oauth2client, credentials) Returns the custom relationships that are associated to the given `item_id`. Custom relationships can be established between an item and other resources within the 'data' domain service (folders, items, and versions). ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectId** | **String**| the `project id` | **itemId** | **String**| the `item 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="getItemTip"></a> # **getItemTip** > Version getItemTip(projectId, itemId, oauth2client, credentials) Returns the \"tip\" version for the given item. Multiple versions of a resource item can be uploaded in a project. The tip version is the most recent one. ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectId** | **String**| the `project id` | **itemId** | **String**| the `item 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="getItemVersions"></a> # **getItemVersions** > Versions getItemVersions(projectId, itemId, opts, oauth2client, credentials) Returns versions for the given item. Multiple versions of a resource item can be uploaded in a project. ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectId** | **String**| the `project id` | **itemId** | **String**| the `item 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] **filterVersionNumber** | [**[Integer]**](Integer.md)| filter by `versionNumber` | [optional] **pageNumber** | **Integer**| specify the page number | [optional] **pageLimit** | **Integer**| specify the maximal number of elements per page | [optional] ### Return type [**Versions**](Versions.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="postItem"></a> # **postItem** > ItemCreated postItem(projectId, body, oauth2client, credentials) Creates a new item in the 'data' domain service. ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectId** | **String**| the `project id` | **body** | [**CreateItem**](CreateItem.md)| describe the item to be created | ### Return type [**ItemCreated**](ItemCreated.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="postItemRelationshipsRef"></a> # **postItemRelationshipsRef** > postItemRelationshipsRef(projectId, itemId, body, oauth2client, credentials) Creates a custom relationship between an item and another resource within the 'data' domain service (folder, item, or version). ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectId** | **String**| the `project id` | **itemId** | **String**| the `item 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