dohq_teamcity.BuildTypeApi

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

Method	HTTP request
add_agent_requirement	POST /app/rest/buildTypes/{btLocator}/agent-requirements
add_artifact_dep	POST /app/rest/buildTypes/{btLocator}/artifact-dependencies
add_build_type	POST /app/rest/buildTypes
add_feature	POST /app/rest/buildTypes/{btLocator}/features
add_feature_parameter	PUT /app/rest/buildTypes/{btLocator}/features/{featureId}/parameters/{parameterName}
add_snapshot_dep	POST /app/rest/buildTypes/{btLocator}/snapshot-dependencies
add_step	POST /app/rest/buildTypes/{btLocator}/steps
add_step_parameter	PUT /app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters/{parameterName}
add_template	POST /app/rest/buildTypes/{btLocator}/templates
add_trigger	POST /app/rest/buildTypes/{btLocator}/triggers
add_vcs_root_entry	POST /app/rest/buildTypes/{btLocator}/vcs-root-entries
change_artifact_dep_setting	PUT /app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}/{fieldName}
change_feature_setting	PUT /app/rest/buildTypes/{btLocator}/features/{featureId}/{name}
change_requirement_setting	PUT /app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}/{fieldName}
change_step_setting	PUT /app/rest/buildTypes/{btLocator}/steps/{stepId}/{fieldName}
change_trigger_setting	PUT /app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}/{fieldName}
delete_agent_requirement	DELETE /app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}
delete_all_parameters	DELETE /app/rest/buildTypes/{btLocator}/parameters
delete_all_parameters_0	DELETE /app/rest/buildTypes/{btLocator}/settings
delete_artifact_dep	DELETE /app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}
delete_build_type	DELETE /app/rest/buildTypes/{btLocator}
delete_feature	DELETE /app/rest/buildTypes/{btLocator}/features/{featureId}
delete_parameter	DELETE /app/rest/buildTypes/{btLocator}/parameters/{name}
delete_parameter_0	DELETE /app/rest/buildTypes/{btLocator}/settings/{name}
delete_snapshot_dep	DELETE /app/rest/buildTypes/{btLocator}/snapshot-dependencies/{snapshotDepLocator}
delete_step	DELETE /app/rest/buildTypes/{btLocator}/steps/{stepId}
delete_trigger	DELETE /app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}
delete_vcs_root_entry	DELETE /app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}
get_agent_requirement	GET /app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}
get_agent_requirements	GET /app/rest/buildTypes/{btLocator}/agent-requirements
get_aliases	GET /app/rest/buildTypes/{btLocator}/aliases
get_artifact_dep	GET /app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}
get_artifact_dep_setting	GET /app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}/{fieldName}
get_artifact_deps	GET /app/rest/buildTypes/{btLocator}/artifact-dependencies
get_build_types	GET /app/rest/buildTypes
get_children	GET /app/rest/buildTypes/{btLocator}/vcs/files/latest/children{path}
get_children_alias	GET /app/rest/buildTypes/{btLocator}/vcs/files/latest/{path}
get_content	GET /app/rest/buildTypes/{btLocator}/vcs/files/latest/content{path}
get_content_alias	GET /app/rest/buildTypes/{btLocator}/vcs/files/latest/files{path}
get_current_vcs_instances	GET /app/rest/buildTypes/{btLocator}/vcsRootInstances
get_current_vcs_instances_obsolete	GET /app/rest/buildTypes/{btLocator}/vcs-root-instances
get_example_new_project_description	GET /app/rest/buildTypes/{btLocator}/example/newBuildTypeDescription
get_example_new_project_description_compatibility_version1	GET /app/rest/buildTypes/{btLocator}/newBuildTypeDescription
get_feature	GET /app/rest/buildTypes/{btLocator}/features/{featureId}
get_feature_parameter	GET /app/rest/buildTypes/{btLocator}/features/{featureId}/parameters/{parameterName}
get_feature_parameters	GET /app/rest/buildTypes/{btLocator}/features/{featureId}/parameters
get_feature_setting	GET /app/rest/buildTypes/{btLocator}/features/{featureId}/{name}
get_features	GET /app/rest/buildTypes/{btLocator}/features
get_investigations	GET /app/rest/buildTypes/{btLocator}/investigations
get_metadata	GET /app/rest/buildTypes/{btLocator}/vcs/files/latest/metadata{path}
get_parameter	GET /app/rest/buildTypes/{btLocator}/parameters/{name}
get_parameter_0	GET /app/rest/buildTypes/{btLocator}/settings/{name}
get_parameter_type	GET /app/rest/buildTypes/{btLocator}/parameters/{name}/type
get_parameter_type_raw_value	GET /app/rest/buildTypes/{btLocator}/parameters/{name}/type/rawValue
get_parameter_value_long	GET /app/rest/buildTypes/{btLocator}/parameters/{name}/value
get_parameter_value_long_0	GET /app/rest/buildTypes/{btLocator}/settings/{name}/value
get_parameters	GET /app/rest/buildTypes/{btLocator}/parameters
get_parameters_0	GET /app/rest/buildTypes/{btLocator}/settings
get_requirement_setting	GET /app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}/{fieldName}
get_root	GET /app/rest/buildTypes/{btLocator}/vcs/files/latest
get_settings_file	GET /app/rest/buildTypes/{btLocator}/settingsFile
get_snapshot_dep	GET /app/rest/buildTypes/{btLocator}/snapshot-dependencies/{snapshotDepLocator}
get_snapshot_deps	GET /app/rest/buildTypes/{btLocator}/snapshot-dependencies
get_step	GET /app/rest/buildTypes/{btLocator}/steps/{stepId}
get_step_parameter	GET /app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters/{parameterName}
get_step_parameters	GET /app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters
get_step_setting	GET /app/rest/buildTypes/{btLocator}/steps/{stepId}/{fieldName}
get_steps	GET /app/rest/buildTypes/{btLocator}/steps
get_template	GET /app/rest/buildTypes/{btLocator}/templates/{templateLocator}
get_templates	GET /app/rest/buildTypes/{btLocator}/templates
get_trigger	GET /app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}
get_trigger_setting	GET /app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}/{fieldName}
get_triggers	GET /app/rest/buildTypes/{btLocator}/triggers
get_vcs_labeling_options	GET /app/rest/buildTypes/{btLocator}/vcsLabeling
get_vcs_root_entries	GET /app/rest/buildTypes/{btLocator}/vcs-root-entries
get_vcs_root_entry	GET /app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}
get_vcs_root_entry_checkout_rules	GET /app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}/checkout-rules
get_zipped	GET /app/rest/buildTypes/{btLocator}/vcs/files/latest/archived{path}
remove_all_templates	DELETE /app/rest/buildTypes/{btLocator}/templates
remove_template	DELETE /app/rest/buildTypes/{btLocator}/templates/{templateLocator}
replace_agent_requirement	PUT /app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}
replace_agent_requirements	PUT /app/rest/buildTypes/{btLocator}/agent-requirements
replace_artifact_dep	PUT /app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}
replace_artifact_deps	PUT /app/rest/buildTypes/{btLocator}/artifact-dependencies
replace_feature	PUT /app/rest/buildTypes/{btLocator}/features/{featureId}
replace_feature_parameters	PUT /app/rest/buildTypes/{btLocator}/features/{featureId}/parameters
replace_features	PUT /app/rest/buildTypes/{btLocator}/features
replace_snapshot_dep	PUT /app/rest/buildTypes/{btLocator}/snapshot-dependencies/{snapshotDepLocator}
replace_snapshot_deps	PUT /app/rest/buildTypes/{btLocator}/snapshot-dependencies
replace_step	PUT /app/rest/buildTypes/{btLocator}/steps/{stepId}
replace_step_parameters	PUT /app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters
replace_steps	PUT /app/rest/buildTypes/{btLocator}/steps
replace_trigger	PUT /app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}
replace_triggers	PUT /app/rest/buildTypes/{btLocator}/triggers
replace_vcs_root_entries	PUT /app/rest/buildTypes/{btLocator}/vcs-root-entries
serve_branches	GET /app/rest/buildTypes/{btLocator}/branches
serve_build_field	GET /app/rest/buildTypes/{btLocator}/builds/{buildLocator}/{field}
serve_build_type_builds_tags	GET /app/rest/buildTypes/{btLocator}/buildTags
serve_build_type_field	GET /app/rest/buildTypes/{btLocator}/{field}
serve_build_type_xml	GET /app/rest/buildTypes/{btLocator}
serve_build_with_project	GET /app/rest/buildTypes/{btLocator}/builds/{buildLocator}
serve_builds	GET /app/rest/buildTypes/{btLocator}/builds
set_build_type_field	PUT /app/rest/buildTypes/{btLocator}/{field}
set_parameter	POST /app/rest/buildTypes/{btLocator}/parameters
set_parameter_0	PUT /app/rest/buildTypes/{btLocator}/parameters/{name}
set_parameter_1	POST /app/rest/buildTypes/{btLocator}/settings
set_parameter_2	PUT /app/rest/buildTypes/{btLocator}/settings/{name}
set_parameter_type	PUT /app/rest/buildTypes/{btLocator}/parameters/{name}/type
set_parameter_type_raw_value	PUT /app/rest/buildTypes/{btLocator}/parameters/{name}/type/rawValue
set_parameter_value_long	PUT /app/rest/buildTypes/{btLocator}/parameters/{name}/value
set_parameter_value_long_0	PUT /app/rest/buildTypes/{btLocator}/settings/{name}/value
set_parameters	PUT /app/rest/buildTypes/{btLocator}/parameters
set_parameters_0	PUT /app/rest/buildTypes/{btLocator}/settings
set_templates	PUT /app/rest/buildTypes/{btLocator}/templates
set_vcs_labeling_options	PUT /app/rest/buildTypes/{btLocator}/vcsLabeling
update_vcs_root_entry	PUT /app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}
update_vcs_root_entry_checkout_rules	PUT /app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}/checkout-rules

add_agent_requirement

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)
body = dohq_teamcity.AgentRequirement() # AgentRequirement |  (optional)

try:
    api_response = tc.build_type_api.add_agent_requirement(bt_locator, fields=fields, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->add_agent_requirement: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]
body	AgentRequirement	[optional]

Return type:

AgentRequirement

Back to top

add_artifact_dep

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)
body = dohq_teamcity.ArtifactDependency() # ArtifactDependency |  (optional)

try:
    api_response = tc.build_type_api.add_artifact_dep(bt_locator, fields=fields, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->add_artifact_dep: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]
body	ArtifactDependency	[optional]

Return type:

ArtifactDependency

Back to top

add_build_type

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

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

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

Return type:

BuildType

Back to top

add_feature

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)
body = dohq_teamcity.Feature() # Feature |  (optional)

try:
    api_response = tc.build_type_api.add_feature(bt_locator, fields=fields, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->add_feature: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]
body	Feature	[optional]

Return type:

Feature

Back to top

add_feature_parameter

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
feature_id = 'feature_id_example' # str |
parameter_name = 'parameter_name_example' # str |
body = 'body_example' # str |  (optional)

try:
    api_response = tc.build_type_api.add_feature_parameter(bt_locator, feature_id, parameter_name, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->add_feature_parameter: %s\n" % e)

Name	Types	Notes
bt_locator	str
feature_id	str
parameter_name	str
body	str	[optional]

Return type:

str

Back to top

add_snapshot_dep

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)
body = dohq_teamcity.SnapshotDependency() # SnapshotDependency |  (optional)

try:
    api_response = tc.build_type_api.add_snapshot_dep(bt_locator, fields=fields, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->add_snapshot_dep: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]
body	SnapshotDependency	[optional]

Return type:

SnapshotDependency

Back to top

add_step

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)
body = dohq_teamcity.Step() # Step |  (optional)

try:
    api_response = tc.build_type_api.add_step(bt_locator, fields=fields, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->add_step: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]
body	Step	[optional]

Return type:

Step

Back to top

add_step_parameter

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
step_id = 'step_id_example' # str |
parameter_name = 'parameter_name_example' # str |
body = 'body_example' # str |  (optional)

try:
    api_response = tc.build_type_api.add_step_parameter(bt_locator, step_id, parameter_name, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->add_step_parameter: %s\n" % e)

Name	Types	Notes
bt_locator	str
step_id	str
parameter_name	str
body	str	[optional]

Return type:

str

Back to top

add_template

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
body = dohq_teamcity.BuildType() # BuildType |  (optional)
optimize_settings = true # bool |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.add_template(bt_locator, body=body, optimize_settings=optimize_settings, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->add_template: %s\n" % e)

Name	Types	Notes
bt_locator	str
body	BuildType	[optional]
optimize_settings	bool	[optional]
fields	str	[optional]

Return type:

BuildType

Back to top

add_trigger

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)
body = dohq_teamcity.Trigger() # Trigger |  (optional)

try:
    api_response = tc.build_type_api.add_trigger(bt_locator, fields=fields, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->add_trigger: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]
body	Trigger	[optional]

Return type:

Trigger

Back to top

add_vcs_root_entry

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
body = dohq_teamcity.VcsRootEntry() # VcsRootEntry |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.add_vcs_root_entry(bt_locator, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->add_vcs_root_entry: %s\n" % e)

Name	Types	Notes
bt_locator	str
body	VcsRootEntry	[optional]
fields	str	[optional]

Return type:

VcsRootEntry

Back to top

change_artifact_dep_setting

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
artifact_dep_locator = 'artifact_dep_locator_example' # str |
field_name = 'field_name_example' # str |
body = 'body_example' # str |  (optional)

try:
    api_response = tc.build_type_api.change_artifact_dep_setting(bt_locator, artifact_dep_locator, field_name, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->change_artifact_dep_setting: %s\n" % e)

Name	Types	Notes
bt_locator	str
artifact_dep_locator	str
field_name	str
body	str	[optional]

Return type:

str

Back to top

change_feature_setting

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
feature_id = 'feature_id_example' # str |
name = 'name_example' # str |
body = 'body_example' # str |  (optional)

try:
    api_response = tc.build_type_api.change_feature_setting(bt_locator, feature_id, name, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->change_feature_setting: %s\n" % e)

Name	Types	Notes
bt_locator	str
feature_id	str
name	str
body	str	[optional]

Return type:

str

Back to top

change_requirement_setting

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
agent_requirement_locator = 'agent_requirement_locator_example' # str |
field_name = 'field_name_example' # str |
body = 'body_example' # str |  (optional)

try:
    api_response = tc.build_type_api.change_requirement_setting(bt_locator, agent_requirement_locator, field_name, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->change_requirement_setting: %s\n" % e)

Name	Types	Notes
bt_locator	str
agent_requirement_locator	str
field_name	str
body	str	[optional]

Return type:

str

Back to top

change_step_setting

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
step_id = 'step_id_example' # str |
field_name = 'field_name_example' # str |
body = 'body_example' # str |  (optional)

try:
    api_response = tc.build_type_api.change_step_setting(bt_locator, step_id, field_name, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->change_step_setting: %s\n" % e)

Name	Types	Notes
bt_locator	str
step_id	str
field_name	str
body	str	[optional]

Return type:

str

Back to top

change_trigger_setting

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
trigger_locator = 'trigger_locator_example' # str |
field_name = 'field_name_example' # str |
body = 'body_example' # str |  (optional)

try:
    api_response = tc.build_type_api.change_trigger_setting(bt_locator, trigger_locator, field_name, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->change_trigger_setting: %s\n" % e)

Name	Types	Notes
bt_locator	str
trigger_locator	str
field_name	str
body	str	[optional]

Return type:

str

Back to top

delete_agent_requirement

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
agent_requirement_locator = 'agent_requirement_locator_example' # str |

try:
    tc.build_type_api.delete_agent_requirement(bt_locator, agent_requirement_locator)
except ApiException as e:
    print("Exception when calling BuildTypeApi->delete_agent_requirement: %s\n" % e)

Name	Types	Notes
bt_locator	str
agent_requirement_locator	str

Return type:

void (empty response body)

Back to top

delete_all_parameters

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |

try:
    tc.build_type_api.delete_all_parameters(bt_locator)
except ApiException as e:
    print("Exception when calling BuildTypeApi->delete_all_parameters: %s\n" % e)

Name	Types	Notes
bt_locator	str

Return type:

void (empty response body)

Back to top

delete_all_parameters_0

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |

try:
    tc.build_type_api.delete_all_parameters_0(bt_locator)
except ApiException as e:
    print("Exception when calling BuildTypeApi->delete_all_parameters_0: %s\n" % e)

Name	Types	Notes
bt_locator	str

Return type:

void (empty response body)

Back to top

delete_artifact_dep

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
artifact_dep_locator = 'artifact_dep_locator_example' # str |

try:
    tc.build_type_api.delete_artifact_dep(bt_locator, artifact_dep_locator)
except ApiException as e:
    print("Exception when calling BuildTypeApi->delete_artifact_dep: %s\n" % e)

Name	Types	Notes
bt_locator	str
artifact_dep_locator	str

Return type:

void (empty response body)

Back to top

delete_build_type

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |

try:
    tc.build_type_api.delete_build_type(bt_locator)
except ApiException as e:
    print("Exception when calling BuildTypeApi->delete_build_type: %s\n" % e)

Name	Types	Notes
bt_locator	str

Return type:

void (empty response body)

Back to top

delete_feature

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
feature_id = 'feature_id_example' # str |

try:
    tc.build_type_api.delete_feature(bt_locator, feature_id)
except ApiException as e:
    print("Exception when calling BuildTypeApi->delete_feature: %s\n" % e)

Name	Types	Notes
bt_locator	str
feature_id	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'))

name = 'name_example' # str |
bt_locator = 'bt_locator_example' # str |

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

Name	Types	Notes
name	str
bt_locator	str

Return type:

void (empty response body)

Back to top

delete_parameter_0

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

name = 'name_example' # str |
bt_locator = 'bt_locator_example' # str |

try:
    tc.build_type_api.delete_parameter_0(name, bt_locator)
except ApiException as e:
    print("Exception when calling BuildTypeApi->delete_parameter_0: %s\n" % e)

Name	Types	Notes
name	str
bt_locator	str

Return type:

void (empty response body)

Back to top

delete_snapshot_dep

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
snapshot_dep_locator = 'snapshot_dep_locator_example' # str |

try:
    tc.build_type_api.delete_snapshot_dep(bt_locator, snapshot_dep_locator)
except ApiException as e:
    print("Exception when calling BuildTypeApi->delete_snapshot_dep: %s\n" % e)

Name	Types	Notes
bt_locator	str
snapshot_dep_locator	str

Return type:

void (empty response body)

Back to top

delete_step

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
step_id = 'step_id_example' # str |

try:
    tc.build_type_api.delete_step(bt_locator, step_id)
except ApiException as e:
    print("Exception when calling BuildTypeApi->delete_step: %s\n" % e)

Name	Types	Notes
bt_locator	str
step_id	str

Return type:

void (empty response body)

Back to top

delete_trigger

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
trigger_locator = 'trigger_locator_example' # str |

try:
    tc.build_type_api.delete_trigger(bt_locator, trigger_locator)
except ApiException as e:
    print("Exception when calling BuildTypeApi->delete_trigger: %s\n" % e)

Name	Types	Notes
bt_locator	str
trigger_locator	str

Return type:

void (empty response body)

Back to top

delete_vcs_root_entry

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
vcs_root_locator = 'vcs_root_locator_example' # str |

try:
    tc.build_type_api.delete_vcs_root_entry(bt_locator, vcs_root_locator)
except ApiException as e:
    print("Exception when calling BuildTypeApi->delete_vcs_root_entry: %s\n" % e)

Name	Types	Notes
bt_locator	str
vcs_root_locator	str

Return type:

void (empty response body)

Back to top

get_agent_requirement

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
agent_requirement_locator = 'agent_requirement_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_agent_requirement(bt_locator, agent_requirement_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_agent_requirement: %s\n" % e)

Name	Types	Notes
bt_locator	str
agent_requirement_locator	str
fields	str	[optional]

Return type:

AgentRequirement

Back to top

get_agent_requirements

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_agent_requirements(bt_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_agent_requirements: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]

Return type:

AgentRequirements

Back to top

get_aliases

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
field = 'field_example' # str |

try:
    api_response = tc.build_type_api.get_aliases(bt_locator, field)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_aliases: %s\n" % e)

Name	Types	Notes
bt_locator	str
field	str

Return type:

Items

Back to top

get_artifact_dep

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
artifact_dep_locator = 'artifact_dep_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_artifact_dep(bt_locator, artifact_dep_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_artifact_dep: %s\n" % e)

Name	Types	Notes
bt_locator	str
artifact_dep_locator	str
fields	str	[optional]

Return type:

ArtifactDependency

Back to top

get_artifact_dep_setting

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
artifact_dep_locator = 'artifact_dep_locator_example' # str |
field_name = 'field_name_example' # str |

try:
    api_response = tc.build_type_api.get_artifact_dep_setting(bt_locator, artifact_dep_locator, field_name)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_artifact_dep_setting: %s\n" % e)

Name	Types	Notes
bt_locator	str
artifact_dep_locator	str
field_name	str

Return type:

str

Back to top

get_artifact_deps

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_artifact_deps(bt_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_artifact_deps: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]

Return type:

ArtifactDependencies

Back to top

get_build_types

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

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

Return type:

BuildTypes

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 |
bt_locator = 'bt_locator_example' # str |
base_path = 'base_path_example' # str |  (optional)
locator = 'locator_example' # str |  (optional)
fields = 'fields_example' # str |  (optional)
resolve_parameters = true # bool |  (optional)

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

Name	Types	Notes
path	str
bt_locator	str
base_path	str	[optional]
locator	str	[optional]
fields	str	[optional]
resolve_parameters	bool	[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 |
bt_locator = 'bt_locator_example' # str |
base_path = 'base_path_example' # str |  (optional)
locator = 'locator_example' # str |  (optional)
fields = 'fields_example' # str |  (optional)
resolve_parameters = true # bool |  (optional)

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

Name	Types	Notes
path	str
bt_locator	str
base_path	str	[optional]
locator	str	[optional]
fields	str	[optional]
resolve_parameters	bool	[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 |
bt_locator = 'bt_locator_example' # str |
response_builder = 'response_builder_example' # str |  (optional)
resolve_parameters = true # bool |  (optional)

try:
    tc.build_type_api.get_content(path, bt_locator, response_builder=response_builder, resolve_parameters=resolve_parameters)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_content: %s\n" % e)

Name	Types	Notes
path	str
bt_locator	str
response_builder	str	[optional]
resolve_parameters	bool	[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 |
bt_locator = 'bt_locator_example' # str |
resolve_parameters = true # bool |  (optional)

try:
    tc.build_type_api.get_content_alias(path, bt_locator, resolve_parameters=resolve_parameters)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_content_alias: %s\n" % e)

Name	Types	Notes
path	str
bt_locator	str
resolve_parameters	bool	[optional]

Return type:

void (empty response body)

Back to top

get_current_vcs_instances

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_current_vcs_instances(bt_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_current_vcs_instances: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]

Return type:

VcsRootInstances

Back to top

get_current_vcs_instances_obsolete

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_current_vcs_instances_obsolete(bt_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_current_vcs_instances_obsolete: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]

Return type:

VcsRootInstances

Back to top

get_example_new_project_description

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |

try:
    api_response = tc.build_type_api.get_example_new_project_description(bt_locator)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_example_new_project_description: %s\n" % e)

Name	Types	Notes
bt_locator	str

Return type:

NewBuildTypeDescription

Back to top

get_example_new_project_description_compatibility_version1

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |

try:
    api_response = tc.build_type_api.get_example_new_project_description_compatibility_version1(bt_locator)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_example_new_project_description_compatibility_version1: %s\n" % e)

Name	Types	Notes
bt_locator	str

Return type:

NewBuildTypeDescription

Back to top

get_feature

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
feature_id = 'feature_id_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_feature(bt_locator, feature_id, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_feature: %s\n" % e)

Name	Types	Notes
bt_locator	str
feature_id	str
fields	str	[optional]

Return type:

Feature

Back to top

get_feature_parameter

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
feature_id = 'feature_id_example' # str |
parameter_name = 'parameter_name_example' # str |

try:
    api_response = tc.build_type_api.get_feature_parameter(bt_locator, feature_id, parameter_name)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_feature_parameter: %s\n" % e)

Name	Types	Notes
bt_locator	str
feature_id	str
parameter_name	str

Return type:

str

Back to top

get_feature_parameters

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
feature_id = 'feature_id_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_feature_parameters(bt_locator, feature_id, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_feature_parameters: %s\n" % e)

Name	Types	Notes
bt_locator	str
feature_id	str
fields	str	[optional]

Return type:

Properties

Back to top

get_feature_setting

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
feature_id = 'feature_id_example' # str |
name = 'name_example' # str |

try:
    api_response = tc.build_type_api.get_feature_setting(bt_locator, feature_id, name)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_feature_setting: %s\n" % e)

Name	Types	Notes
bt_locator	str
feature_id	str
name	str

Return type:

str

Back to top

get_features

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_features(bt_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_features: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]

Return type:

Features

Back to top

get_investigations

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_investigations(bt_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_investigations: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]

Return type:

Investigations

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 |
bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)
resolve_parameters = true # bool |  (optional)

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

Name	Types	Notes
path	str
bt_locator	str
fields	str	[optional]
resolve_parameters	bool	[optional]

Return type:

file

Back to top

get_parameter

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

name = 'name_example' # str |
bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_parameter(name, bt_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_parameter: %s\n" % e)

Name	Types	Notes
name	str
bt_locator	str
fields	str	[optional]

Return type:

ModelProperty

Back to top

get_parameter_0

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

name = 'name_example' # str |
bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_parameter_0(name, bt_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_parameter_0: %s\n" % e)

Name	Types	Notes
name	str
bt_locator	str
fields	str	[optional]

Return type:

ModelProperty

Back to top

get_parameter_type

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

name = 'name_example' # str |
bt_locator = 'bt_locator_example' # str |

try:
    api_response = tc.build_type_api.get_parameter_type(name, bt_locator)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_parameter_type: %s\n" % e)

Name	Types	Notes
name	str
bt_locator	str

Return type:

Type

Back to top

get_parameter_type_raw_value

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

name = 'name_example' # str |
bt_locator = 'bt_locator_example' # str |

try:
    api_response = tc.build_type_api.get_parameter_type_raw_value(name, bt_locator)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_parameter_type_raw_value: %s\n" % e)

Name	Types	Notes
name	str
bt_locator	str

Return type:

str

Back to top

get_parameter_value_long

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

name = 'name_example' # str |
bt_locator = 'bt_locator_example' # str |

try:
    api_response = tc.build_type_api.get_parameter_value_long(name, bt_locator)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_parameter_value_long: %s\n" % e)

Name	Types	Notes
name	str
bt_locator	str

Return type:

str

Back to top

get_parameter_value_long_0

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

name = 'name_example' # str |
bt_locator = 'bt_locator_example' # str |

try:
    api_response = tc.build_type_api.get_parameter_value_long_0(name, bt_locator)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_parameter_value_long_0: %s\n" % e)

Name	Types	Notes
name	str
bt_locator	str

Return type:

str

Back to top

get_parameters

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

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

try:
    api_response = tc.build_type_api.get_parameters(bt_locator, locator=locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_parameters: %s\n" % e)

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

Return type:

Properties

Back to top

get_parameters_0

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

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

try:
    api_response = tc.build_type_api.get_parameters_0(bt_locator, locator=locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_parameters_0: %s\n" % e)

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

Return type:

Properties

Back to top

get_requirement_setting

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
agent_requirement_locator = 'agent_requirement_locator_example' # str |
field_name = 'field_name_example' # str |

try:
    api_response = tc.build_type_api.get_requirement_setting(bt_locator, agent_requirement_locator, field_name)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_requirement_setting: %s\n" % e)

Name	Types	Notes
bt_locator	str
agent_requirement_locator	str
field_name	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'))

bt_locator = 'bt_locator_example' # str |
base_path = 'base_path_example' # str |  (optional)
locator = 'locator_example' # str |  (optional)
fields = 'fields_example' # str |  (optional)
resolve_parameters = true # bool |  (optional)

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

Name	Types	Notes
bt_locator	str
base_path	str	[optional]
locator	str	[optional]
fields	str	[optional]
resolve_parameters	bool	[optional]

Return type:

Files

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

bt_locator = 'bt_locator_example' # str |

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

Name	Types	Notes
bt_locator	str

Return type:

str

Back to top

get_snapshot_dep

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
snapshot_dep_locator = 'snapshot_dep_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_snapshot_dep(bt_locator, snapshot_dep_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_snapshot_dep: %s\n" % e)

Name	Types	Notes
bt_locator	str
snapshot_dep_locator	str
fields	str	[optional]

Return type:

SnapshotDependency

Back to top

get_snapshot_deps

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_snapshot_deps(bt_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_snapshot_deps: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]

Return type:

SnapshotDependencies

Back to top

get_step

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
step_id = 'step_id_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_step(bt_locator, step_id, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_step: %s\n" % e)

Name	Types	Notes
bt_locator	str
step_id	str
fields	str	[optional]

Return type:

Step

Back to top

get_step_parameter

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
step_id = 'step_id_example' # str |
parameter_name = 'parameter_name_example' # str |

try:
    api_response = tc.build_type_api.get_step_parameter(bt_locator, step_id, parameter_name)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_step_parameter: %s\n" % e)

Name	Types	Notes
bt_locator	str
step_id	str
parameter_name	str

Return type:

str

Back to top

get_step_parameters

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
step_id = 'step_id_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_step_parameters(bt_locator, step_id, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_step_parameters: %s\n" % e)

Name	Types	Notes
bt_locator	str
step_id	str
fields	str	[optional]

Return type:

Properties

Back to top

get_step_setting

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
step_id = 'step_id_example' # str |
field_name = 'field_name_example' # str |

try:
    api_response = tc.build_type_api.get_step_setting(bt_locator, step_id, field_name)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_step_setting: %s\n" % e)

Name	Types	Notes
bt_locator	str
step_id	str
field_name	str

Return type:

str

Back to top

get_steps

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_steps(bt_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_steps: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]

Return type:

Steps

Back to top

get_template

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
template_locator = 'template_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_template(bt_locator, template_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_template: %s\n" % e)

Name	Types	Notes
bt_locator	str
template_locator	str
fields	str	[optional]

Return type:

BuildType

Back to top

get_templates

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_templates(bt_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_templates: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]

Return type:

BuildTypes

Back to top

get_trigger

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
trigger_locator = 'trigger_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_trigger(bt_locator, trigger_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_trigger: %s\n" % e)

Name	Types	Notes
bt_locator	str
trigger_locator	str
fields	str	[optional]

Return type:

Trigger

Back to top

get_trigger_setting

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
trigger_locator = 'trigger_locator_example' # str |
field_name = 'field_name_example' # str |

try:
    api_response = tc.build_type_api.get_trigger_setting(bt_locator, trigger_locator, field_name)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_trigger_setting: %s\n" % e)

Name	Types	Notes
bt_locator	str
trigger_locator	str
field_name	str

Return type:

str

Back to top

get_triggers

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_triggers(bt_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_triggers: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]

Return type:

Triggers

Back to top

get_vcs_labeling_options

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |

try:
    api_response = tc.build_type_api.get_vcs_labeling_options(bt_locator)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_vcs_labeling_options: %s\n" % e)

Name	Types	Notes
bt_locator	str

Return type:

VcsLabeling

Back to top

get_vcs_root_entries

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.get_vcs_root_entries(bt_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_vcs_root_entries: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]

Return type:

VcsRootEntries

Back to top

get_vcs_root_entry

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

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

try:
    api_response = tc.build_type_api.get_vcs_root_entry(bt_locator, vcs_root_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_vcs_root_entry: %s\n" % e)

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

Return type:

VcsRootEntry

Back to top

get_vcs_root_entry_checkout_rules

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
vcs_root_locator = 'vcs_root_locator_example' # str |

try:
    api_response = tc.build_type_api.get_vcs_root_entry_checkout_rules(bt_locator, vcs_root_locator)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->get_vcs_root_entry_checkout_rules: %s\n" % e)

Name	Types	Notes
bt_locator	str
vcs_root_locator	str

Return type:

str

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 |
bt_locator = 'bt_locator_example' # str |
base_path = 'base_path_example' # str |  (optional)
locator = 'locator_example' # str |  (optional)
name = 'name_example' # str |  (optional)
resolve_parameters = true # bool |  (optional)

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

Name	Types	Notes
path	str
bt_locator	str
base_path	str	[optional]
locator	str	[optional]
name	str	[optional]
resolve_parameters	bool	[optional]

Return type:

void (empty response body)

Back to top

remove_all_templates

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
inline_settings = true # bool |  (optional)

try:
    tc.build_type_api.remove_all_templates(bt_locator, inline_settings=inline_settings)
except ApiException as e:
    print("Exception when calling BuildTypeApi->remove_all_templates: %s\n" % e)

Name	Types	Notes
bt_locator	str
inline_settings	bool	[optional]

Return type:

void (empty response body)

Back to top

remove_template

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
template_locator = 'template_locator_example' # str |
inline_settings = true # bool |  (optional)

try:
    tc.build_type_api.remove_template(bt_locator, template_locator, inline_settings=inline_settings)
except ApiException as e:
    print("Exception when calling BuildTypeApi->remove_template: %s\n" % e)

Name	Types	Notes
bt_locator	str
template_locator	str
inline_settings	bool	[optional]

Return type:

void (empty response body)

Back to top

replace_agent_requirement

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
agent_requirement_locator = 'agent_requirement_locator_example' # str |
fields = 'fields_example' # str |  (optional)
body = dohq_teamcity.AgentRequirement() # AgentRequirement |  (optional)

try:
    api_response = tc.build_type_api.replace_agent_requirement(bt_locator, agent_requirement_locator, fields=fields, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->replace_agent_requirement: %s\n" % e)

Name	Types	Notes
bt_locator	str
agent_requirement_locator	str
fields	str	[optional]
body	AgentRequirement	[optional]

Return type:

AgentRequirement

Back to top

replace_agent_requirements

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)
body = dohq_teamcity.AgentRequirements() # AgentRequirements |  (optional)

try:
    api_response = tc.build_type_api.replace_agent_requirements(bt_locator, fields=fields, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->replace_agent_requirements: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]
body	AgentRequirements	[optional]

Return type:

AgentRequirements

Back to top

replace_artifact_dep

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
artifact_dep_locator = 'artifact_dep_locator_example' # str |
fields = 'fields_example' # str |  (optional)
body = dohq_teamcity.ArtifactDependency() # ArtifactDependency |  (optional)

try:
    api_response = tc.build_type_api.replace_artifact_dep(bt_locator, artifact_dep_locator, fields=fields, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->replace_artifact_dep: %s\n" % e)

Name	Types	Notes
bt_locator	str
artifact_dep_locator	str
fields	str	[optional]
body	ArtifactDependency	[optional]

Return type:

ArtifactDependency

Back to top

replace_artifact_deps

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)
body = dohq_teamcity.ArtifactDependencies() # ArtifactDependencies |  (optional)

try:
    api_response = tc.build_type_api.replace_artifact_deps(bt_locator, fields=fields, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->replace_artifact_deps: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]
body	ArtifactDependencies	[optional]

Return type:

ArtifactDependencies

Back to top

replace_feature

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
feature_id = 'feature_id_example' # str |
fields = 'fields_example' # str |  (optional)
body = dohq_teamcity.Feature() # Feature |  (optional)

try:
    api_response = tc.build_type_api.replace_feature(bt_locator, feature_id, fields=fields, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->replace_feature: %s\n" % e)

Name	Types	Notes
bt_locator	str
feature_id	str
fields	str	[optional]
body	Feature	[optional]

Return type:

Feature

Back to top

replace_feature_parameters

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
feature_id = 'feature_id_example' # str |
body = dohq_teamcity.Properties() # Properties |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.replace_feature_parameters(bt_locator, feature_id, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->replace_feature_parameters: %s\n" % e)

Name	Types	Notes
bt_locator	str
feature_id	str
body	Properties	[optional]
fields	str	[optional]

Return type:

Properties

Back to top

replace_features

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)
body = dohq_teamcity.Features() # Features |  (optional)

try:
    api_response = tc.build_type_api.replace_features(bt_locator, fields=fields, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->replace_features: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]
body	Features	[optional]

Return type:

Features

Back to top

replace_snapshot_dep

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
snapshot_dep_locator = 'snapshot_dep_locator_example' # str |
fields = 'fields_example' # str |  (optional)
body = dohq_teamcity.SnapshotDependency() # SnapshotDependency |  (optional)

try:
    api_response = tc.build_type_api.replace_snapshot_dep(bt_locator, snapshot_dep_locator, fields=fields, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->replace_snapshot_dep: %s\n" % e)

Name	Types	Notes
bt_locator	str
snapshot_dep_locator	str
fields	str	[optional]
body	SnapshotDependency	[optional]

Return type:

SnapshotDependency

Back to top

replace_snapshot_deps

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)
body = dohq_teamcity.SnapshotDependencies() # SnapshotDependencies |  (optional)

try:
    api_response = tc.build_type_api.replace_snapshot_deps(bt_locator, fields=fields, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->replace_snapshot_deps: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]
body	SnapshotDependencies	[optional]

Return type:

SnapshotDependencies

Back to top

replace_step

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
step_id = 'step_id_example' # str |
fields = 'fields_example' # str |  (optional)
body = dohq_teamcity.Step() # Step |  (optional)

try:
    api_response = tc.build_type_api.replace_step(bt_locator, step_id, fields=fields, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->replace_step: %s\n" % e)

Name	Types	Notes
bt_locator	str
step_id	str
fields	str	[optional]
body	Step	[optional]

Return type:

Step

Back to top

replace_step_parameters

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
step_id = 'step_id_example' # str |
body = dohq_teamcity.Properties() # Properties |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.replace_step_parameters(bt_locator, step_id, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->replace_step_parameters: %s\n" % e)

Name	Types	Notes
bt_locator	str
step_id	str
body	Properties	[optional]
fields	str	[optional]

Return type:

Properties

Back to top

replace_steps

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)
body = dohq_teamcity.Steps() # Steps |  (optional)

try:
    api_response = tc.build_type_api.replace_steps(bt_locator, fields=fields, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->replace_steps: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]
body	Steps	[optional]

Return type:

Steps

Back to top

replace_trigger

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
trigger_locator = 'trigger_locator_example' # str |
fields = 'fields_example' # str |  (optional)
body = dohq_teamcity.Trigger() # Trigger |  (optional)

try:
    api_response = tc.build_type_api.replace_trigger(bt_locator, trigger_locator, fields=fields, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->replace_trigger: %s\n" % e)

Name	Types	Notes
bt_locator	str
trigger_locator	str
fields	str	[optional]
body	Trigger	[optional]

Return type:

Trigger

Back to top

replace_triggers

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)
body = dohq_teamcity.Triggers() # Triggers |  (optional)

try:
    api_response = tc.build_type_api.replace_triggers(bt_locator, fields=fields, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->replace_triggers: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]
body	Triggers	[optional]

Return type:

Triggers

Back to top

replace_vcs_root_entries

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
body = dohq_teamcity.VcsRootEntries() # VcsRootEntries |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.replace_vcs_root_entries(bt_locator, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->replace_vcs_root_entries: %s\n" % e)

Name	Types	Notes
bt_locator	str
body	VcsRootEntries	[optional]
fields	str	[optional]

Return type:

VcsRootEntries

Back to top

serve_branches

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

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

try:
    api_response = tc.build_type_api.serve_branches(bt_locator, locator=locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->serve_branches: %s\n" % e)

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

Return type:

Branches

Back to top

serve_build_field

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

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

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

Name	Types	Notes
bt_locator	str
build_locator	str
field	str

Return type:

str

Back to top

serve_build_type_builds_tags

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
field = 'field_example' # str |

try:
    api_response = tc.build_type_api.serve_build_type_builds_tags(bt_locator, field)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->serve_build_type_builds_tags: %s\n" % e)

Name	Types	Notes
bt_locator	str
field	str

Return type:

Tags

Back to top

serve_build_type_field

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
field = 'field_example' # str |

try:
    api_response = tc.build_type_api.serve_build_type_field(bt_locator, field)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->serve_build_type_field: %s\n" % e)

Name	Types	Notes
bt_locator	str
field	str

Return type:

str

Back to top

serve_build_type_xml

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.serve_build_type_xml(bt_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->serve_build_type_xml: %s\n" % e)

Name	Types	Notes
bt_locator	str
fields	str	[optional]

Return type:

BuildType

Back to top

serve_build_with_project

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
build_locator = 'build_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.serve_build_with_project(bt_locator, build_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->serve_build_with_project: %s\n" % e)

Name	Types	Notes
bt_locator	str
build_locator	str
fields	str	[optional]

Return type:

Build

Back to top

serve_builds

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
status = 'status_example' # str |  (optional)
triggered_by_user = 'triggered_by_user_example' # str |  (optional)
include_personal = true # bool |  (optional)
include_canceled = true # bool |  (optional)
only_pinned = true # bool |  (optional)
tag = ['tag_example'] # list[str] |  (optional)
agent_name = 'agent_name_example' # str |  (optional)
since_build = 'since_build_example' # str |  (optional)
since_date = 'since_date_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.build_type_api.serve_builds(bt_locator, status=status, triggered_by_user=triggered_by_user, include_personal=include_personal, include_canceled=include_canceled, only_pinned=only_pinned, tag=tag, agent_name=agent_name, since_build=since_build, since_date=since_date, start=start, count=count, locator=locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->serve_builds: %s\n" % e)

Name	Types	Notes
bt_locator	str
status	str	[optional]
triggered_by_user	str	[optional]
include_personal	bool	[optional]
include_canceled	bool	[optional]
only_pinned	bool	[optional]
tag	list[str]	[optional]
agent_name	str	[optional]
since_build	str	[optional]
since_date	str	[optional]
start	int	[optional]
count	int	[optional]
locator	str	[optional]
fields	str	[optional]

Return type:

Builds

Back to top

set_build_type_field

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
field = 'field_example' # str |
body = 'body_example' # str |  (optional)

try:
    api_response = tc.build_type_api.set_build_type_field(bt_locator, field, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->set_build_type_field: %s\n" % e)

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

Return type:

str

Back to top

set_parameter

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
body = dohq_teamcity.ModelProperty() # ModelProperty |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.set_parameter(bt_locator, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->set_parameter: %s\n" % e)

Name	Types	Notes
bt_locator	str
body	ModelProperty	[optional]
fields	str	[optional]

Return type:

ModelProperty

Back to top

set_parameter_0

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

name = 'name_example' # str |
bt_locator = 'bt_locator_example' # str |
body = dohq_teamcity.ModelProperty() # ModelProperty |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.set_parameter_0(name, bt_locator, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->set_parameter_0: %s\n" % e)

Name	Types	Notes
name	str
bt_locator	str
body	ModelProperty	[optional]
fields	str	[optional]

Return type:

ModelProperty

Back to top

set_parameter_1

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
body = dohq_teamcity.ModelProperty() # ModelProperty |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.set_parameter_1(bt_locator, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->set_parameter_1: %s\n" % e)

Name	Types	Notes
bt_locator	str
body	ModelProperty	[optional]
fields	str	[optional]

Return type:

ModelProperty

Back to top

set_parameter_2

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

name = 'name_example' # str |
bt_locator = 'bt_locator_example' # str |
body = dohq_teamcity.ModelProperty() # ModelProperty |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.set_parameter_2(name, bt_locator, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->set_parameter_2: %s\n" % e)

Name	Types	Notes
name	str
bt_locator	str
body	ModelProperty	[optional]
fields	str	[optional]

Return type:

ModelProperty

Back to top

set_parameter_type

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

name = 'name_example' # str |
bt_locator = 'bt_locator_example' # str |
body = dohq_teamcity.Type() # Type |  (optional)

try:
    api_response = tc.build_type_api.set_parameter_type(name, bt_locator, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->set_parameter_type: %s\n" % e)

Name	Types	Notes
name	str
bt_locator	str
body	Type	[optional]

Return type:

Type

Back to top

set_parameter_type_raw_value

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

name = 'name_example' # str |
bt_locator = 'bt_locator_example' # str |
body = 'body_example' # str |  (optional)

try:
    api_response = tc.build_type_api.set_parameter_type_raw_value(name, bt_locator, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->set_parameter_type_raw_value: %s\n" % e)

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

Return type:

str

Back to top

set_parameter_value_long

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

name = 'name_example' # str |
bt_locator = 'bt_locator_example' # str |
body = 'body_example' # str |  (optional)

try:
    api_response = tc.build_type_api.set_parameter_value_long(name, bt_locator, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->set_parameter_value_long: %s\n" % e)

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

Return type:

str

Back to top

set_parameter_value_long_0

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

name = 'name_example' # str |
bt_locator = 'bt_locator_example' # str |
body = 'body_example' # str |  (optional)

try:
    api_response = tc.build_type_api.set_parameter_value_long_0(name, bt_locator, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->set_parameter_value_long_0: %s\n" % e)

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

Return type:

str

Back to top

set_parameters

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
body = dohq_teamcity.Properties() # Properties |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.set_parameters(bt_locator, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->set_parameters: %s\n" % e)

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

Return type:

Properties

Back to top

set_parameters_0

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
body = dohq_teamcity.Properties() # Properties |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.set_parameters_0(bt_locator, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->set_parameters_0: %s\n" % e)

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

Return type:

Properties

Back to top

set_templates

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
body = dohq_teamcity.BuildTypes() # BuildTypes |  (optional)
optimize_settings = true # bool |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.build_type_api.set_templates(bt_locator, body=body, optimize_settings=optimize_settings, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->set_templates: %s\n" % e)

Name	Types	Notes
bt_locator	str
body	BuildTypes	[optional]
optimize_settings	bool	[optional]
fields	str	[optional]

Return type:

BuildTypes

Back to top

set_vcs_labeling_options

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
body = dohq_teamcity.VcsLabeling() # VcsLabeling |  (optional)

try:
    api_response = tc.build_type_api.set_vcs_labeling_options(bt_locator, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->set_vcs_labeling_options: %s\n" % e)

Name	Types	Notes
bt_locator	str
body	VcsLabeling	[optional]

Return type:

VcsLabeling

Back to top

update_vcs_root_entry

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
vcs_root_locator = 'vcs_root_locator_example' # str |
body = dohq_teamcity.VcsRootEntry() # VcsRootEntry |  (optional)
fields = 'fields_example' # str |  (optional)

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

Name	Types	Notes
bt_locator	str
vcs_root_locator	str
body	VcsRootEntry	[optional]
fields	str	[optional]

Return type:

VcsRootEntry

Back to top

update_vcs_root_entry_checkout_rules

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

bt_locator = 'bt_locator_example' # str |
vcs_root_locator = 'vcs_root_locator_example' # str |
body = 'body_example' # str |  (optional)

try:
    api_response = tc.build_type_api.update_vcs_root_entry_checkout_rules(bt_locator, vcs_root_locator, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildTypeApi->update_vcs_root_entry_checkout_rules: %s\n" % e)

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

Return type:

str

Back to top