Balloon\Sdk\CoreV2Api

All URIs are relative to http://localhost

Method	HTTP request	Description
addGroup	POST /api/v2/groups	Add new group
addUser	POST /api/v2/users	Add new user
cloneNode	POST /api/v2/nodes/{node}/clone	Clone existing node
createCollection	POST /api/v2/collections/{collection}	Create a new collection
createRootCollection	POST /api/v2/collections	Create a new collection in root
createToken	GET /api/v2/tokens	OAUTH2/OIDC token endpoint
deleteGroup	DELETE /api/v2/groups/{group}	Delete group
deleteNode	DELETE /api/v2/nodes/{node}	Delete node
deleteShare	DELETE /api/v2/collections/{collection}/share	Does only remove sharing options and transform a share back into a normal collection. There will not be any data loss after this action. All existing references would be removed automatically.
deleteUser	DELETE /api/v2/users/{user}	Delete user
getApi	GET /api	Get server status
getChildren	GET /api/v2/collections/{collection}/children	Get all children of a collection
getCollections	GET /api/v2/collections	Get all collections
getContent	GET /api/v2/nodes/{node}/content	Download node contents. Note that collections are zipped on-the-fly.
getCurrentUser	GET /api/v2/users/whoami	Get user object of the current authenticated user
getDeletedNodes	GET /api/v2/nodes/trash	Return delete nodes (Excluding sub nodes of deleted collections)
getDelta	GET /api/v2/nodes/delta	Delta stream with cursor support.
getEventLog	GET /api/v2/nodes/event-log	Get event log containing all operations which are made by the user himself or share members
getFileHistory	GET /api/v2/files/{file}/history	Get a full change history of a file
getFiles	GET /api/v2/files	Get all files
getGroup	GET /api/v2/groups/{group}	Get single group
getGroupMembers	GET /api/v2/groups/{group}/members	Request all member of a group
getGroups	GET /api/v2/groups	Get groups
getLastCursor	GET /api/v2/nodes/last-cursor	Use this method to request the latest cursor if you only need to now if there are changes on the server. This method will not return any other data than the newest cursor. To request a feed with all deltas request /delta.
getNode	GET /api/v2/nodes/{node}	Get single node
getNodeAttributeSummary	GET /api/v2/users/{user}/node-attribute-summary	Get summary of node usage.
getNodeEventLog	GET /api/v2/nodes/{node}/event-log	Get event log containing all operations which are made by the user himself or share members on a given node
getNodes	GET /api/v2/nodes	Get all nodes
getParentNodes	GET /api/v2/nodes/{node}/parents	The hirarchy of all parent nodes is ordered in a single level array beginning with the collection on the highest level.
getRootChildren	GET /api/v2/collections/children	Get all children of the root collection
getShare	GET /api/v2/collections/{collection}/share	Get share acl and share name
getUser	GET /api/v2/users/{user}	Get single user
getUserAvatar	GET /api/v2/users/{user}/avatar	Get user avatar
getUserGroups	GET /api/v2/users/{user}/groups	Request all groups of a user
getUsers	GET /api/v2/users	Get users
getV2	GET /api/v2	Get server status
moveNode	POST /api/v2/nodes/{node}/move	Move node (Change parent collection), single or multiple ones
patchGroup	PATCH /api/v2/groups/{group}	Set attributes for group
patchUser	PATCH /api/v2/users/{user}	Set attributes for user
rollbackFile	POST /api/v2/files/{file}/restore	Rollback to a recent version from history. Use the version number from history.
shareCollection	POST /api/v2/collections/{collection}/share	Create a new share from an existing collection
undeleteGroup	POST /api/v2/groups/{group}/undelete	Restore deleted group
undeleteNode	POST /api/v2/nodes/{node}/undelete	Undelete (Restore from trash) a single node or multiple ones.
undeleteUser	POST /api/v2/users/{user}/undelete	Restore deleted user
updateNode	PATCH /api/v2/nodes/{node}	Change attributes
uploadChunk	PUT /api/v2/files/chunk	Upload a file chunk. You have to manually splitt the binary data into multiple chunks and upload them successively! using this method. Once uploading the last chunk, the server will automatically create or update the file node. You may set the parent collection, name and or custom attributes only with the last request to save traffic.
uploadFile	PUT /api/v2/files	Upload an entire file in one-shot. Use this endpoint only for small files, for bigger files use the chunking endpoint.

addGroup

\Balloon\Sdk\Model\CoreV2Group addGroup($core_v2_group)

Add new group

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$core_v2_group = new \Balloon\Sdk\Model\CoreV2Group(); // \Balloon\Sdk\Model\CoreV2Group | 

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

Parameters

Name	Type	Description	Notes
core_v2_group	\Balloon\Sdk\Model\CoreV2Group		[optional]

Return type

\Balloon\Sdk\Model\CoreV2Group

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

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

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

addUser

\Balloon\Sdk\Model\CoreV2User addUser($core_v2_user)

Add new user

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$core_v2_user = new \Balloon\Sdk\Model\CoreV2User(); // \Balloon\Sdk\Model\CoreV2User | 

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

Parameters

Name	Type	Description	Notes
core_v2_user	\Balloon\Sdk\Model\CoreV2User		[optional]

Return type

\Balloon\Sdk\Model\CoreV2User

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

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

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

cloneNode

\Balloon\Sdk\Model\CoreV2Node cloneNode($node, $destid, $conflict)

Clone existing node

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$node = 'node_example'; // string | Node identifier
$destid = 'destid_example'; // string | Destination collection, if this is null root is taken
$conflict = 0; // float | Conflict resolution

try {
    $result = $apiInstance->cloneNode($node, $destid, $conflict);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->cloneNode: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
node	string	Node identifier
destid	string	Destination collection, if this is null root is taken	[optional]
conflict	float	Conflict resolution	[optional] [default to 0]

Return type

\Balloon\Sdk\Model\CoreV2Node

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

createCollection

\Balloon\Sdk\Model\CoreV2Collection createCollection($collection, $core_v2_collection)

Create a new collection

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$collection = 'collection_example'; // string | Parent collection
$core_v2_collection = new \Balloon\Sdk\Model\CoreV2Collection(); // \Balloon\Sdk\Model\CoreV2Collection | 

try {
    $result = $apiInstance->createCollection($collection, $core_v2_collection);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->createCollection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
collection	string	Parent collection
core_v2_collection	\Balloon\Sdk\Model\CoreV2Collection

Return type

\Balloon\Sdk\Model\CoreV2Collection

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

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

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

createRootCollection

\Balloon\Sdk\Model\CoreV2Collection createRootCollection($core_v2_collection)

Create a new collection in root

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$core_v2_collection = new \Balloon\Sdk\Model\CoreV2Collection(); // \Balloon\Sdk\Model\CoreV2Collection | 

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

Parameters

Name	Type	Description	Notes
core_v2_collection	\Balloon\Sdk\Model\CoreV2Collection

Return type

\Balloon\Sdk\Model\CoreV2Collection

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

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

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

createToken

\Balloon\Sdk\Model\CoreV2OAuth2Token createToken()

OAUTH2/OIDC token endpoint

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Balloon\Sdk\Model\CoreV2OAuth2Token

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

deleteGroup

deleteGroup($group, $force)

Delete group

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$group = 'group_example'; // string | Resource identifier
$force = True; // bool | Per default the group gets disabled, if force is set the group gets removed completely.

try {
    $apiInstance->deleteGroup($group, $force);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->deleteGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
group	string	Resource identifier
force	bool	Per default the group gets disabled, if force is set the group gets removed completely.	[optional]

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

deleteNode

deleteNode($node, $force, $ignore_flag, $at)

Delete node

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$node = 'node_example'; // string | Node identifier
$force = True; // bool | Force flag need to be set to delete a node from trash (node must have the deleted flag)
$ignore_flag = True; // bool | If both ignore_flag and force_flag were set, the node will be deleted completely
$at = 3.4; // float | Has to be a valid unix timestamp if so the node will destroy itself at this specified time instead immediatly

try {
    $apiInstance->deleteNode($node, $force, $ignore_flag, $at);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->deleteNode: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
node	string	Node identifier
force	bool	Force flag need to be set to delete a node from trash (node must have the deleted flag)	[optional]
ignore_flag	bool	If both ignore_flag and force_flag were set, the node will be deleted completely	[optional]
at	float	Has to be a valid unix timestamp if so the node will destroy itself at this specified time instead immediatly	[optional]

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

deleteShare

deleteShare($collection)

Does only remove sharing options and transform a share back into a normal collection. There will not be any data loss after this action. All existing references would be removed automatically.

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$collection = 'collection_example'; // string | Collection identifier

try {
    $apiInstance->deleteShare($collection);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->deleteShare: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
collection	string	Collection identifier

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

deleteUser

deleteUser($user, $force)

Delete user

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$user = 'user_example'; // string | Resource identifier
$force = True; // bool | Per default the user gets disabled, if force is set the user gets removed completely.

try {
    $apiInstance->deleteUser($user, $force);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->deleteUser: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
user	string	Resource identifier
force	bool	Per default the user gets disabled, if force is set the user gets removed completely.	[optional]

Return type

void (empty response body)

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

getApi

\Balloon\Sdk\Model\CoreV2ApiRoot getApi()

Get server status

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Balloon\Sdk\Model\CoreV2ApiRoot

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getChildren

\Balloon\Sdk\Model\CoreV2Nodes getChildren($collection, $query, $deleted, $attributes, $offset, $limit, $sort, $recursive)

Get all children of a collection

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$collection = 'collection_example'; // string | Parent collection
$query = 'query_example'; // string | Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).
$deleted = 3.4; // float | Wheter to include deleted or not
$attributes = array('attributes_example'); // string[] | Filter attributes
$offset = 3.4; // float | Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].
$limit = 3.4; // float | Objects limit, per default 20 objects will get returned
$sort = 'sort_example'; // string | Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).
$recursive = false; // bool | Include children recursively.

try {
    $result = $apiInstance->getChildren($collection, $query, $deleted, $attributes, $offset, $limit, $sort, $recursive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->getChildren: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
collection	string	Parent collection
query	string	Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).	[optional]
deleted	float	Wheter to include deleted or not	[optional]
attributes	string[]	Filter attributes	[optional]
offset	float	Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].	[optional]
limit	float	Objects limit, per default 20 objects will get returned	[optional]
sort	string	Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).	[optional]
recursive	bool	Include children recursively.	[optional] [default to false]

Return type

\Balloon\Sdk\Model\CoreV2Nodes

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getCollections

\Balloon\Sdk\Model\CoreV2Collections getCollections($query, $deleted, $attributes, $offset, $limit, $sort)

Get all collections

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$query = 'query_example'; // string | Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).
$deleted = 3.4; // float | Wheter to include deleted or not
$attributes = array('attributes_example'); // string[] | Filter attributes
$offset = 3.4; // float | Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].
$limit = 3.4; // float | Objects limit, per default 20 objects will get returned
$sort = 'sort_example'; // string | Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).

try {
    $result = $apiInstance->getCollections($query, $deleted, $attributes, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->getCollections: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
query	string	Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).	[optional]
deleted	float	Wheter to include deleted or not	[optional]
attributes	string[]	Filter attributes	[optional]
offset	float	Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].	[optional]
limit	float	Objects limit, per default 20 objects will get returned	[optional]
sort	string	Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).	[optional]

Return type

\Balloon\Sdk\Model\CoreV2Collections

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getContent

\SplFileObject getContent($node, $byte_ranges, $encode, $download)

Download node contents. Note that collections are zipped on-the-fly.

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$node = 'node_example'; // string | Node identifier
$byte_ranges = 3.4; // float | Read stream from a specific offset/limit in bytes
$encode = 'encode_example'; // string | Can be set to base64 to encode content as base64.
$download = false; // bool | Force download file (Content-Disposition: attachment HTTP header)

try {
    $result = $apiInstance->getContent($node, $byte_ranges, $encode, $download);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->getContent: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
node	string	Node identifier
byte_ranges	float	Read stream from a specific offset/limit in bytes	[optional]
encode	string	Can be set to base64 to encode content as base64.	[optional]
download	bool	Force download file (Content-Disposition: attachment HTTP header)	[optional] [default to false]

Return type

\SplFileObject

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: octet/stream

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

getCurrentUser

\Balloon\Sdk\Model\CoreV2User getCurrentUser($attributes)

Get user object of the current authenticated user

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$attributes = array('attributes_example'); // string[] | Filter attributes

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

Parameters

Name	Type	Description	Notes
attributes	string[]	Filter attributes	[optional]

Return type

\Balloon\Sdk\Model\CoreV2User

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getDeletedNodes

\Balloon\Sdk\Model\CoreV2Nodes getDeletedNodes($query, $attributes, $offset, $limit, $sort)

Return delete nodes (Excluding sub nodes of deleted collections)

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$query = 'query_example'; // string | Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).
$attributes = array('attributes_example'); // string[] | Filter attributes
$offset = 3.4; // float | Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].
$limit = 3.4; // float | Objects limit, per default 20 objects will get returned
$sort = 'sort_example'; // string | Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).

try {
    $result = $apiInstance->getDeletedNodes($query, $attributes, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->getDeletedNodes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
query	string	Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).	[optional]
attributes	string[]	Filter attributes	[optional]
offset	float	Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].	[optional]
limit	float	Objects limit, per default 20 objects will get returned	[optional]
sort	string	Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).	[optional]

Return type

\Balloon\Sdk\Model\CoreV2Nodes

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getDelta

\Balloon\Sdk\Model\CoreV2Delta getDelta($limit, $attributes, $cursor)

Delta stream with cursor support.

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$limit = 3.4; // float | Limit the number of delta entries, if too low you have to call this endpoint more often since has_more would be true more often
$attributes = array('attributes_example'); // string[] | Filter attributes, per default not all attributes would be returned
$cursor = 'cursor_example'; // string | Set a cursor to rquest next nodes within delta processing

try {
    $result = $apiInstance->getDelta($limit, $attributes, $cursor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->getDelta: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
limit	float	Limit the number of delta entries, if too low you have to call this endpoint more often since has_more would be true more often	[optional]
attributes	string[]	Filter attributes, per default not all attributes would be returned	[optional]
cursor	string	Set a cursor to rquest next nodes within delta processing	[optional]

Return type

\Balloon\Sdk\Model\CoreV2Delta

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventLog

\Balloon\Sdk\Model\CoreV2EventLogs getEventLog($query, $attributes, $offset, $limit, $sort)

Get event log containing all operations which are made by the user himself or share members

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$query = 'query_example'; // string | Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).
$attributes = array('attributes_example'); // string[] | Filter attributes
$offset = 3.4; // float | Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].
$limit = 3.4; // float | Objects limit, per default 20 objects will get returned
$sort = 'sort_example'; // string | Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).

try {
    $result = $apiInstance->getEventLog($query, $attributes, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->getEventLog: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
query	string	Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).	[optional]
attributes	string[]	Filter attributes	[optional]
offset	float	Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].	[optional]
limit	float	Objects limit, per default 20 objects will get returned	[optional]
sort	string	Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).	[optional]

Return type

\Balloon\Sdk\Model\CoreV2EventLogs

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getFileHistory

\Balloon\Sdk\Model\CoreV2FileHistory getFileHistory($file)

Get a full change history of a file

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$file = 'file_example'; // string | File identifier

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

Parameters

Name	Type	Description	Notes
file	string	File identifier

Return type

\Balloon\Sdk\Model\CoreV2FileHistory

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getFiles

\Balloon\Sdk\Model\CoreV2Files getFiles($query, $deleted, $attributes, $offset, $limit, $sort)

Get all files

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$query = 'query_example'; // string | Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).
$deleted = 3.4; // float | Wheter to include deleted or not
$attributes = array('attributes_example'); // string[] | Filter attributes
$offset = 3.4; // float | Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].
$limit = 3.4; // float | Objects limit, per default 20 objects will get returned
$sort = 'sort_example'; // string | Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).

try {
    $result = $apiInstance->getFiles($query, $deleted, $attributes, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->getFiles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
query	string	Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).	[optional]
deleted	float	Wheter to include deleted or not	[optional]
attributes	string[]	Filter attributes	[optional]
offset	float	Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].	[optional]
limit	float	Objects limit, per default 20 objects will get returned	[optional]
sort	string	Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).	[optional]

Return type

\Balloon\Sdk\Model\CoreV2Files

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getGroup

\Balloon\Sdk\Model\CoreV2Group getGroup($group, $attributes)

Get single group

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$group = 'group_example'; // string | Resource identifier
$attributes = array('attributes_example'); // string[] | Filter attributes

try {
    $result = $apiInstance->getGroup($group, $attributes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->getGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
group	string	Resource identifier
attributes	string[]	Filter attributes	[optional]

Return type

\Balloon\Sdk\Model\CoreV2Group

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getGroupMembers

\Balloon\Sdk\Model\CoreV2User[] getGroupMembers($group)

Request all member of a group

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$group = 'group_example'; // string | Resource identifier

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

Parameters

Name	Type	Description	Notes
group	string	Resource identifier

Return type

\Balloon\Sdk\Model\CoreV2User[]

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getGroups

\Balloon\Sdk\Model\CoreV2Groups getGroups($query, $attributes, $offset, $limit, $sort)

Get groups

A group is a colletion of users

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$query = 'query_example'; // string | Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).
$attributes = array('attributes_example'); // string[] | Filter attributes
$offset = 3.4; // float | Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].
$limit = 3.4; // float | Objects limit, per default 20 objects will get returned
$sort = 'sort_example'; // string | Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).

try {
    $result = $apiInstance->getGroups($query, $attributes, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->getGroups: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
query	string	Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).	[optional]
attributes	string[]	Filter attributes	[optional]
offset	float	Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].	[optional]
limit	float	Objects limit, per default 20 objects will get returned	[optional]
sort	string	Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).	[optional]

Return type

\Balloon\Sdk\Model\CoreV2Groups

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getLastCursor

string getLastCursor()

Use this method to request the latest cursor if you only need to now if there are changes on the server. This method will not return any other data than the newest cursor. To request a feed with all deltas request /delta.

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);

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

Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getNode

\Balloon\Sdk\Model\CoreV2Node getNode($node, $attributes)

Get single node

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$node = 'node_example'; // string | Node identifier
$attributes = array('attributes_example'); // string[] | Filter attributes

try {
    $result = $apiInstance->getNode($node, $attributes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->getNode: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
node	string	Node identifier
attributes	string[]	Filter attributes	[optional]

Return type

\Balloon\Sdk\Model\CoreV2Node

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getNodeAttributeSummary

map[string,object[]] getNodeAttributeSummary($user)

Get summary of node usage.

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$user = 'user_example'; // string | Resource identifier

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

Parameters

Name	Type	Description	Notes
user	string	Resource identifier

Return type

map[string,object[]]

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getNodeEventLog

\Balloon\Sdk\Model\CoreV2EventLogs getNodeEventLog($node, $query, $attributes, $offset, $limit, $sort)

Get event log containing all operations which are made by the user himself or share members on a given node

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$node = 'node_example'; // string | Node identifier
$query = 'query_example'; // string | Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).
$attributes = array('attributes_example'); // string[] | Filter attributes
$offset = 3.4; // float | Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].
$limit = 3.4; // float | Objects limit, per default 20 objects will get returned
$sort = 'sort_example'; // string | Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).

try {
    $result = $apiInstance->getNodeEventLog($node, $query, $attributes, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->getNodeEventLog: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
node	string	Node identifier
query	string	Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).	[optional]
attributes	string[]	Filter attributes	[optional]
offset	float	Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].	[optional]
limit	float	Objects limit, per default 20 objects will get returned	[optional]
sort	string	Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).	[optional]

Return type

\Balloon\Sdk\Model\CoreV2EventLogs

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getNodes

\Balloon\Sdk\Model\CoreV2Nodes getNodes($query, $deleted, $attributes, $offset, $limit, $sort)

Get all nodes

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$query = 'query_example'; // string | Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).
$deleted = 3.4; // float | Wheter to include deleted or not
$attributes = array('attributes_example'); // string[] | Filter attributes
$offset = 3.4; // float | Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].
$limit = 3.4; // float | Objects limit, per default 20 objects will get returned
$sort = 'sort_example'; // string | Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).

try {
    $result = $apiInstance->getNodes($query, $deleted, $attributes, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->getNodes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
query	string	Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).	[optional]
deleted	float	Wheter to include deleted or not	[optional]
attributes	string[]	Filter attributes	[optional]
offset	float	Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].	[optional]
limit	float	Objects limit, per default 20 objects will get returned	[optional]
sort	string	Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).	[optional]

Return type

\Balloon\Sdk\Model\CoreV2Nodes

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getParentNodes

\Balloon\Sdk\Model\CoreV2Nodes getParentNodes($node, $attributes, $self)

The hirarchy of all parent nodes is ordered in a single level array beginning with the collection on the highest level.

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$node = 'node_example'; // string | Node identifier
$attributes = array('attributes_example'); // string[] | Filter attributes
$self = True; // bool | Include requested collection itself at the end of the list (Will be ignored if the requested node is a file)

try {
    $result = $apiInstance->getParentNodes($node, $attributes, $self);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->getParentNodes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
node	string	Node identifier
attributes	string[]	Filter attributes	[optional]
self	bool	Include requested collection itself at the end of the list (Will be ignored if the requested node is a file)	[optional]

Return type

\Balloon\Sdk\Model\CoreV2Nodes

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getRootChildren

\Balloon\Sdk\Model\CoreV2Nodes getRootChildren($query, $deleted, $attributes, $offset, $limit, $sort, $recursive)

Get all children of the root collection

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$query = 'query_example'; // string | Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).
$deleted = 3.4; // float | Wheter to include deleted or not
$attributes = array('attributes_example'); // string[] | Filter attributes
$offset = 3.4; // float | Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].
$limit = 3.4; // float | Objects limit, per default 20 objects will get returned
$sort = 'sort_example'; // string | Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).
$recursive = false; // bool | Include children recursively.

try {
    $result = $apiInstance->getRootChildren($query, $deleted, $attributes, $offset, $limit, $sort, $recursive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->getRootChildren: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
query	string	Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).	[optional]
deleted	float	Wheter to include deleted or not	[optional]
attributes	string[]	Filter attributes	[optional]
offset	float	Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].	[optional]
limit	float	Objects limit, per default 20 objects will get returned	[optional]
sort	string	Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).	[optional]
recursive	bool	Include children recursively.	[optional] [default to false]

Return type

\Balloon\Sdk\Model\CoreV2Nodes

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getShare

\Balloon\Sdk\Model\CoreV2Share getShare($collection)

Get share acl and share name

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$collection = 'collection_example'; // string | Collection identifier

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

Parameters

Name	Type	Description	Notes
collection	string	Collection identifier

Return type

\Balloon\Sdk\Model\CoreV2Share

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getUser

\Balloon\Sdk\Model\CoreV2User getUser($user, $attributes)

Get single user

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$user = 'user_example'; // string | Resource identifier
$attributes = array('attributes_example'); // string[] | Filter attributes

try {
    $result = $apiInstance->getUser($user, $attributes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->getUser: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
user	string	Resource identifier
attributes	string[]	Filter attributes	[optional]

Return type

\Balloon\Sdk\Model\CoreV2User

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getUserAvatar

\Balloon\Sdk\Model\CoreV2User getUserAvatar($user)

Get user avatar

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$user = 'user_example'; // string | Resource identifier

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

Parameters

Name	Type	Description	Notes
user	string	Resource identifier

Return type

\Balloon\Sdk\Model\CoreV2User

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: octet/stream

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

getUserGroups

\Balloon\Sdk\Model\CoreV2Groups getUserGroups($user, $query, $attributes, $offset, $limit, $sort)

Request all groups of a user

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$user = 'user_example'; // string | Resource identifier
$query = 'query_example'; // string | Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).
$attributes = array('attributes_example'); // string[] | Filter attributes
$offset = 3.4; // float | Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].
$limit = 3.4; // float | Objects limit, per default 20 objects will get returned
$sort = 'sort_example'; // string | Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).

try {
    $result = $apiInstance->getUserGroups($user, $query, $attributes, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->getUserGroups: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
user	string	Resource identifier
query	string	Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).	[optional]
attributes	string[]	Filter attributes	[optional]
offset	float	Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].	[optional]
limit	float	Objects limit, per default 20 objects will get returned	[optional]
sort	string	Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).	[optional]

Return type

\Balloon\Sdk\Model\CoreV2Groups

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getUsers

\Balloon\Sdk\Model\CoreV2Users[] getUsers($query, $attributes, $offset, $limit, $sort)

Get users

A user is a colletion of users

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$query = 'query_example'; // string | Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).
$attributes = array('attributes_example'); // string[] | Filter attributes
$offset = 3.4; // float | Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].
$limit = 3.4; // float | Objects limit, per default 20 objects will get returned
$sort = 'sort_example'; // string | Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).

try {
    $result = $apiInstance->getUsers($query, $attributes, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->getUsers: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
query	string	Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}}).	[optional]
attributes	string[]	Filter attributes	[optional]
offset	float	Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset].	[optional]
limit	float	Objects limit, per default 20 objects will get returned	[optional]
sort	string	Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1}).	[optional]

Return type

\Balloon\Sdk\Model\CoreV2Users[]

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getV2

\Balloon\Sdk\Model\CoreV2ApiRoot getV2()

Get server status

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Balloon\Sdk\Model\CoreV2ApiRoot

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

moveNode

\Balloon\Sdk\Model\CoreV2Node moveNode($node, $destid, $conflict)

Move node (Change parent collection), single or multiple ones

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$node = 'node_example'; // string | Node identifier
$destid = 'destid_example'; // string | Destination collection, if this is null root is taken
$conflict = 0; // float | Conflict resolution

try {
    $result = $apiInstance->moveNode($node, $destid, $conflict);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->moveNode: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
node	string	Node identifier
destid	string	Destination collection, if this is null root is taken	[optional]
conflict	float	Conflict resolution	[optional] [default to 0]

Return type

\Balloon\Sdk\Model\CoreV2Node

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

patchGroup

\Balloon\Sdk\Model\CoreV2Group patchGroup($group, $core_v2_group)

Set attributes for group

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$group = 'group_example'; // string | Resource identifier
$core_v2_group = new \Balloon\Sdk\Model\CoreV2Group(); // \Balloon\Sdk\Model\CoreV2Group | Set attributes for group

try {
    $result = $apiInstance->patchGroup($group, $core_v2_group);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->patchGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
group	string	Resource identifier
core_v2_group	\Balloon\Sdk\Model\CoreV2Group	Set attributes for group

Return type

\Balloon\Sdk\Model\CoreV2Group

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

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

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

patchUser

\Balloon\Sdk\Model\CoreV2User patchUser($user, $core_v2_user)

Set attributes for user

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$user = 'user_example'; // string | Resource identifier
$core_v2_user = new \Balloon\Sdk\Model\CoreV2User(); // \Balloon\Sdk\Model\CoreV2User | Set attributes for user

try {
    $result = $apiInstance->patchUser($user, $core_v2_user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->patchUser: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
user	string	Resource identifier
core_v2_user	\Balloon\Sdk\Model\CoreV2User	Set attributes for user

Return type

\Balloon\Sdk\Model\CoreV2User

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

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

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

rollbackFile

\Balloon\Sdk\Model\CoreV2File rollbackFile($file)

Rollback to a recent version from history. Use the version number from history.

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$file = 'file_example'; // string | File identifier

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

Parameters

Name	Type	Description	Notes
file	string	File identifier

Return type

\Balloon\Sdk\Model\CoreV2File

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

shareCollection

\Balloon\Sdk\Model\CoreV2Collection shareCollection($collection, $core_v2_share)

Create a new share from an existing collection

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$collection = 'collection_example'; // string | Collection identifier
$core_v2_share = new \Balloon\Sdk\Model\CoreV2Share(); // \Balloon\Sdk\Model\CoreV2Share | Create a new share from an existing collection

try {
    $result = $apiInstance->shareCollection($collection, $core_v2_share);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->shareCollection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
collection	string	Collection identifier
core_v2_share	\Balloon\Sdk\Model\CoreV2Share	Create a new share from an existing collection

Return type

\Balloon\Sdk\Model\CoreV2Collection

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

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

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

undeleteGroup

\Balloon\Sdk\Model\CoreV2Group undeleteGroup($group)

Restore deleted group

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$group = 'group_example'; // string | Resource identifier

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

Parameters

Name	Type	Description	Notes
group	string	Resource identifier

Return type

\Balloon\Sdk\Model\CoreV2Group

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

undeleteNode

\Balloon\Sdk\Model\CoreV2Node undeleteNode($node, $move, $destid, $conflict)

Undelete (Restore from trash) a single node or multiple ones.

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$node = 'node_example'; // string | Node identifier
$move = false; // bool | If node should also be moved during undelete
$destid = 'destid_example'; // string | If node should also be moved during undelete
$conflict = 0; // float | Conflict resolution

try {
    $result = $apiInstance->undeleteNode($node, $move, $destid, $conflict);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->undeleteNode: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
node	string	Node identifier
move	bool	If node should also be moved during undelete	[optional] [default to false]
destid	string	If node should also be moved during undelete	[optional]
conflict	float	Conflict resolution	[optional] [default to 0]

Return type

\Balloon\Sdk\Model\CoreV2Node

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

undeleteUser

\Balloon\Sdk\Model\CoreV2User undeleteUser($user)

Restore deleted user

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$user = 'user_example'; // string | Resource identifier

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

Parameters

Name	Type	Description	Notes
user	string	Resource identifier

Return type

\Balloon\Sdk\Model\CoreV2User

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

updateNode

\Balloon\Sdk\Model\CoreV2Node updateNode($node, $core_v2_node)

Change attributes

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$node = 'node_example'; // string | Node identifier
$core_v2_node = new \Balloon\Sdk\Model\CoreV2Node(); // \Balloon\Sdk\Model\CoreV2Node | Change attributes

try {
    $result = $apiInstance->updateNode($node, $core_v2_node);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoreV2Api->updateNode: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
node	string	Node identifier
core_v2_node	\Balloon\Sdk\Model\CoreV2Node	Change attributes

Return type

\Balloon\Sdk\Model\CoreV2Node

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

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

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

uploadChunk

\Balloon\Sdk\Model\CoreV2File uploadChunk($body)

Upload a file chunk. You have to manually splitt the binary data into multiple chunks and upload them successively! using this method. Once uploading the last chunk, the server will automatically create or update the file node. You may set the parent collection, name and or custom attributes only with the last request to save traffic.

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$body = 'body_example'; // string | File content

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

Parameters

Name	Type	Description	Notes
body	string	File content

Return type

\Balloon\Sdk\Model\CoreV2File

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

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

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

uploadFile

\Balloon\Sdk\Model\CoreV2File uploadFile($body)

Upload an entire file in one-shot. Use this endpoint only for small files, for bigger files use the chunking endpoint.

Example

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


// Configure API key authorization: ApiKeyAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure HTTP basic authorization: BasicAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: BearerAuth
$config = Balloon\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Balloon\Sdk\Api\CoreV2Api(
    // 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(),
    $config
);
$body = 'body_example'; // string | File content

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

Parameters

Name	Type	Description	Notes
body	string	File content	[optional]

Return type

\Balloon\Sdk\Model\CoreV2File

Authorization

ApiKeyAuth, BasicAuth, BearerAuth, OpenID

HTTP request headers

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

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