Swagger\Client\FolderApi

All URIs are relative to https://localhost:20000/api/3.1

Method	HTTP request	Description
allFolders	GET /folders	Get All Folders
createFolder	POST /folders	Create Folder
deleteFolder	DELETE /folders/{folder_id}	Delete Folder
folder	GET /folders/{folder_id}	Get Folder
folderAncestors	GET /folders/{folder_id}/ancestors	Get Folder Ancestors
folderChildren	GET /folders/{folder_id}/children	Get Folder Children
folderChildrenSearch	GET /folders/{folder_id}/children/search	Search Folder Children
folderDashboards	GET /folders/{folder_id}/dashboards	Get Folder Dashboards
folderLooks	GET /folders/{folder_id}/looks	Get Folder Looks
folderParent	GET /folders/{folder_id}/parent	Get Folder Parent
searchFolders	GET /folders/search	Search Folders
updateFolder	PATCH /folders/{folder_id}	Update Folder

allFolders

\Swagger\Client\Model\Folder[] allFolders($fields)

Get All Folders

Get information about all folders. In API 3.x, this will not return empty personal folders, unless they belong to the calling user, or if they contain soft-deleted content. In API 4.0+, all personal folders will be returned.

Example

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

$apiInstance = new Swagger\Client\Api\FolderApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->allFolders($fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FolderApi->allFolders: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\Folder[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

createFolder

\Swagger\Client\Model\Folder createFolder($body)

Create Folder

Create a folder with specified information. Caller must have permission to edit the parent folder and to create folders, otherwise the request returns 404 Not Found.

Example

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

$apiInstance = new Swagger\Client\Api\FolderApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\CreateFolder(); // \Swagger\Client\Model\CreateFolder | Folder parameters

try {
    $result = $apiInstance->createFolder($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FolderApi->createFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\CreateFolder	Folder parameters

Return type

\Swagger\Client\Model\Folder

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

deleteFolder

string deleteFolder($folder_id)

Delete Folder

Delete the folder with a specific id including any children folders. DANGER this will delete all looks and dashboards in the folder.

Example

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

$apiInstance = new Swagger\Client\Api\FolderApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$folder_id = "folder_id_example"; // string | Id of folder

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

Parameters

Name	Type	Description	Notes
folder_id	string	Id of folder

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

folder

\Swagger\Client\Model\Folder folder($folder_id, $fields)

Get Folder

Get information about the folder with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\FolderApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$folder_id = "folder_id_example"; // string | Id of folder
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
folder_id	string	Id of folder
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\Folder

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

folderAncestors

\Swagger\Client\Model\Folder[] folderAncestors($folder_id, $fields)

Get Folder Ancestors

Get the ancestors of a folder

Example

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

$apiInstance = new Swagger\Client\Api\FolderApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$folder_id = "folder_id_example"; // string | Id of folder
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
folder_id	string	Id of folder
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\Folder[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

folderChildren

\Swagger\Client\Model\Folder[] folderChildren($folder_id, $fields, $page, $per_page, $limit, $offset, $sorts)

Get Folder Children

Get the children of a folder.

Example

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

$apiInstance = new Swagger\Client\Api\FolderApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$folder_id = "folder_id_example"; // string | Id of folder
$fields = "fields_example"; // string | Requested fields.
$page = 789; // int | DEPRECATED. Use limit and offset instead. Return only page N of paginated results
$per_page = 789; // int | DEPRECATED. Use limit and offset instead. Return N rows of data per page
$limit = 789; // int | Number of results to return. (used with offset and takes priority over page and per_page)
$offset = 789; // int | Number of results to skip before returning any. (used with limit and takes priority over page and per_page)
$sorts = "sorts_example"; // string | Fields to sort by.

try {
    $result = $apiInstance->folderChildren($folder_id, $fields, $page, $per_page, $limit, $offset, $sorts);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FolderApi->folderChildren: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
folder_id	string	Id of folder
fields	string	Requested fields.	[optional]
page	int	DEPRECATED. Use limit and offset instead. Return only page N of paginated results	[optional]
per_page	int	DEPRECATED. Use limit and offset instead. Return N rows of data per page	[optional]
limit	int	Number of results to return. (used with offset and takes priority over page and per_page)	[optional]
offset	int	Number of results to skip before returning any. (used with limit and takes priority over page and per_page)	[optional]
sorts	string	Fields to sort by.	[optional]

Return type

\Swagger\Client\Model\Folder[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

folderChildrenSearch

\Swagger\Client\Model\Folder[] folderChildrenSearch($folder_id, $fields, $sorts, $name)

Search Folder Children

Search the children of a folder

Example

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

$apiInstance = new Swagger\Client\Api\FolderApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$folder_id = "folder_id_example"; // string | Id of folder
$fields = "fields_example"; // string | Requested fields.
$sorts = "sorts_example"; // string | Fields to sort by.
$name = "name_example"; // string | Match folder name.

try {
    $result = $apiInstance->folderChildrenSearch($folder_id, $fields, $sorts, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FolderApi->folderChildrenSearch: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
folder_id	string	Id of folder
fields	string	Requested fields.	[optional]
sorts	string	Fields to sort by.	[optional]
name	string	Match folder name.	[optional]

Return type

\Swagger\Client\Model\Folder[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

folderDashboards

\Swagger\Client\Model\Dashboard[] folderDashboards($folder_id, $fields)

Get Folder Dashboards

Get the dashboards in a folder

Example

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

$apiInstance = new Swagger\Client\Api\FolderApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$folder_id = "folder_id_example"; // string | Id of folder
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
folder_id	string	Id of folder
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\Dashboard[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

folderLooks

\Swagger\Client\Model\LookWithQuery[] folderLooks($folder_id, $fields)

Get Folder Looks

Get all looks in a folder. In API 3.x, this will return all looks in a folder, including looks in the trash. In API 4.0+, all looks in a folder will be returned, excluding looks in the trash.

Example

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

$apiInstance = new Swagger\Client\Api\FolderApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$folder_id = "folder_id_example"; // string | Id of folder
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
folder_id	string	Id of folder
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\LookWithQuery[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

folderParent

\Swagger\Client\Model\Folder folderParent($folder_id, $fields)

Get Folder Parent

Get the parent of a folder

Example

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

$apiInstance = new Swagger\Client\Api\FolderApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$folder_id = "folder_id_example"; // string | Id of folder
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
folder_id	string	Id of folder
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\Folder

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

searchFolders

\Swagger\Client\Model\Folder[] searchFolders($fields, $page, $per_page, $limit, $offset, $sorts, $name, $id, $parent_id, $creator_id, $filter_or, $is_shared_root)

Search Folders

Search for folders by creator id, parent id, name, etc

Example

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

$apiInstance = new Swagger\Client\Api\FolderApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$fields = "fields_example"; // string | Requested fields.
$page = 789; // int | DEPRECATED. Use limit and offset instead. Return only page N of paginated results
$per_page = 789; // int | DEPRECATED. Use limit and offset instead. Return N rows of data per page
$limit = 789; // int | Number of results to return. (used with offset and takes priority over page and per_page)
$offset = 789; // int | Number of results to skip before returning any. (used with limit and takes priority over page and per_page)
$sorts = "sorts_example"; // string | Fields to sort by.
$name = "name_example"; // string | Match Space title.
$id = "id_example"; // string | Match Space id
$parent_id = "parent_id_example"; // string | Filter on a children of a particular folder.
$creator_id = "creator_id_example"; // string | Filter on folder created by a particular user.
$filter_or = true; // bool | Combine given search criteria in a boolean OR expression
$is_shared_root = true; // bool | Match is shared root

try {
    $result = $apiInstance->searchFolders($fields, $page, $per_page, $limit, $offset, $sorts, $name, $id, $parent_id, $creator_id, $filter_or, $is_shared_root);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FolderApi->searchFolders: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
fields	string	Requested fields.	[optional]
page	int	DEPRECATED. Use limit and offset instead. Return only page N of paginated results	[optional]
per_page	int	DEPRECATED. Use limit and offset instead. Return N rows of data per page	[optional]
limit	int	Number of results to return. (used with offset and takes priority over page and per_page)	[optional]
offset	int	Number of results to skip before returning any. (used with limit and takes priority over page and per_page)	[optional]
sorts	string	Fields to sort by.	[optional]
name	string	Match Space title.	[optional]
id	string	Match Space id	[optional]
parent_id	string	Filter on a children of a particular folder.	[optional]
creator_id	string	Filter on folder created by a particular user.	[optional]
filter_or	bool	Combine given search criteria in a boolean OR expression	[optional]
is_shared_root	bool	Match is shared root	[optional]

Return type

\Swagger\Client\Model\Folder[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

updateFolder

\Swagger\Client\Model\Folder updateFolder($folder_id, $body)

Update Folder

Update the folder with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\FolderApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$folder_id = "folder_id_example"; // string | Id of folder
$body = new \Swagger\Client\Model\UpdateFolder(); // \Swagger\Client\Model\UpdateFolder | Folder parameters

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

Parameters

Name	Type	Description	Notes
folder_id	string	Id of folder
body	\Swagger\Client\Model\UpdateFolder	Folder parameters

Return type

\Swagger\Client\Model\Folder

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

Files

FolderApi.md

Latest commit

History

FolderApi.md

File metadata and controls

Swagger\Client\FolderApi

allFolders

Get information about all folders. In API 3.x, this will not return empty personal folders, unless they belong to the calling user, or if they contain soft-deleted content. In API 4.0+, all personal folders will be returned.

Example

Parameters

Return type

Authorization

HTTP request headers

createFolder

Create a folder with specified information. Caller must have permission to edit the parent folder and to create folders, otherwise the request returns 404 Not Found.

Example

Parameters

Return type

Authorization

HTTP request headers

deleteFolder

Delete the folder with a specific id including any children folders. DANGER this will delete all looks and dashboards in the folder.

Example

Parameters

Return type

Authorization

HTTP request headers

folder

Get information about the folder with a specific id.

Example

Parameters

Return type

Authorization

HTTP request headers

folderAncestors

Get the ancestors of a folder

Example

Parameters

Return type

Authorization

HTTP request headers

folderChildren

Get the children of a folder.

Example

Parameters

Return type

Authorization

HTTP request headers

folderChildrenSearch

Search the children of a folder

Example

Parameters

Return type

Authorization

HTTP request headers

folderDashboards

Get the dashboards in a folder

Example

Parameters

Return type

Authorization

HTTP request headers

folderLooks

Get all looks in a folder. In API 3.x, this will return all looks in a folder, including looks in the trash. In API 4.0+, all looks in a folder will be returned, excluding looks in the trash.

Example

Parameters

Return type

Authorization

HTTP request headers

folderParent

Get the parent of a folder

Example

Parameters

Return type

Authorization

HTTP request headers

searchFolders

Example

Parameters