dohq_teamcity.DefaultApi

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

Method	HTTP request
serve_api_version	GET /app/rest/apiVersion
serve_build_field_short	GET /app/rest/{projectLocator}/{btLocator}/{buildLocator}/{field}
serve_plugin_info	GET /app/rest/info
serve_root	GET /app/rest
serve_version	GET /app/rest/version

serve_api_version

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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


try:
    api_response = tc.default_api.serve_api_version()
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->serve_api_version: %s\n" % e)

This endpoint does not need any parameter.

Return type:

str

Back to top

serve_build_field_short

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

project_locator = 'project_locator_example' # str |
bt_locator = 'bt_locator_example' # str |
build_locator = 'build_locator_example' # str |
field = 'field_example' # str |

try:
    api_response = tc.default_api.serve_build_field_short(project_locator, bt_locator, build_locator, field)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->serve_build_field_short: %s\n" % e)

Name	Types	Notes
project_locator	str
bt_locator	str
build_locator	str
field	str

Return type:

str

Back to top

serve_plugin_info

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.default_api.serve_plugin_info(fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->serve_plugin_info: %s\n" % e)

Name	Types	Notes
fields	str	[optional]

Return type:

Plugin

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'))


try:
    api_response = tc.default_api.serve_root()
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->serve_root: %s\n" % e)

This endpoint does not need any parameter.

Return type:

str

Back to top

serve_version

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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


try:
    api_response = tc.default_api.serve_version()
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->serve_version: %s\n" % e)

This endpoint does not need any parameter.

Return type:

str

Back to top