dohq_teamcity.VcsRootInstanceApi

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/VcsRootInstanceApi and model examples
• This is autogenerated page, don’t change them directly, use template. Read more in Development

Method	HTTP request
delete_instance_field	DELETE /app/rest/vcs-root-instances/{vcsRootInstanceLocator}/{field}
delete_repository_state	DELETE /app/rest/vcs-root-instances/{vcsRootInstanceLocator}/repositoryState
get_children	GET /app/rest/vcs-root-instances/{vcsRootInstanceLocator}/files/latest/children{path}
get_children_alias	GET /app/rest/vcs-root-instances/{vcsRootInstanceLocator}/files/latest/{path}
get_content	GET /app/rest/vcs-root-instances/{vcsRootInstanceLocator}/files/latest/content{path}
get_content_alias	GET /app/rest/vcs-root-instances/{vcsRootInstanceLocator}/files/latest/files{path}
get_metadata	GET /app/rest/vcs-root-instances/{vcsRootInstanceLocator}/files/latest/metadata{path}
get_repository_state	GET /app/rest/vcs-root-instances/{vcsRootInstanceLocator}/repositoryState
get_repository_state_creation_date	GET /app/rest/vcs-root-instances/{vcsRootInstanceLocator}/repositoryState/creationDate
get_root	GET /app/rest/vcs-root-instances/{vcsRootInstanceLocator}/files/latest
get_zipped	GET /app/rest/vcs-root-instances/{vcsRootInstanceLocator}/files/latest/archived{path}
schedule_checking_for_changes	POST /app/rest/vcs-root-instances/checkingForChangesQueue
schedule_checking_for_changes_0	POST /app/rest/vcs-root-instances/commitHookNotification
serve_instance	GET /app/rest/vcs-root-instances/{vcsRootInstanceLocator}
serve_instance_field	GET /app/rest/vcs-root-instances/{vcsRootInstanceLocator}/{field}
serve_instances	GET /app/rest/vcs-root-instances
serve_root_instance_properties	GET /app/rest/vcs-root-instances/{vcsRootInstanceLocator}/properties
set_instance_field	PUT /app/rest/vcs-root-instances/{vcsRootInstanceLocator}/{field}
set_repository_state	PUT /app/rest/vcs-root-instances/{vcsRootInstanceLocator}/repositoryState

delete_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_instance_locator = 'vcs_root_instance_locator_example' # str |
field = 'field_example' # str |

try:
    tc.vcs_root_instance_api.delete_instance_field(vcs_root_instance_locator, field)
except ApiException as e:
    print("Exception when calling VcsRootInstanceApi->delete_instance_field: %s\n" % e)

Name	Types	Notes
vcs_root_instance_locator	str
field	str

Return type:

void (empty response body)

Back to top

delete_repository_state

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

vcs_root_instance_locator = 'vcs_root_instance_locator_example' # str |

try:
    tc.vcs_root_instance_api.delete_repository_state(vcs_root_instance_locator)
except ApiException as e:
    print("Exception when calling VcsRootInstanceApi->delete_repository_state: %s\n" % e)

Name	Types	Notes
vcs_root_instance_locator	str

Return type:

void (empty response body)

Back to top

get_children

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

path = 'path_example' # str |
vcs_root_instance_locator = 'vcs_root_instance_locator_example' # str |
base_path = 'base_path_example' # str |  (optional)
locator = 'locator_example' # str |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.vcs_root_instance_api.get_children(path, vcs_root_instance_locator, base_path=base_path, locator=locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootInstanceApi->get_children: %s\n" % e)

Name	Types	Notes
path	str
vcs_root_instance_locator	str
base_path	str	[optional]
locator	str	[optional]
fields	str	[optional]

Return type:

Files

Back to top

get_children_alias

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

path = 'path_example' # str |
vcs_root_instance_locator = 'vcs_root_instance_locator_example' # str |
base_path = 'base_path_example' # str |  (optional)
locator = 'locator_example' # str |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.vcs_root_instance_api.get_children_alias(path, vcs_root_instance_locator, base_path=base_path, locator=locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootInstanceApi->get_children_alias: %s\n" % e)

Name	Types	Notes
path	str
vcs_root_instance_locator	str
base_path	str	[optional]
locator	str	[optional]
fields	str	[optional]

Return type:

Files

Back to top

get_content

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

path = 'path_example' # str |
vcs_root_instance_locator = 'vcs_root_instance_locator_example' # str |
response_builder = 'response_builder_example' # str |  (optional)

try:
    tc.vcs_root_instance_api.get_content(path, vcs_root_instance_locator, response_builder=response_builder)
except ApiException as e:
    print("Exception when calling VcsRootInstanceApi->get_content: %s\n" % e)

Name	Types	Notes
path	str
vcs_root_instance_locator	str
response_builder	str	[optional]

Return type:

void (empty response body)

Back to top

get_content_alias

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

path = 'path_example' # str |
vcs_root_instance_locator = 'vcs_root_instance_locator_example' # str |

try:
    tc.vcs_root_instance_api.get_content_alias(path, vcs_root_instance_locator)
except ApiException as e:
    print("Exception when calling VcsRootInstanceApi->get_content_alias: %s\n" % e)

Name	Types	Notes
path	str
vcs_root_instance_locator	str

Return type:

void (empty response body)

Back to top

get_metadata

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

path = 'path_example' # str |
vcs_root_instance_locator = 'vcs_root_instance_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.vcs_root_instance_api.get_metadata(path, vcs_root_instance_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootInstanceApi->get_metadata: %s\n" % e)

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

Return type:

file

Back to top

get_repository_state

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

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

try:
    api_response = tc.vcs_root_instance_api.get_repository_state(vcs_root_instance_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootInstanceApi->get_repository_state: %s\n" % e)

Name	Types	Notes
vcs_root_instance_locator	str
fields	str	[optional]

Return type:

Entries

Back to top

get_repository_state_creation_date

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

vcs_root_instance_locator = 'vcs_root_instance_locator_example' # str |

try:
    api_response = tc.vcs_root_instance_api.get_repository_state_creation_date(vcs_root_instance_locator)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootInstanceApi->get_repository_state_creation_date: %s\n" % e)

Name	Types	Notes
vcs_root_instance_locator	str

Return type:

str

Back to top

get_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_instance_locator = 'vcs_root_instance_locator_example' # str |
base_path = 'base_path_example' # str |  (optional)
locator = 'locator_example' # str |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.vcs_root_instance_api.get_root(vcs_root_instance_locator, base_path=base_path, locator=locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootInstanceApi->get_root: %s\n" % e)

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

Return type:

Files

Back to top

get_zipped

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

path = 'path_example' # str |
vcs_root_instance_locator = 'vcs_root_instance_locator_example' # str |
base_path = 'base_path_example' # str |  (optional)
locator = 'locator_example' # str |  (optional)
name = 'name_example' # str |  (optional)

try:
    tc.vcs_root_instance_api.get_zipped(path, vcs_root_instance_locator, base_path=base_path, locator=locator, name=name)
except ApiException as e:
    print("Exception when calling VcsRootInstanceApi->get_zipped: %s\n" % e)

Name	Types	Notes
path	str
vcs_root_instance_locator	str
base_path	str	[optional]
locator	str	[optional]
name	str	[optional]

Return type:

void (empty response body)

Back to top

schedule_checking_for_changes

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)
requestor = 'requestor_example' # str |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.vcs_root_instance_api.schedule_checking_for_changes(locator=locator, requestor=requestor, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootInstanceApi->schedule_checking_for_changes: %s\n" % e)

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

Return type:

VcsRootInstances

Back to top

schedule_checking_for_changes_0

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)
ok_on_nothing_found = true # bool |  (optional)

try:
    tc.vcs_root_instance_api.schedule_checking_for_changes_0(locator=locator, ok_on_nothing_found=ok_on_nothing_found)
except ApiException as e:
    print("Exception when calling VcsRootInstanceApi->schedule_checking_for_changes_0: %s\n" % e)

Name	Types	Notes
locator	str	[optional]
ok_on_nothing_found	bool	[optional]

Return type:

void (empty response body)

Back to top

serve_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_instance_locator = 'vcs_root_instance_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.vcs_root_instance_api.serve_instance(vcs_root_instance_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootInstanceApi->serve_instance: %s\n" % e)

Name	Types	Notes
vcs_root_instance_locator	str
fields	str	[optional]

Return type:

VcsRootInstance

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_instance_locator = 'vcs_root_instance_locator_example' # str |
field = 'field_example' # str |

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

Name	Types	Notes
vcs_root_instance_locator	str
field	str

Return type:

str

Back to top

serve_instances

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_instance_api.serve_instances(locator=locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootInstanceApi->serve_instances: %s\n" % e)

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

Return type:

VcsRootInstances

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_instance_locator = 'vcs_root_instance_locator_example' # str |
fields = 'fields_example' # str |  (optional)

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

Name	Types	Notes
vcs_root_instance_locator	str
fields	str	[optional]

Return type:

Properties

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_instance_locator = 'vcs_root_instance_locator_example' # str |
field = 'field_example' # str |
body = 'body_example' # str |  (optional)

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

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

Return type:

str

Back to top

set_repository_state

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

vcs_root_instance_locator = 'vcs_root_instance_locator_example' # str |
body = dohq_teamcity.Entries() # Entries |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.vcs_root_instance_api.set_repository_state(vcs_root_instance_locator, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling VcsRootInstanceApi->set_repository_state: %s\n" % e)

Name	Types	Notes
vcs_root_instance_locator	str
body	Entries	[optional]
fields	str	[optional]

Return type:

Entries

Back to top