dohq_teamcity.VcsRootApi¶

Note

All serve_* method have aliases with get: serve_something == get_something
Some API have get method - default method to get object by locator (e.g agent_api.get('id:123') return Agent model by id
See more examples on page /examples/api/VcsRootApi and model examples
This is autogenerated page, don’t change them directly, use template. Read more in Development

Method	HTTP request
add_root	POST `/app/rest/vcs-roots`
change_properties	PUT `/app/rest/vcs-roots/{vcsRootLocator}/properties`
delete_all_properties	DELETE `/app/rest/vcs-roots/{vcsRootLocator}/properties`
delete_parameter	DELETE `/app/rest/vcs-roots/{vcsRootLocator}/properties/{name}`
delete_root	DELETE `/app/rest/vcs-roots/{vcsRootLocator}`
get_settings_file	GET `/app/rest/vcs-roots/{vcsRootLocator}/settingsFile`
put_parameter	PUT `/app/rest/vcs-roots/{vcsRootLocator}/properties/{name}`
serve_field	GET `/app/rest/vcs-roots/{vcsRootLocator}/{field}`
serve_instance_field	GET `/app/rest/vcs-roots/{vcsRootLocator}/instances/{vcsRootInstanceLocator}/{field}`
serve_properties	GET `/app/rest/vcs-roots/{vcsRootLocator}/properties`
serve_property	GET `/app/rest/vcs-roots/{vcsRootLocator}/properties/{name}`
serve_root	GET `/app/rest/vcs-roots/{vcsRootLocator}`
serve_root_instance	GET `/app/rest/vcs-roots/{vcsRootLocator}/instances/{vcsRootInstanceLocator}`
serve_root_instance_properties	GET `/app/rest/vcs-roots/{vcsRootLocator}/instances/{vcsRootInstanceLocator}/properties`
serve_root_instances	GET `/app/rest/vcs-roots/{vcsRootLocator}/instances`
serve_roots	GET `/app/rest/vcs-roots`
set_field	PUT `/app/rest/vcs-roots/{vcsRootLocator}/{field}`
set_instance_field	PUT `/app/rest/vcs-roots/{vcsRootLocator}/instances/{vcsRootInstanceLocator}/{field}`

add_root¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

body = dohq_teamcity.VcsRoot() # VcsRoot |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.vcs_root_api.add_root(body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootApi->add_root: %s\n" % e)

Name	Types	Notes
body	VcsRoot	[optional]
fields	str	[optional]

Return type:: VcsRoot

Back to top

change_properties¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

vcs_root_locator = 'vcs_root_locator_example' # str |
body = dohq_teamcity.Properties() # Properties |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.vcs_root_api.change_properties(vcs_root_locator, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootApi->change_properties: %s\n" % e)

Name	Types	Notes
vcs_root_locator	str
body	Properties	[optional]
fields	str	[optional]

Return type:: Properties

Back to top

delete_all_properties¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

vcs_root_locator = 'vcs_root_locator_example' # str |

try:
    tc.vcs_root_api.delete_all_properties(vcs_root_locator)
except ApiException as e:
    print("Exception when calling VcsRootApi->delete_all_properties: %s\n" % e)

Name	Types	Notes
vcs_root_locator	str

Return type:: void (empty response body)

Back to top

delete_parameter¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

vcs_root_locator = 'vcs_root_locator_example' # str |
name = 'name_example' # str |

try:
    tc.vcs_root_api.delete_parameter(vcs_root_locator, name)
except ApiException as e:
    print("Exception when calling VcsRootApi->delete_parameter: %s\n" % e)

Name	Types	Notes
vcs_root_locator	str
name	str

Return type:: void (empty response body)

Back to top

delete_root¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

vcs_root_locator = 'vcs_root_locator_example' # str |

try:
    tc.vcs_root_api.delete_root(vcs_root_locator)
except ApiException as e:
    print("Exception when calling VcsRootApi->delete_root: %s\n" % e)

Name	Types	Notes
vcs_root_locator	str

Return type:: void (empty response body)

Back to top

get_settings_file¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

vcs_root_locator = 'vcs_root_locator_example' # str |

try:
    api_response = tc.vcs_root_api.get_settings_file(vcs_root_locator)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootApi->get_settings_file: %s\n" % e)

Name	Types	Notes
vcs_root_locator	str

Return type:: str

Back to top

put_parameter¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

vcs_root_locator = 'vcs_root_locator_example' # str |
name = 'name_example' # str |
body = 'body_example' # str |  (optional)

try:
    api_response = tc.vcs_root_api.put_parameter(vcs_root_locator, name, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootApi->put_parameter: %s\n" % e)

Name	Types	Notes
vcs_root_locator	str
name	str
body	str	[optional]

Return type:: str

Back to top

serve_field¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

vcs_root_locator = 'vcs_root_locator_example' # str |
field = 'field_example' # str |

try:
    api_response = tc.vcs_root_api.serve_field(vcs_root_locator, field)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootApi->serve_field: %s\n" % e)

Name	Types	Notes
vcs_root_locator	str
field	str

Return type:: str

Back to top

serve_instance_field¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

vcs_root_locator = 'vcs_root_locator_example' # str |
vcs_root_instance_locator = 'vcs_root_instance_locator_example' # str |
field = 'field_example' # str |

try:
    api_response = tc.vcs_root_api.serve_instance_field(vcs_root_locator, vcs_root_instance_locator, field)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootApi->serve_instance_field: %s\n" % e)

Name	Types	Notes
vcs_root_locator	str
vcs_root_instance_locator	str
field	str

Return type:: str

Back to top

serve_properties¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

vcs_root_locator = 'vcs_root_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.vcs_root_api.serve_properties(vcs_root_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootApi->serve_properties: %s\n" % e)

Name	Types	Notes
vcs_root_locator	str
fields	str	[optional]

Return type:: Properties

Back to top

serve_property¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

vcs_root_locator = 'vcs_root_locator_example' # str |
name = 'name_example' # str |

try:
    api_response = tc.vcs_root_api.serve_property(vcs_root_locator, name)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootApi->serve_property: %s\n" % e)

Name	Types	Notes
vcs_root_locator	str
name	str

Return type:: str

Back to top

serve_root¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

vcs_root_locator = 'vcs_root_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.vcs_root_api.serve_root(vcs_root_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootApi->serve_root: %s\n" % e)

Name	Types	Notes
vcs_root_locator	str
fields	str	[optional]

Return type:: VcsRoot

Back to top

serve_root_instance¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

vcs_root_locator = 'vcs_root_locator_example' # str |
vcs_root_instance_locator = 'vcs_root_instance_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.vcs_root_api.serve_root_instance(vcs_root_locator, vcs_root_instance_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootApi->serve_root_instance: %s\n" % e)

Name	Types	Notes
vcs_root_locator	str
vcs_root_instance_locator	str
fields	str	[optional]

Return type:: VcsRootInstance

Back to top

serve_root_instance_properties¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

vcs_root_locator = 'vcs_root_locator_example' # str |
vcs_root_instance_locator = 'vcs_root_instance_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.vcs_root_api.serve_root_instance_properties(vcs_root_locator, vcs_root_instance_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootApi->serve_root_instance_properties: %s\n" % e)

Name	Types	Notes
vcs_root_locator	str
vcs_root_instance_locator	str
fields	str	[optional]

Return type:: Properties

Back to top

serve_root_instances¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

vcs_root_locator = 'vcs_root_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.vcs_root_api.serve_root_instances(vcs_root_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootApi->serve_root_instances: %s\n" % e)

Name	Types	Notes
vcs_root_locator	str
fields	str	[optional]

Return type:: VcsRootInstances

Back to top

serve_roots¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

locator = 'locator_example' # str |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.vcs_root_api.serve_roots(locator=locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootApi->serve_roots: %s\n" % e)

Name	Types	Notes
locator	str	[optional]
fields	str	[optional]

Return type:: VcsRoots

Back to top

set_field¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

vcs_root_locator = 'vcs_root_locator_example' # str |
field = 'field_example' # str |
body = 'body_example' # str |  (optional)

try:
    api_response = tc.vcs_root_api.set_field(vcs_root_locator, field, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootApi->set_field: %s\n" % e)

Name	Types	Notes
vcs_root_locator	str
field	str
body	str	[optional]

Return type:: str

Back to top

set_instance_field¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

vcs_root_locator = 'vcs_root_locator_example' # str |
vcs_root_instance_locator = 'vcs_root_instance_locator_example' # str |
field = 'field_example' # str |
body = 'body_example' # str |  (optional)

try:
    api_response = tc.vcs_root_api.set_instance_field(vcs_root_locator, vcs_root_instance_locator, field, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootApi->set_instance_field: %s\n" % e)

Name	Types	Notes
vcs_root_locator	str
vcs_root_instance_locator	str
field	str
body	str	[optional]

Return type:: str

Back to top