Autodesk\Forge\Client\FoldersApi

All URIs are relative to https://developer.api.autodesk.com

Method	HTTP request	Description
getFolder	GET /data/v1/projects/{project_id}/folders/{folder_id}
getFolderContents	GET /data/v1/projects/{project_id}/folders/{folder_id}/contents
getFolderParent	GET /data/v1/projects/{project_id}/folders/{folder_id}/parent
getFolderRefs	GET /data/v1/projects/{project_id}/folders/{folder_id}/refs
getFolderRelationshipsRefs	GET /data/v1/projects/{project_id}/folders/{folder_id}/relationships/refs
postFolder	POST /data/v1/projects/{project_id}/folders
postFolderRelationshipsRef	POST /data/v1/projects/{project_id}/folders/{folder_id}/relationships/refs

getFolder

\Autodesk\Forge\Client\Model\Folder getFolder($project_id, $folder_id)

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Autodesk\Forge\Client\Api\FoldersApi($authObject);
$project_id = "project_id_example"; // string | the `project id`
$folder_id = "folder_id_example"; // string | the `folder id`

try {
    $result = $apiInstance->getFolder($project_id, $folder_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FoldersApi->getFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string	the `project id`
folder_id	string	the `folder id`

Return type

\Autodesk\Forge\Client\Model\Folder

Authorization

oauth2_access_code

HTTP request headers

Content-Type: application/vnd.api+json
Accept: application/vnd.api+json, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFolderContents

\Autodesk\Forge\Client\Model\JsonApiCollection getFolderContents($project_id, $folder_id, $filter_type, $filter_id, $filter_extension_type, $page_number, $page_limit)

Returns a collection of items and folders within a folder. Items represent word documents, fusion design files, drawings, spreadsheets, etc.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Autodesk\Forge\Client\Api\FoldersApi($authObject);
$project_id = "project_id_example"; // string | the `project id`
$folder_id = "folder_id_example"; // string | the `folder id`
$filter_type = array("filter_type_example"); // string[] | filter by the `type` of the `ref` target
$filter_id = array("filter_id_example"); // string[] | filter by the `id` of the `ref` target
$filter_extension_type = array("filter_extension_type_example"); // string[] | filter by the extension type
$page_number = 56; // int | specify the page number
$page_limit = 56; // int | specify the maximal number of elements per page

try {
    $result = $apiInstance->getFolderContents($project_id, $folder_id, $filter_type, $filter_id, $filter_extension_type, $page_number, $page_limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FoldersApi->getFolderContents: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string	the `project id`
folder_id	string	the `folder id`
filter_type	string[]	filter by the `type` of the `ref` target	[optional]
filter_id	string[]	filter by the `id` of the `ref` target	[optional]
filter_extension_type	string[]	filter by the extension type	[optional]
page_number	int	specify the page number	[optional]
page_limit	int	specify the maximal number of elements per page	[optional]

Return type

\Autodesk\Forge\Client\Model\JsonApiCollection

Authorization

oauth2_access_code

HTTP request headers

Content-Type: application/vnd.api+json
Accept: application/vnd.api+json, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFolderParent

\Autodesk\Forge\Client\Model\Folder getFolderParent($project_id, $folder_id)

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Autodesk\Forge\Client\Api\FoldersApi($authObject);
$project_id = "project_id_example"; // string | the `project id`
$folder_id = "folder_id_example"; // string | the `folder id`

try {
    $result = $apiInstance->getFolderParent($project_id, $folder_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FoldersApi->getFolderParent: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string	the `project id`
folder_id	string	the `folder id`

Return type

\Autodesk\Forge\Client\Model\Folder

Authorization

oauth2_access_code

HTTP request headers

Content-Type: application/vnd.api+json
Accept: application/vnd.api+json, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFolderRefs

\Autodesk\Forge\Client\Model\JsonApiCollection getFolderRefs($project_id, $folder_id, $filter_type, $filter_id, $filter_extension_type)

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).

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Autodesk\Forge\Client\Api\FoldersApi($authObject);
$project_id = "project_id_example"; // string | the `project id`
$folder_id = "folder_id_example"; // string | the `folder id`
$filter_type = array("filter_type_example"); // string[] | filter by the `type` of the `ref` target
$filter_id = array("filter_id_example"); // string[] | filter by the `id` of the `ref` target
$filter_extension_type = array("filter_extension_type_example"); // string[] | filter by the extension type

try {
    $result = $apiInstance->getFolderRefs($project_id, $folder_id, $filter_type, $filter_id, $filter_extension_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FoldersApi->getFolderRefs: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string	the `project id`
folder_id	string	the `folder id`
filter_type	string[]	filter by the `type` of the `ref` target	[optional]
filter_id	string[]	filter by the `id` of the `ref` target	[optional]
filter_extension_type	string[]	filter by the extension type	[optional]

Return type

\Autodesk\Forge\Client\Model\JsonApiCollection

Authorization

oauth2_access_code

HTTP request headers

Content-Type: application/vnd.api+json
Accept: application/vnd.api+json, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFolderRelationshipsRefs

\Autodesk\Forge\Client\Model\Refs getFolderRelationshipsRefs($project_id, $folder_id, $filter_type, $filter_id, $filter_ref_type, $filter_direction, $filter_extension_type)

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).

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Autodesk\Forge\Client\Api\FoldersApi($authObject);
$project_id = "project_id_example"; // string | the `project id`
$folder_id = "folder_id_example"; // string | the `folder id`
$filter_type = array("filter_type_example"); // string[] | filter by the `type` of the `ref` target
$filter_id = array("filter_id_example"); // string[] | filter by the `id` of the `ref` target
$filter_ref_type = array("filter_ref_type_example"); // string[] | filter by `refType`
$filter_direction = "filter_direction_example"; // string | filter by the direction of the reference
$filter_extension_type = array("filter_extension_type_example"); // string[] | filter by the extension type

try {
    $result = $apiInstance->getFolderRelationshipsRefs($project_id, $folder_id, $filter_type, $filter_id, $filter_ref_type, $filter_direction, $filter_extension_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FoldersApi->getFolderRelationshipsRefs: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
project_id	string	the `project id`
folder_id	string	the `folder id`
filter_type	string[]	filter by the `type` of the `ref` target	[optional]
filter_id	string[]	filter by the `id` of the `ref` target	[optional]
filter_ref_type	string[]	filter by `refType`	[optional]
filter_direction	string	filter by the direction of the reference	[optional]
filter_extension_type	string[]	filter by the extension type	[optional]

Return type

\Autodesk\Forge\Client\Model\Refs

Authorization

oauth2_access_code

HTTP request headers

Content-Type: application/vnd.api+json
Accept: application/vnd.api+json, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postFolder

postFolder($body)

Creates a new folder in the data domain service

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Autodesk\Forge\Client\Api\FoldersApi($authObject);
$body = new \Autodesk\Forge\Client\Model\CreateFolder(); // \Autodesk\Forge\Client\Model\CreateFolder | describe the folder to be created

try {
    $apiInstance->postFolder($body);
} catch (Exception $e) {
    echo 'Exception when calling FoldersApi->postFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Autodesk\Forge\Client\Model\CreateFolder	describe the folder to be created

Return type

void (empty response body)

Authorization

oauth2_access_code

HTTP request headers

Content-Type: application/vnd.api+json
Accept: application/vnd.api+json, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postFolderRelationshipsRef

postFolderRelationshipsRef($project_id, $folder_id, $body)

Creates a custom relationship between a folder and another resource within the 'data' domain service (folder, item, or version).

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Autodesk\Forge\Client\Api\FoldersApi($authObject);
$project_id = "project_id_example"; // string | the `project id`
$folder_id = "folder_id_example"; // string | the `folder id`
$body = new \Autodesk\Forge\Client\Model\CreateRef(); // \Autodesk\Forge\Client\Model\CreateRef | describe the ref to be created

try {
    $apiInstance->postFolderRelationshipsRef($project_id, $folder_id, $body);
} catch (Exception $e) {
    echo 'Exception when calling FoldersApi->postFolderRelationshipsRef: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
project_id	string	the `project id`
folder_id	string	the `folder id`
body	\Autodesk\Forge\Client\Model\CreateRef	describe the ref to be created

Return type

void (empty response body)

Authorization

oauth2_access_code

HTTP request headers

Content-Type: application/vnd.api+json
Accept: application/vnd.api+json, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

FoldersApi.md

Latest commit

History

FoldersApi.md

File metadata and controls

Autodesk\Forge\Client\FoldersApi

getFolder

Example

Parameters

Return type

Authorization

HTTP request headers

getFolderContents

Example

Parameters

Return type

Authorization

HTTP request headers

getFolderParent

Example

Parameters

Return type

Authorization

HTTP request headers

getFolderRefs

Example

Parameters

Return type

Authorization

HTTP request headers

getFolderRelationshipsRefs

Example

Parameters

Return type

Authorization

HTTP request headers

postFolder

Example

Parameters

Return type

Authorization

HTTP request headers

postFolderRelationshipsRef

Example

Parameters

Return type

Authorization

HTTP request headers