dohq_teamcity.ChangeApi¶

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

Method	HTTP request
get_change_attributes	GET `/app/rest/changes/{changeLocator}/attributes`
get_change_duplicates	GET `/app/rest/changes/{changeLocator}/duplicates`
get_change_field	GET `/app/rest/changes/{changeLocator}/{field}`
get_change_first_builds	GET `/app/rest/changes/{changeLocator}/firstBuilds`
get_change_issue	GET `/app/rest/changes/{changeLocator}/issues`
get_change_parent_revisions	GET `/app/rest/changes/{changeLocator}/parentRevisions`
get_change_vcs_root	GET `/app/rest/changes/{changeLocator}/vcsRoot`
get_change_vcs_root_instance	GET `/app/rest/changes/{changeLocator}/vcsRootInstance`
get_parent_changes	GET `/app/rest/changes/{changeLocator}/parentChanges`
get_related_build_types	GET `/app/rest/changes/{changeLocator}/buildTypes`
serve_change	GET `/app/rest/changes/{changeLocator}`
serve_changes	GET `/app/rest/changes`

get_change_attributes¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

change_locator = 'change_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.change_api.get_change_attributes(change_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangeApi->get_change_attributes: %s\n" % e)

Name	Types	Notes
change_locator	str
fields	str	[optional]

Return type:: Entries

Back to top

get_change_duplicates¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

change_locator = 'change_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.change_api.get_change_duplicates(change_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangeApi->get_change_duplicates: %s\n" % e)

Name	Types	Notes
change_locator	str
fields	str	[optional]

Return type:: Changes

Back to top

get_change_field¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

change_locator = 'change_locator_example' # str |
field = 'field_example' # str |

try:
    api_response = tc.change_api.get_change_field(change_locator, field)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangeApi->get_change_field: %s\n" % e)

Name	Types	Notes
change_locator	str
field	str

Return type:: str

Back to top

get_change_first_builds¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

change_locator = 'change_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.change_api.get_change_first_builds(change_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangeApi->get_change_first_builds: %s\n" % e)

Name	Types	Notes
change_locator	str
fields	str	[optional]

Return type:: Builds

Back to top

get_change_issue¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

change_locator = 'change_locator_example' # str |

try:
    api_response = tc.change_api.get_change_issue(change_locator)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangeApi->get_change_issue: %s\n" % e)

Name	Types	Notes
change_locator	str

Return type:: Issues

Back to top

get_change_parent_revisions¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

change_locator = 'change_locator_example' # str |

try:
    api_response = tc.change_api.get_change_parent_revisions(change_locator)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangeApi->get_change_parent_revisions: %s\n" % e)

Name	Types	Notes
change_locator	str

Return type:: Items

Back to top

get_change_vcs_root¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

change_locator = 'change_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.change_api.get_change_vcs_root(change_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangeApi->get_change_vcs_root: %s\n" % e)

Name	Types	Notes
change_locator	str
fields	str	[optional]

Return type:: VcsRootInstance

Back to top

get_change_vcs_root_instance¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

change_locator = 'change_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.change_api.get_change_vcs_root_instance(change_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangeApi->get_change_vcs_root_instance: %s\n" % e)

Name	Types	Notes
change_locator	str
fields	str	[optional]

Return type:: VcsRootInstance

Back to top

get_parent_changes¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

change_locator = 'change_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.change_api.get_parent_changes(change_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangeApi->get_parent_changes: %s\n" % e)

Name	Types	Notes
change_locator	str
fields	str	[optional]

Return type:: Changes

Back to top

get_related_build_types¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

change_locator = 'change_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.change_api.get_related_build_types(change_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangeApi->get_related_build_types: %s\n" % e)

Name	Types	Notes
change_locator	str
fields	str	[optional]

Return type:: BuildTypes

Back to top

serve_change¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

change_locator = 'change_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.change_api.serve_change(change_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangeApi->serve_change: %s\n" % e)

Name	Types	Notes
change_locator	str
fields	str	[optional]

Return type:: Change

Back to top

serve_changes¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

project = 'project_example' # str |  (optional)
build_type = 'build_type_example' # str |  (optional)
build = 'build_example' # str |  (optional)
vcs_root = 'vcs_root_example' # str |  (optional)
since_change = 'since_change_example' # str |  (optional)
start = 789 # int |  (optional)
count = 56 # int |  (optional)
locator = 'locator_example' # str |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.change_api.serve_changes(project=project, build_type=build_type, build=build, vcs_root=vcs_root, since_change=since_change, start=start, count=count, locator=locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangeApi->serve_changes: %s\n" % e)

Name	Types	Notes
project	str	[optional]
build_type	str	[optional]
build	str	[optional]
vcs_root	str	[optional]
since_change	str	[optional]
start	int	[optional]
count	int	[optional]
locator	str	[optional]
fields	str	[optional]

Return type:: Changes

Back to top