Skip to content

Latest commit

 

History

History
1786 lines (1194 loc) · 52.9 KB

CollaborationServiceApi.md

File metadata and controls

1786 lines (1194 loc) · 52.9 KB

OpenAPI\Client\CollaborationServiceApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method HTTP request Description
usersCollaborationRestAcceptcollaborationPost() POST /users/collaboration/rest/acceptcollaboration
usersCollaborationRestActivatememberPost() POST /users/collaboration/rest/activatemember
usersCollaborationRestAddpolicyPost() POST /users/collaboration/rest/addpolicy
usersCollaborationRestAddresourcesPost() POST /users/collaboration/rest/addresources
usersCollaborationRestAddrolePost() POST /users/collaboration/rest/addrole
usersCollaborationRestCheckenvironmentrightsPost() POST /users/collaboration/rest/checkenvironmentrights
usersCollaborationRestDeletememberPost() POST /users/collaboration/rest/deletemember
usersCollaborationRestDeletepolicyPost() POST /users/collaboration/rest/deletepolicy
usersCollaborationRestDeleteresourcesPost() POST /users/collaboration/rest/deleteresources
usersCollaborationRestDeleterolePost() POST /users/collaboration/rest/deleterole
usersCollaborationRestEditcollaborationPost() POST /users/collaboration/rest/editcollaboration
usersCollaborationRestEditmemberPost() POST /users/collaboration/rest/editmember
usersCollaborationRestEditpolicyPost() POST /users/collaboration/rest/editpolicy
usersCollaborationRestEditrolePost() POST /users/collaboration/rest/editrole
usersCollaborationRestGetcollaborationresourcemethodsPost() POST /users/collaboration/rest/getcollaborationresourcemethods
usersCollaborationRestGetcollaborationresourcesPost() POST /users/collaboration/rest/getcollaborationresources
usersCollaborationRestGetcollaborationrolemethodsPost() POST /users/collaboration/rest/getcollaborationrolemethods
usersCollaborationRestGetcollaborationsPost() POST /users/collaboration/rest/getcollaborations
usersCollaborationRestGetmemberresourcesPost() POST /users/collaboration/rest/getmemberresources
usersCollaborationRestGetmembersPost() POST /users/collaboration/rest/getmembers
usersCollaborationRestGetpoliciesPost() POST /users/collaboration/rest/getpolicies
usersCollaborationRestGetpolicymethodsPost() POST /users/collaboration/rest/getpolicymethods
usersCollaborationRestGetresourcerolesPost() POST /users/collaboration/rest/getresourceroles
usersCollaborationRestGetrolesPost() POST /users/collaboration/rest/getroles
usersCollaborationRestInvitememberPost() POST /users/collaboration/rest/invitemember
usersCollaborationRestLeavecollaborationPost() POST /users/collaboration/rest/leavecollaboration
usersCollaborationRestRejectcollaborationPost() POST /users/collaboration/rest/rejectcollaboration
usersCollaborationRestResendmemberinvitationPost() POST /users/collaboration/rest/resendmemberinvitation
usersCollaborationRestSetresourcePost() POST /users/collaboration/rest/setresource
usersCollaborationRestSetresourcesPost() POST /users/collaboration/rest/setresources
usersCollaborationRestSuspendmemberPost() POST /users/collaboration/rest/suspendmember

usersCollaborationRestAcceptcollaborationPost()

usersCollaborationRestAcceptcollaborationPost($id): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$id = 56; // int

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

Parameters

Name Type Description Notes
id int

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestActivatememberPost()

usersCollaborationRestActivatememberPost($id, $ownerUid): \OpenAPI\Client\Model\ComHivextApiResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$id = 56; // int
$ownerUid = 56; // int

try {
    $result = $apiInstance->usersCollaborationRestActivatememberPost($id, $ownerUid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestActivatememberPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int
ownerUid int [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestAddpolicyPost()

usersCollaborationRestAddpolicyPost($methods, $name, $description): \OpenAPI\Client\Model\ComHivextApiServerUsersResponsePolicyResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$methods = 'methods_example'; // string
$name = 'name_example'; // string
$description = 'description_example'; // string

try {
    $result = $apiInstance->usersCollaborationRestAddpolicyPost($methods, $name, $description);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestAddpolicyPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
methods string
name string
description string [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponsePolicyResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestAddresourcesPost()

usersCollaborationRestAddresourcesPost($resources, $collaborationId): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResourceResponses

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$resources = 'resources_example'; // string
$collaborationId = 56; // int

try {
    $result = $apiInstance->usersCollaborationRestAddresourcesPost($resources, $collaborationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestAddresourcesPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
resources string
collaborationId int

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResourceResponses

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestAddrolePost()

usersCollaborationRestAddrolePost($receiveNotification, $name, $policies, $description): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationRoleResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$receiveNotification = True; // bool
$name = 'name_example'; // string
$policies = 'policies_example'; // string
$description = 'description_example'; // string

try {
    $result = $apiInstance->usersCollaborationRestAddrolePost($receiveNotification, $name, $policies, $description);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestAddrolePost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
receiveNotification bool
name string
policies string
description string [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationRoleResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestCheckenvironmentrightsPost()

usersCollaborationRestCheckenvironmentrightsPost($serviceMethod, $isAny): \OpenAPI\Client\Model\ComHivextApiResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$serviceMethod = 'serviceMethod_example'; // string
$isAny = True; // bool

try {
    $result = $apiInstance->usersCollaborationRestCheckenvironmentrightsPost($serviceMethod, $isAny);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestCheckenvironmentrightsPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
serviceMethod string
isAny bool [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestDeletememberPost()

usersCollaborationRestDeletememberPost($id, $ownerUid): \OpenAPI\Client\Model\ComHivextApiResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$id = 56; // int
$ownerUid = 56; // int

try {
    $result = $apiInstance->usersCollaborationRestDeletememberPost($id, $ownerUid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestDeletememberPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int
ownerUid int [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestDeletepolicyPost()

usersCollaborationRestDeletepolicyPost($id): \OpenAPI\Client\Model\ComHivextApiResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$id = 56; // int

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

Parameters

Name Type Description Notes
id int

Return type

\OpenAPI\Client\Model\ComHivextApiResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestDeleteresourcesPost()

usersCollaborationRestDeleteresourcesPost($ids, $collaborationId): \OpenAPI\Client\Model\ComHivextApiResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$ids = array(new \stdClass); // object[]
$collaborationId = 56; // int

try {
    $result = $apiInstance->usersCollaborationRestDeleteresourcesPost($ids, $collaborationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestDeleteresourcesPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
ids object[]
collaborationId int

Return type

\OpenAPI\Client\Model\ComHivextApiResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestDeleterolePost()

usersCollaborationRestDeleterolePost($id): \OpenAPI\Client\Model\ComHivextApiResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$id = 56; // int

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

Parameters

Name Type Description Notes
id int

Return type

\OpenAPI\Client\Model\ComHivextApiResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestEditcollaborationPost()

usersCollaborationRestEditcollaborationPost($id, $displayName): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$id = 56; // int
$displayName = 'displayName_example'; // string

try {
    $result = $apiInstance->usersCollaborationRestEditcollaborationPost($id, $displayName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestEditcollaborationPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int
displayName string [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestEditmemberPost()

usersCollaborationRestEditmemberPost($id, $displayName, $ownerUid): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$id = 56; // int
$displayName = 'displayName_example'; // string
$ownerUid = 56; // int

try {
    $result = $apiInstance->usersCollaborationRestEditmemberPost($id, $displayName, $ownerUid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestEditmemberPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int
displayName string [optional]
ownerUid int [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestEditpolicyPost()

usersCollaborationRestEditpolicyPost($methods, $id, $name, $description): \OpenAPI\Client\Model\ComHivextApiServerUsersResponsePolicyResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$methods = 'methods_example'; // string
$id = 56; // int
$name = 'name_example'; // string
$description = 'description_example'; // string

try {
    $result = $apiInstance->usersCollaborationRestEditpolicyPost($methods, $id, $name, $description);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestEditpolicyPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
methods string
id int
name string [optional]
description string [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponsePolicyResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestEditrolePost()

usersCollaborationRestEditrolePost($policies, $id, $receiveNotification, $name, $description): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationRoleResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$policies = 'policies_example'; // string
$id = 56; // int
$receiveNotification = True; // bool
$name = 'name_example'; // string
$description = 'description_example'; // string

try {
    $result = $apiInstance->usersCollaborationRestEditrolePost($policies, $id, $receiveNotification, $name, $description);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestEditrolePost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
policies string
id int
receiveNotification bool [optional]
name string [optional]
description string [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationRoleResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestGetcollaborationresourcemethodsPost()

usersCollaborationRestGetcollaborationresourcemethodsPost($resourceId, $resourceType): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseStringArrayResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$resourceId = 'resourceId_example'; // string
$resourceType = 'resourceType_example'; // string

try {
    $result = $apiInstance->usersCollaborationRestGetcollaborationresourcemethodsPost($resourceId, $resourceType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestGetcollaborationresourcemethodsPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
resourceId string
resourceType string

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseStringArrayResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestGetcollaborationresourcesPost()

usersCollaborationRestGetcollaborationresourcesPost($type, $collaborationId): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResourceResponses

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$type = 'type_example'; // string
$collaborationId = 56; // int

try {
    $result = $apiInstance->usersCollaborationRestGetcollaborationresourcesPost($type, $collaborationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestGetcollaborationresourcesPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
type string [optional]
collaborationId int [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResourceResponses

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestGetcollaborationrolemethodsPost()

usersCollaborationRestGetcollaborationrolemethodsPost($roleId, $collaborationId): \OpenAPI\Client\Model\ComHivextApiServerListResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$roleId = 56; // int
$collaborationId = 56; // int

try {
    $result = $apiInstance->usersCollaborationRestGetcollaborationrolemethodsPost($roleId, $collaborationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestGetcollaborationrolemethodsPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
roleId int [optional]
collaborationId int [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerListResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestGetcollaborationsPost()

usersCollaborationRestGetcollaborationsPost($id, $ownerUid): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationsResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$id = 56; // int
$ownerUid = 56; // int

try {
    $result = $apiInstance->usersCollaborationRestGetcollaborationsPost($id, $ownerUid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestGetcollaborationsPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int [optional]
ownerUid int [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestGetmemberresourcesPost()

usersCollaborationRestGetmemberresourcesPost($memberId): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResourceResponses

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$memberId = 56; // int

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

Parameters

Name Type Description Notes
memberId int [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResourceResponses

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestGetmembersPost()

usersCollaborationRestGetmembersPost($id, $ownerUid): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationsResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$id = 56; // int
$ownerUid = 56; // int

try {
    $result = $apiInstance->usersCollaborationRestGetmembersPost($id, $ownerUid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestGetmembersPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int [optional]
ownerUid int [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestGetpoliciesPost()

usersCollaborationRestGetpoliciesPost($id): \OpenAPI\Client\Model\ComHivextApiServerUsersResponsePoliciesResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$id = 56; // int

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

Parameters

Name Type Description Notes
id int [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponsePoliciesResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestGetpolicymethodsPost()

usersCollaborationRestGetpolicymethodsPost($policyId): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseApiTokenPermissionsResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$policyId = 56; // int

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

Parameters

Name Type Description Notes
policyId int [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseApiTokenPermissionsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestGetresourcerolesPost()

usersCollaborationRestGetresourcerolesPost($resourceId, $ownerUid, $resourceType): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResourceResponses

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$resourceId = 'resourceId_example'; // string
$ownerUid = 56; // int
$resourceType = 'resourceType_example'; // string

try {
    $result = $apiInstance->usersCollaborationRestGetresourcerolesPost($resourceId, $ownerUid, $resourceType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestGetresourcerolesPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
resourceId string
ownerUid int [optional]
resourceType string [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResourceResponses

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestGetrolesPost()

usersCollaborationRestGetrolesPost($id, $ownerUid): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationRolesResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$id = 56; // int
$ownerUid = 56; // int

try {
    $result = $apiInstance->usersCollaborationRestGetrolesPost($id, $ownerUid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestGetrolesPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int [optional]
ownerUid int [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationRolesResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestInvitememberPost()

usersCollaborationRestInvitememberPost($email, $displayName, $ownerUid): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$email = 'email_example'; // string
$displayName = 'displayName_example'; // string
$ownerUid = 56; // int

try {
    $result = $apiInstance->usersCollaborationRestInvitememberPost($email, $displayName, $ownerUid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestInvitememberPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
email string
displayName string [optional]
ownerUid int [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestLeavecollaborationPost()

usersCollaborationRestLeavecollaborationPost($id): \OpenAPI\Client\Model\ComHivextApiResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$id = 56; // int

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

Parameters

Name Type Description Notes
id int

Return type

\OpenAPI\Client\Model\ComHivextApiResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestRejectcollaborationPost()

usersCollaborationRestRejectcollaborationPost($id): \OpenAPI\Client\Model\ComHivextApiResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$id = 56; // int

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

Parameters

Name Type Description Notes
id int

Return type

\OpenAPI\Client\Model\ComHivextApiResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestResendmemberinvitationPost()

usersCollaborationRestResendmemberinvitationPost($id, $ownerUid): \OpenAPI\Client\Model\ComHivextApiResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$id = 56; // int
$ownerUid = 56; // int

try {
    $result = $apiInstance->usersCollaborationRestResendmemberinvitationPost($id, $ownerUid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestResendmemberinvitationPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int
ownerUid int [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestSetresourcePost()

usersCollaborationRestSetresourcePost($resourceId, $roleIds, $collaborationId, $ownerUid, $resourceType): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResourceResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$resourceId = 'resourceId_example'; // string
$roleIds = 'roleIds_example'; // string
$collaborationId = 56; // int
$ownerUid = 56; // int
$resourceType = 'resourceType_example'; // string

try {
    $result = $apiInstance->usersCollaborationRestSetresourcePost($resourceId, $roleIds, $collaborationId, $ownerUid, $resourceType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestSetresourcePost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
resourceId string
roleIds string
collaborationId int
ownerUid int [optional]
resourceType string [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResourceResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestSetresourcesPost()

usersCollaborationRestSetresourcesPost($resources, $collaborationId): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResourceResponses

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$resources = 'resources_example'; // string
$collaborationId = 56; // int

try {
    $result = $apiInstance->usersCollaborationRestSetresourcesPost($resources, $collaborationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestSetresourcesPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
resources string
collaborationId int

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseCollaborationResourceResponses

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

usersCollaborationRestSuspendmemberPost()

usersCollaborationRestSuspendmemberPost($id, $ownerUid): \OpenAPI\Client\Model\ComHivextApiResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\CollaborationServiceApi(
    // 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()
);
$id = 56; // int
$ownerUid = 56; // int

try {
    $result = $apiInstance->usersCollaborationRestSuspendmemberPost($id, $ownerUid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollaborationServiceApi->usersCollaborationRestSuspendmemberPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int
ownerUid int [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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