Skip to content

Files

Latest commit

pierreduppierredup
Initial commit
Dec 6, 2022
1b7bc9d · Dec 6, 2022

History

History
507 lines (344 loc) · 15.3 KB

GroupServiceApi.md

File metadata and controls

507 lines (344 loc) · 15.3 KB

OpenAPI\Client\GroupServiceApi

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

Method HTTP request Description
environmentGroupRestAttachenvPost() POST /environment/group/rest/attachenv
environmentGroupRestCreategroupPost() POST /environment/group/rest/creategroup
environmentGroupRestDetachenvPost() POST /environment/group/rest/detachenv
environmentGroupRestEditgroupPost() POST /environment/group/rest/editgroup
environmentGroupRestGetgroupsPost() POST /environment/group/rest/getgroups
environmentGroupRestRemovegroupPost() POST /environment/group/rest/removegroup
environmentGroupRestSetenvPost() POST /environment/group/rest/setenv
environmentGroupRestSetisolationenabledPost() POST /environment/group/rest/setisolationenabled

environmentGroupRestAttachenvPost()

environmentGroupRestAttachenvPost($envGroup, $envName, $targetAppid, $ownerUid): \OpenAPI\Client\Model\ComHivextApiResponse

Attach env to group

Example

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



$apiInstance = new OpenAPI\Client\Api\GroupServiceApi(
    // 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()
);
$envGroup = 'envGroup_example'; // string
$envName = 'envName_example'; // string
$targetAppid = 'targetAppid_example'; // string
$ownerUid = 56; // int

try {
    $result = $apiInstance->environmentGroupRestAttachenvPost($envGroup, $envName, $targetAppid, $ownerUid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupServiceApi->environmentGroupRestAttachenvPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
envGroup string
envName string [optional]
targetAppid string [optional]
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]

environmentGroupRestCreategroupPost()

environmentGroupRestCreategroupPost($data, $envName, $envGroup, $ownerUid): \OpenAPI\Client\Model\ComHivextApiServerDevelopmentResponseInterfacesArrayResponse

Create group

Example

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



$apiInstance = new OpenAPI\Client\Api\GroupServiceApi(
    // 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()
);
$data = new \OpenAPI\Client\Model\EnvironmentGroupRestEditgroupPostRequestData(); // \OpenAPI\Client\Model\EnvironmentGroupRestEditgroupPostRequestData
$envName = 'envName_example'; // string
$envGroup = 'envGroup_example'; // string
$ownerUid = 56; // int

try {
    $result = $apiInstance->environmentGroupRestCreategroupPost($data, $envName, $envGroup, $ownerUid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupServiceApi->environmentGroupRestCreategroupPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
data \OpenAPI\Client\Model\EnvironmentGroupRestEditgroupPostRequestData [optional]
envName string [optional]
envGroup string [optional]
ownerUid int [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerDevelopmentResponseInterfacesArrayResponse

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]

environmentGroupRestDetachenvPost()

environmentGroupRestDetachenvPost($envGroup, $envName, $targetAppid, $ownerUid): \OpenAPI\Client\Model\ComHivextApiResponse

Detach env from group

Example

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



$apiInstance = new OpenAPI\Client\Api\GroupServiceApi(
    // 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()
);
$envGroup = 'envGroup_example'; // string
$envName = 'envName_example'; // string
$targetAppid = 'targetAppid_example'; // string
$ownerUid = 56; // int

try {
    $result = $apiInstance->environmentGroupRestDetachenvPost($envGroup, $envName, $targetAppid, $ownerUid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupServiceApi->environmentGroupRestDetachenvPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
envGroup string
envName string [optional]
targetAppid string [optional]
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]

environmentGroupRestEditgroupPost()

environmentGroupRestEditgroupPost($srcGroupName, $data, $envName, $dstGroupName, $ownerUid): \OpenAPI\Client\Model\ComHivextApiServerDevelopmentResponseInterfacesArrayResponse

Edit groups

Example

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



$apiInstance = new OpenAPI\Client\Api\GroupServiceApi(
    // 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()
);
$srcGroupName = 'srcGroupName_example'; // string
$data = new \OpenAPI\Client\Model\EnvironmentGroupRestEditgroupPostRequestData(); // \OpenAPI\Client\Model\EnvironmentGroupRestEditgroupPostRequestData
$envName = 'envName_example'; // string
$dstGroupName = 'dstGroupName_example'; // string
$ownerUid = 56; // int

try {
    $result = $apiInstance->environmentGroupRestEditgroupPost($srcGroupName, $data, $envName, $dstGroupName, $ownerUid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupServiceApi->environmentGroupRestEditgroupPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
srcGroupName string
data \OpenAPI\Client\Model\EnvironmentGroupRestEditgroupPostRequestData [optional]
envName string [optional]
dstGroupName string [optional]
ownerUid int [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerDevelopmentResponseInterfacesArrayResponse

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]

environmentGroupRestGetgroupsPost()

environmentGroupRestGetgroupsPost($envName, $targetAppid, $ownerUid): \OpenAPI\Client\Model\ComHivextApiServerDevelopmentResponseInterfacesArrayResponse

Get group list

Example

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



$apiInstance = new OpenAPI\Client\Api\GroupServiceApi(
    // 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()
);
$envName = 'envName_example'; // string
$targetAppid = 'targetAppid_example'; // string
$ownerUid = 56; // int

try {
    $result = $apiInstance->environmentGroupRestGetgroupsPost($envName, $targetAppid, $ownerUid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupServiceApi->environmentGroupRestGetgroupsPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
envName string [optional]
targetAppid string [optional]
ownerUid int [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerDevelopmentResponseInterfacesArrayResponse

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]

environmentGroupRestRemovegroupPost()

environmentGroupRestRemovegroupPost($envGroup, $envName, $ownerUid): \OpenAPI\Client\Model\ComHivextApiResponse

Remove groups

Example

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



$apiInstance = new OpenAPI\Client\Api\GroupServiceApi(
    // 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()
);
$envGroup = 'envGroup_example'; // string
$envName = 'envName_example'; // string
$ownerUid = 56; // int

try {
    $result = $apiInstance->environmentGroupRestRemovegroupPost($envGroup, $envName, $ownerUid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupServiceApi->environmentGroupRestRemovegroupPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
envGroup string
envName string [optional]
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]

environmentGroupRestSetenvPost()

environmentGroupRestSetenvPost($envGroup, $envName, $targetAppid): \OpenAPI\Client\Model\ComHivextApiServerDevelopmentResponseInterfacesArrayResponse

Set env to group

Example

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



$apiInstance = new OpenAPI\Client\Api\GroupServiceApi(
    // 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()
);
$envGroup = 'envGroup_example'; // string
$envName = 'envName_example'; // string
$targetAppid = 'targetAppid_example'; // string

try {
    $result = $apiInstance->environmentGroupRestSetenvPost($envGroup, $envName, $targetAppid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupServiceApi->environmentGroupRestSetenvPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
envGroup string
envName string [optional]
targetAppid string [optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerDevelopmentResponseInterfacesArrayResponse

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]

environmentGroupRestSetisolationenabledPost()

environmentGroupRestSetisolationenabledPost($groupName, $enabled, $envName, $ownerUid): \OpenAPI\Client\Model\ComHivextApiResponse

Enabled or disable isolation for specified environment group

Example

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



$apiInstance = new OpenAPI\Client\Api\GroupServiceApi(
    // 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()
);
$groupName = 'groupName_example'; // string
$enabled = True; // bool
$envName = 'envName_example'; // string
$ownerUid = 56; // int

try {
    $result = $apiInstance->environmentGroupRestSetisolationenabledPost($groupName, $enabled, $envName, $ownerUid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupServiceApi->environmentGroupRestSetisolationenabledPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
groupName string
enabled bool
envName string [optional]
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]