| Server IP : 79.136.114.73 / Your IP : 18.191.73.161 Web Server : Apache/2.4.7 (Ubuntu) PHP/5.5.9-1ubuntu4.29 OpenSSL/1.0.1f System : Linux b8009 3.13.0-170-generic #220-Ubuntu SMP Thu May 9 12:40:49 UTC 2019 x86_64 User : www-data ( 33) PHP Version : 5.5.9-1ubuntu4.29 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority, MySQL : ON | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /var/www/appsrv.astacus.se/forge/forge-api-nodejs-client/docs/ |
Upload File : |
# ForgeSdk.FoldersApi
All URIs are relative to *https://developer.api.autodesk.com/*
Method | HTTP request | Description
------------- | ------------- | -------------
[**getFolder**](FoldersApi.md#getFolder) | **GET** /data/v1/projects/{project_id}/folders/{folder_id} |
[**getFolderContents**](FoldersApi.md#getFolderContents) | **GET** /data/v1/projects/{project_id}/folders/{folder_id}/contents |
[**getFolderParent**](FoldersApi.md#getFolderParent) | **GET** /data/v1/projects/{project_id}/folders/{folder_id}/parent |
[**getFolderRefs**](FoldersApi.md#getFolderRefs) | **GET** /data/v1/projects/{project_id}/folders/{folder_id}/refs |
[**getFolderRelationshipsRefs**](FoldersApi.md#getFolderRelationshipsRefs) | **GET** /data/v1/projects/{project_id}/folders/{folder_id}/relationships/refs |
[**postFolder**](FoldersApi.md#postFolder) | **POST** /data/v1/projects/{project_id}/folders |
[**postFolderRelationshipsRef**](FoldersApi.md#postFolderRelationshipsRef) | **POST** /data/v1/projects/{project_id}/folders/{folder_id}/relationships/refs |
<a name="getFolder"></a>
# **getFolder**
> Folder getFolder(projectId, folderId, oauth2client, credentials)
Returns the folder by ID for any folder within a given project. All folders or sub-folders within a project are associated with their own unique ID, including the root folder.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**projectId** | **String**| the `project id` |
**folderId** | **String**| the `folder 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="getFolderContents"></a>
# **getFolderContents**
> JsonApiCollection getFolderContents(projectId, folderId, opts, oauth2client, credentials)
Returns a collection of items and folders within a folder. Items represent word documents, fusion design files, drawings, spreadsheets, etc.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**projectId** | **String**| the `project id` |
**folderId** | **String**| the `folder 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]
**pageNumber** | **Integer**| specify the page number | [optional]
**pageLimit** | **Integer**| specify the maximal number of elements per page | [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="getFolderParent"></a>
# **getFolderParent**
> Folder getFolderParent(projectId, folderId, oauth2client, credentials)
Returns the parent folder (if it exists). In a project, subfolders and resource items are stored under a folder except the root folder which does not have a parent of its own.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**projectId** | **String**| the `project id` |
**folderId** | **String**| the `folder 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="getFolderRefs"></a>
# **getFolderRefs**
> JsonApiCollection getFolderRefs(projectId, folderId, opts, oauth2client, credentials)
Returns the resources (`items`, `folders`, and `versions`) which have a custom relationship with the given `folder_id`. Custom relationships can be established between a folder and other resources within the 'data' domain service (folders, items, and versions).
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**projectId** | **String**| the `project id` |
**folderId** | **String**| the `folder 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="getFolderRelationshipsRefs"></a>
# **getFolderRelationshipsRefs**
> Refs getFolderRelationshipsRefs(projectId, folderId, opts, oauth2client, credentials)
Returns the custom relationships that are associated to the given `folder_id`. Custom relationships can be established between a folder and other resources within the 'data' domain service (folders, items, and versions).
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**projectId** | **String**| the `project id` |
**folderId** | **String**| the `folder 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="postFolder"></a>
# **postFolder**
> postFolder(body, oauth2client, credentials)
Creates a new folder in the `data` domain service
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**CreateFolder**](CreateFolder.md)| describe the folder 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
<a name="postFolderRelationshipsRef"></a>
# **postFolderRelationshipsRef**
> postFolderRelationshipsRef(projectId, folderId, body, oauth2client, credentials)
Creates a custom relationship between a folder and another resource within the 'data' domain service (folder, item, or version).
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**projectId** | **String**| the `project id` |
**folderId** | **String**| the `folder 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