TeamCityClient\VcsRootApi

All URIs are relative to https://vs-szp-ds01.otr.ru:8111

Method	HTTP request	Description
addRoot	POST /app/rest/vcs-roots
changeProperties	PUT /app/rest/vcs-roots/{vcsRootLocator}/properties
deleteAllProperties	DELETE /app/rest/vcs-roots/{vcsRootLocator}/properties
deleteParameter	DELETE /app/rest/vcs-roots/{vcsRootLocator}/properties/{name}
deleteRoot	DELETE /app/rest/vcs-roots/{vcsRootLocator}
getSettingsFile	GET /app/rest/vcs-roots/{vcsRootLocator}/settingsFile
putParameter	PUT /app/rest/vcs-roots/{vcsRootLocator}/properties/{name}
serveField	GET /app/rest/vcs-roots/{vcsRootLocator}/{field}
serveInstanceField	GET /app/rest/vcs-roots/{vcsRootLocator}/instances/{vcsRootInstanceLocator}/{field}
serveProperties	GET /app/rest/vcs-roots/{vcsRootLocator}/properties
serveProperty	GET /app/rest/vcs-roots/{vcsRootLocator}/properties/{name}
serveRoot	GET /app/rest/vcs-roots/{vcsRootLocator}
serveRootInstance	GET /app/rest/vcs-roots/{vcsRootLocator}/instances/{vcsRootInstanceLocator}
serveRootInstanceProperties	GET /app/rest/vcs-roots/{vcsRootLocator}/instances/{vcsRootInstanceLocator}/properties
serveRootInstances	GET /app/rest/vcs-roots/{vcsRootLocator}/instances
serveRoots	GET /app/rest/vcs-roots
setField	PUT /app/rest/vcs-roots/{vcsRootLocator}/{field}
setInstanceField	PUT /app/rest/vcs-roots/{vcsRootLocator}/instances/{vcsRootInstanceLocator}/{field}

addRoot

\TeamCityClient\Model\VcsRoot addRoot($body, $fields)

Example

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

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

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

Parameters

Name	Type	Description	Notes
body	\TeamCityClient\Model\VcsRoot		[optional]
fields	string		[optional]

Return type

\TeamCityClient\Model\VcsRoot

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

changeProperties

\TeamCityClient\Model\Properties changeProperties($vcs_root_locator, $body, $fields)

Example

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

$apiInstance = new TeamCityClient\Api\VcsRootApi(
    // 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()
);
$vcs_root_locator = "vcs_root_locator_example"; // string | 
$body = new \TeamCityClient\Model\Properties(); // \TeamCityClient\Model\Properties | 
$fields = "fields_example"; // string | 

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

Parameters

Name	Type	Notes
vcs_root_locator	string
body	\TeamCityClient\Model\Properties	[optional]
fields	string	[optional]

Return type

\TeamCityClient\Model\Properties

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

deleteAllProperties

deleteAllProperties($vcs_root_locator)

Example

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

$apiInstance = new TeamCityClient\Api\VcsRootApi(
    // 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()
);
$vcs_root_locator = "vcs_root_locator_example"; // string | 

try {
    $apiInstance->deleteAllProperties($vcs_root_locator);
} catch (Exception $e) {
    echo 'Exception when calling VcsRootApi->deleteAllProperties: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
vcs_root_locator	string

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

deleteParameter

deleteParameter($vcs_root_locator, $name)

Example

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

$apiInstance = new TeamCityClient\Api\VcsRootApi(
    // 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()
);
$vcs_root_locator = "vcs_root_locator_example"; // string | 
$name = "name_example"; // string | 

try {
    $apiInstance->deleteParameter($vcs_root_locator, $name);
} catch (Exception $e) {
    echo 'Exception when calling VcsRootApi->deleteParameter: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
vcs_root_locator	string
name	string

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

deleteRoot

deleteRoot($vcs_root_locator)

Example

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

$apiInstance = new TeamCityClient\Api\VcsRootApi(
    // 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()
);
$vcs_root_locator = "vcs_root_locator_example"; // string | 

try {
    $apiInstance->deleteRoot($vcs_root_locator);
} catch (Exception $e) {
    echo 'Exception when calling VcsRootApi->deleteRoot: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
vcs_root_locator	string

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

getSettingsFile

string getSettingsFile($vcs_root_locator)

Example

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

$apiInstance = new TeamCityClient\Api\VcsRootApi(
    // 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()
);
$vcs_root_locator = "vcs_root_locator_example"; // string | 

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

Parameters

Name	Type	Description	Notes
vcs_root_locator	string

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

putParameter

string putParameter($vcs_root_locator, $name, $body)

Example

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

$apiInstance = new TeamCityClient\Api\VcsRootApi(
    // 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()
);
$vcs_root_locator = "vcs_root_locator_example"; // string | 
$name = "name_example"; // string | 
$body = "body_example"; // string | 

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

Parameters

Name	Type	Notes
vcs_root_locator	string
name	string
body	string	[optional]

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

serveField

string serveField($vcs_root_locator, $field)

Example

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

$apiInstance = new TeamCityClient\Api\VcsRootApi(
    // 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()
);
$vcs_root_locator = "vcs_root_locator_example"; // string | 
$field = "field_example"; // string | 

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

Parameters

Name	Type	Description	Notes
vcs_root_locator	string
field	string

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

serveInstanceField

string serveInstanceField($vcs_root_locator, $vcs_root_instance_locator, $field)

Example

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

$apiInstance = new TeamCityClient\Api\VcsRootApi(
    // 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()
);
$vcs_root_locator = "vcs_root_locator_example"; // string | 
$vcs_root_instance_locator = "vcs_root_instance_locator_example"; // string | 
$field = "field_example"; // string | 

try {
    $result = $apiInstance->serveInstanceField($vcs_root_locator, $vcs_root_instance_locator, $field);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VcsRootApi->serveInstanceField: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
vcs_root_locator	string
vcs_root_instance_locator	string
field	string

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

serveProperties

\TeamCityClient\Model\Properties serveProperties($vcs_root_locator, $fields)

Example

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

$apiInstance = new TeamCityClient\Api\VcsRootApi(
    // 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()
);
$vcs_root_locator = "vcs_root_locator_example"; // string | 
$fields = "fields_example"; // string | 

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

Parameters

Name	Type	Description	Notes
vcs_root_locator	string
fields	string		[optional]

Return type

\TeamCityClient\Model\Properties

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

serveProperty

string serveProperty($vcs_root_locator, $name)

Example

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

$apiInstance = new TeamCityClient\Api\VcsRootApi(
    // 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()
);
$vcs_root_locator = "vcs_root_locator_example"; // string | 
$name = "name_example"; // string | 

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

Parameters

Name	Type	Description	Notes
vcs_root_locator	string
name	string

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

serveRoot

\TeamCityClient\Model\VcsRoot serveRoot($vcs_root_locator, $fields)

Example

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

$apiInstance = new TeamCityClient\Api\VcsRootApi(
    // 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()
);
$vcs_root_locator = "vcs_root_locator_example"; // string | 
$fields = "fields_example"; // string | 

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

Parameters

Name	Type	Description	Notes
vcs_root_locator	string
fields	string		[optional]

Return type

\TeamCityClient\Model\VcsRoot

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

serveRootInstance

\TeamCityClient\Model\VcsRootInstance serveRootInstance($vcs_root_locator, $vcs_root_instance_locator, $fields)

Example

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

$apiInstance = new TeamCityClient\Api\VcsRootApi(
    // 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()
);
$vcs_root_locator = "vcs_root_locator_example"; // string | 
$vcs_root_instance_locator = "vcs_root_instance_locator_example"; // string | 
$fields = "fields_example"; // string | 

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

Parameters

Name	Type	Notes
vcs_root_locator	string
vcs_root_instance_locator	string
fields	string	[optional]

Return type

\TeamCityClient\Model\VcsRootInstance

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

serveRootInstanceProperties

\TeamCityClient\Model\Properties serveRootInstanceProperties($vcs_root_locator, $vcs_root_instance_locator, $fields)

Example

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

$apiInstance = new TeamCityClient\Api\VcsRootApi(
    // 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()
);
$vcs_root_locator = "vcs_root_locator_example"; // string | 
$vcs_root_instance_locator = "vcs_root_instance_locator_example"; // string | 
$fields = "fields_example"; // string | 

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

Parameters

Name	Type	Notes
vcs_root_locator	string
vcs_root_instance_locator	string
fields	string	[optional]

Return type

\TeamCityClient\Model\Properties

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

serveRootInstances

\TeamCityClient\Model\VcsRootInstances serveRootInstances($vcs_root_locator, $fields)

Example

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

$apiInstance = new TeamCityClient\Api\VcsRootApi(
    // 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()
);
$vcs_root_locator = "vcs_root_locator_example"; // string | 
$fields = "fields_example"; // string | 

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

Parameters

Name	Type	Description	Notes
vcs_root_locator	string
fields	string		[optional]

Return type

\TeamCityClient\Model\VcsRootInstances

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

serveRoots

\TeamCityClient\Model\VcsRoots serveRoots($locator, $fields)

Example

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

$apiInstance = new TeamCityClient\Api\VcsRootApi(
    // 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()
);
$locator = "locator_example"; // string | 
$fields = "fields_example"; // string | 

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

Parameters

Name	Type	Description	Notes
locator	string		[optional]
fields	string		[optional]

Return type

\TeamCityClient\Model\VcsRoots

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

setField

string setField($vcs_root_locator, $field, $body)

Example

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

$apiInstance = new TeamCityClient\Api\VcsRootApi(
    // 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()
);
$vcs_root_locator = "vcs_root_locator_example"; // string | 
$field = "field_example"; // string | 
$body = "body_example"; // string | 

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

Parameters

Name	Type	Notes
vcs_root_locator	string
field	string
body	string	[optional]

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

setInstanceField

string setInstanceField($vcs_root_locator, $vcs_root_instance_locator, $field, $body)

Example

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

$apiInstance = new TeamCityClient\Api\VcsRootApi(
    // 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()
);
$vcs_root_locator = "vcs_root_locator_example"; // string | 
$vcs_root_instance_locator = "vcs_root_instance_locator_example"; // string | 
$field = "field_example"; // string | 
$body = "body_example"; // string | 

try {
    $result = $apiInstance->setInstanceField($vcs_root_locator, $vcs_root_instance_locator, $field, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VcsRootApi->setInstanceField: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
vcs_root_locator	string
vcs_root_instance_locator	string
field	string
body	string	[optional]

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

Files

VcsRootApi.md

Latest commit

History

VcsRootApi.md

File metadata and controls

TeamCityClient\VcsRootApi

addRoot

Example

Parameters

Return type

Authorization

HTTP request headers

changeProperties

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAllProperties

Example

Parameters

Return type

Authorization

HTTP request headers

deleteParameter

Example

Parameters

Return type

Authorization

HTTP request headers

deleteRoot

Example

Parameters

Return type

Authorization

HTTP request headers

getSettingsFile

Example

Parameters

Return type

Authorization

HTTP request headers

putParameter

Example

Parameters

Return type

Authorization

HTTP request headers

serveField

Example

Parameters

Return type

Authorization

HTTP request headers

serveInstanceField

Example

Parameters

Return type

Authorization

HTTP request headers

serveProperties

Example

Parameters

Return type

Authorization

HTTP request headers

serveProperty

Example

Parameters

Return type

Authorization

HTTP request headers

serveRoot

Example

Parameters

Return type

Authorization

HTTP request headers

serveRootInstance