dohq_teamcity.ProjectApi¶

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

Method	HTTP request
add	POST `/app/rest/projects/{projectLocator}/projectFeatures`
create_build_type	POST `/app/rest/projects/{projectLocator}/buildTypes`
create_build_type_template	POST `/app/rest/projects/{projectLocator}/templates`
create_project	POST `/app/rest/projects`
create_secure_token	POST `/app/rest/projects/{projectLocator}/secure/tokens`
delete	DELETE `/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}`
delete_all_parameters	DELETE `/app/rest/projects/{projectLocator}/parameters`
delete_all_parameters_0	DELETE `/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}/properties`
delete_parameter	DELETE `/app/rest/projects/{projectLocator}/parameters/{name}`
delete_parameter_0	DELETE `/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}/properties/{name}`
delete_project	DELETE `/app/rest/projects/{projectLocator}`
delete_project_agent_pools	DELETE `/app/rest/projects/{projectLocator}/agentPools/{agentPoolLocator}`
get	GET `/app/rest/projects/{projectLocator}/projectFeatures`
get_branches	GET `/app/rest/projects/{projectLocator}/branches`
get_build_types_order	GET `/app/rest/projects/{projectLocator}/order/buildTypes`
get_default_template	GET `/app/rest/projects/{projectLocator}/defaultTemplate`
get_example_new_project_description	GET `/app/rest/projects/{projectLocator}/example/newProjectDescription`
get_example_new_project_description_compatibility_version1	GET `/app/rest/projects/{projectLocator}/newProjectDescription`
get_parameter	GET `/app/rest/projects/{projectLocator}/parameters/{name}`
get_parameter_0	GET `/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}/properties/{name}`
get_parameter_type	GET `/app/rest/projects/{projectLocator}/parameters/{name}/type`
get_parameter_type_raw_value	GET `/app/rest/projects/{projectLocator}/parameters/{name}/type/rawValue`
get_parameter_value_long	GET `/app/rest/projects/{projectLocator}/parameters/{name}/value`
get_parameter_value_long_0	GET `/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}/properties/{name}/value`
get_parameters	GET `/app/rest/projects/{projectLocator}/parameters`
get_parameters_0	GET `/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}/properties`
get_parent_project	GET `/app/rest/projects/{projectLocator}/parentProject`
get_project_agent_pools	GET `/app/rest/projects/{projectLocator}/agentPools`
get_projects_order	GET `/app/rest/projects/{projectLocator}/order/projects`
get_secure_value	GET `/app/rest/projects/{projectLocator}/secure/values/{token}`
get_settings_file	GET `/app/rest/projects/{projectLocator}/settingsFile`
get_single	GET `/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}`
reload_settings_file	GET `/app/rest/projects/{projectLocator}/latest`
remove_default_template	DELETE `/app/rest/projects/{projectLocator}/defaultTemplate`
replace	PUT `/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}`
replace_all	PUT `/app/rest/projects/{projectLocator}/projectFeatures`
serve_build_field_with_project	GET `/app/rest/projects/{projectLocator}/buildTypes/{btLocator}/builds/{buildLocator}/{field}`
serve_build_type	GET `/app/rest/projects/{projectLocator}/buildTypes/{btLocator}`
serve_build_type_field_with_project	GET `/app/rest/projects/{projectLocator}/buildTypes/{btLocator}/{field}`
serve_build_type_templates	GET `/app/rest/projects/{projectLocator}/templates/{btLocator}`
serve_build_types_in_project	GET `/app/rest/projects/{projectLocator}/buildTypes`
serve_build_with_project	GET `/app/rest/projects/{projectLocator}/buildTypes/{btLocator}/builds/{buildLocator}`
serve_builds	GET `/app/rest/projects/{projectLocator}/buildTypes/{btLocator}/builds`
serve_project	GET `/app/rest/projects/{projectLocator}`
serve_project_field	GET `/app/rest/projects/{projectLocator}/{field}`
serve_projects	GET `/app/rest/projects`
serve_templates_in_project	GET `/app/rest/projects/{projectLocator}/templates`
set_build_types_order	PUT `/app/rest/projects/{projectLocator}/order/buildTypes`
set_default_template	PUT `/app/rest/projects/{projectLocator}/defaultTemplate`
set_parameter	POST `/app/rest/projects/{projectLocator}/parameters`
set_parameter_0	PUT `/app/rest/projects/{projectLocator}/parameters/{name}`
set_parameter_1	POST `/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}/properties`
set_parameter_2	PUT `/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}/properties/{name}`
set_parameter_type	PUT `/app/rest/projects/{projectLocator}/parameters/{name}/type`
set_parameter_type_raw_value	PUT `/app/rest/projects/{projectLocator}/parameters/{name}/type/rawValue`
set_parameter_value_long	PUT `/app/rest/projects/{projectLocator}/parameters/{name}/value`
set_parameter_value_long_0	PUT `/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}/properties/{name}/value`
set_parameters	PUT `/app/rest/projects/{projectLocator}/parameters`
set_parameters_0	PUT `/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}/properties`
set_parent_project	PUT `/app/rest/projects/{projectLocator}/parentProject`
set_project_agent_pools	PUT `/app/rest/projects/{projectLocator}/agentPools`
set_project_agent_pools_0	POST `/app/rest/projects/{projectLocator}/agentPools`
set_project_field	PUT `/app/rest/projects/{projectLocator}/{field}`
set_projects_order	PUT `/app/rest/projects/{projectLocator}/order/projects`

add¶

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

try:
    api_response = tc.project_api.add(project_locator, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->add: %s\n" % e)

Name	Types	Notes
project_locator	str
body	ProjectFeature	[optional]
fields	str	[optional]

Return type:: object

Back to top

create_build_type¶

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

try:
    api_response = tc.project_api.create_build_type(project_locator, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->create_build_type: %s\n" % e)

Name	Types	Notes
project_locator	str
body	NewBuildTypeDescription	[optional]
fields	str	[optional]

Return type:: BuildType

Back to top

create_build_type_template¶

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

try:
    api_response = tc.project_api.create_build_type_template(project_locator, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->create_build_type_template: %s\n" % e)

Name	Types	Notes
project_locator	str
body	NewBuildTypeDescription	[optional]
fields	str	[optional]

Return type:: BuildType

Back to top

create_project¶

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.NewProjectDescription() # NewProjectDescription |  (optional)

try:
    api_response = tc.project_api.create_project(body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->create_project: %s\n" % e)

Name	Types	Notes
body	NewProjectDescription	[optional]

Return type:: Project

Back to top

create_secure_token¶

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

try:
    api_response = tc.project_api.create_secure_token(project_locator, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->create_secure_token: %s\n" % e)

Name	Types	Notes
project_locator	str
body	str	[optional]

Return type:: str

Back to top

delete¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

feature_locator = 'feature_locator_example' # str |
project_locator = 'project_locator_example' # str |

try:
    tc.project_api.delete(feature_locator, project_locator)
except ApiException as e:
    print("Exception when calling ProjectApi->delete: %s\n" % e)

Name	Types	Notes
feature_locator	str
project_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'))

project_locator = 'project_locator_example' # str |

try:
    tc.project_api.delete_all_parameters(project_locator)
except ApiException as e:
    print("Exception when calling ProjectApi->delete_all_parameters: %s\n" % e)

Name	Types	Notes
project_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'))

feature_locator = 'feature_locator_example' # str |
project_locator = 'project_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    tc.project_api.delete_all_parameters_0(feature_locator, project_locator, fields=fields)
except ApiException as e:
    print("Exception when calling ProjectApi->delete_all_parameters_0: %s\n" % e)

Name	Types	Notes
feature_locator	str
project_locator	str
fields	str	[optional]

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 |
project_locator = 'project_locator_example' # str |

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

Name	Types	Notes
name	str
project_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 |
feature_locator = 'feature_locator_example' # str |
project_locator = 'project_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    tc.project_api.delete_parameter_0(name, feature_locator, project_locator, fields=fields)
except ApiException as e:
    print("Exception when calling ProjectApi->delete_parameter_0: %s\n" % e)

Name	Types	Notes
name	str
feature_locator	str
project_locator	str
fields	str	[optional]

Return type:: void (empty response body)

Back to top

delete_project¶

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 |

try:
    tc.project_api.delete_project(project_locator)
except ApiException as e:
    print("Exception when calling ProjectApi->delete_project: %s\n" % e)

Name	Types	Notes
project_locator	str

Return type:: void (empty response body)

Back to top

delete_project_agent_pools¶

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 |
agent_pool_locator = 'agent_pool_locator_example' # str |

try:
    tc.project_api.delete_project_agent_pools(project_locator, agent_pool_locator)
except ApiException as e:
    print("Exception when calling ProjectApi->delete_project_agent_pools: %s\n" % e)

Name	Types	Notes
project_locator	str
agent_pool_locator	str

Return type:: void (empty response body)

Back to top

get¶

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

try:
    api_response = tc.project_api.get(project_locator, locator=locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->get: %s\n" % e)

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

Return type:: object

Back to top

get_branches¶

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

try:
    api_response = tc.project_api.get_branches(project_locator, locator=locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->get_branches: %s\n" % e)

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

Return type:: Branches

Back to top

get_build_types_order¶

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

try:
    api_response = tc.project_api.get_build_types_order(project_locator, field)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->get_build_types_order: %s\n" % e)

Name	Types	Notes
project_locator	str
field	str

Return type:: BuildTypes

Back to top

get_default_template¶

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

try:
    api_response = tc.project_api.get_default_template(project_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->get_default_template: %s\n" % e)

Name	Types	Notes
project_locator	str
fields	str	[optional]

Return type:: BuildType

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

project_locator = 'project_locator_example' # str |
id = 'id_example' # str |  (optional)

try:
    api_response = tc.project_api.get_example_new_project_description(project_locator, id=id)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->get_example_new_project_description: %s\n" % e)

Name	Types	Notes
project_locator	str
id	str	[optional]

Return type:: NewProjectDescription

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

project_locator = 'project_locator_example' # str |
id = 'id_example' # str |  (optional)

try:
    api_response = tc.project_api.get_example_new_project_description_compatibility_version1(project_locator, id=id)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->get_example_new_project_description_compatibility_version1: %s\n" % e)

Name	Types	Notes
project_locator	str
id	str	[optional]

Return type:: NewProjectDescription

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

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

Name	Types	Notes
name	str
project_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 |
feature_locator = 'feature_locator_example' # str |
project_locator = 'project_locator_example' # str |
fields = 'fields_example' # str |  (optional)
fields2 = 'fields_example' # str |  (optional)

try:
    api_response = tc.project_api.get_parameter_0(name, feature_locator, project_locator, fields=fields, fields2=fields2)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->get_parameter_0: %s\n" % e)

Name	Types	Notes
name	str
feature_locator	str
project_locator	str
fields	str	[optional]
fields2	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 |
project_locator = 'project_locator_example' # str |

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

Name	Types	Notes
name	str
project_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 |
project_locator = 'project_locator_example' # str |

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

Name	Types	Notes
name	str
project_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 |
project_locator = 'project_locator_example' # str |

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

Name	Types	Notes
name	str
project_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 |
feature_locator = 'feature_locator_example' # str |
project_locator = 'project_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.project_api.get_parameter_value_long_0(name, feature_locator, project_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->get_parameter_value_long_0: %s\n" % e)

Name	Types	Notes
name	str
feature_locator	str
project_locator	str
fields	str	[optional]

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

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

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

Name	Types	Notes
project_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'))

feature_locator = 'feature_locator_example' # str |
project_locator = 'project_locator_example' # str |
locator = 'locator_example' # str |  (optional)
fields = 'fields_example' # str |  (optional)
fields2 = 'fields_example' # str |  (optional)

try:
    api_response = tc.project_api.get_parameters_0(feature_locator, project_locator, locator=locator, fields=fields, fields2=fields2)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->get_parameters_0: %s\n" % e)

Name	Types	Notes
feature_locator	str
project_locator	str
locator	str	[optional]
fields	str	[optional]
fields2	str	[optional]

Return type:: Properties

Back to top

get_parent_project¶

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

try:
    api_response = tc.project_api.get_parent_project(project_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->get_parent_project: %s\n" % e)

Name	Types	Notes
project_locator	str
fields	str	[optional]

Return type:: Project

Back to top

get_project_agent_pools¶

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

try:
    api_response = tc.project_api.get_project_agent_pools(project_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->get_project_agent_pools: %s\n" % e)

Name	Types	Notes
project_locator	str
fields	str	[optional]

Return type:: AgentPools

Back to top

get_projects_order¶

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

try:
    api_response = tc.project_api.get_projects_order(project_locator, field)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->get_projects_order: %s\n" % e)

Name	Types	Notes
project_locator	str
field	str

Return type:: Projects

Back to top

get_secure_value¶

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 |
token = 'token_example' # str |

try:
    api_response = tc.project_api.get_secure_value(project_locator, token)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->get_secure_value: %s\n" % e)

Name	Types	Notes
project_locator	str
token	str

Return type:: str

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

project_locator = 'project_locator_example' # str |

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

Name	Types	Notes
project_locator	str

Return type:: str

Back to top

get_single¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

feature_locator = 'feature_locator_example' # str |
project_locator = 'project_locator_example' # str |
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.project_api.get_single(feature_locator, project_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->get_single: %s\n" % e)

Name	Types	Notes
feature_locator	str
project_locator	str
fields	str	[optional]

Return type:: object

Back to top

reload_settings_file¶

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

try:
    api_response = tc.project_api.reload_settings_file(project_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->reload_settings_file: %s\n" % e)

Name	Types	Notes
project_locator	str
fields	str	[optional]

Return type:: Project

Back to top

remove_default_template¶

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

try:
    tc.project_api.remove_default_template(project_locator, fields=fields)
except ApiException as e:
    print("Exception when calling ProjectApi->remove_default_template: %s\n" % e)

Name	Types	Notes
project_locator	str
fields	str	[optional]

Return type:: void (empty response body)

Back to top

replace¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

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

feature_locator = 'feature_locator_example' # str |
project_locator = 'project_locator_example' # str |
body = dohq_teamcity.ProjectFeature() # ProjectFeature |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.project_api.replace(feature_locator, project_locator, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->replace: %s\n" % e)

Name	Types	Notes
feature_locator	str
project_locator	str
body	ProjectFeature	[optional]
fields	str	[optional]

Return type:: object

Back to top

replace_all¶

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

try:
    api_response = tc.project_api.replace_all(project_locator, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->replace_all: %s\n" % e)

Name	Types	Notes
project_locator	str
body	ProjectFeatures	[optional]
fields	str	[optional]

Return type:: object

Back to top

serve_build_field_with_project¶

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.project_api.serve_build_field_with_project(project_locator, bt_locator, build_locator, field)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->serve_build_field_with_project: %s\n" % e)

Name	Types	Notes
project_locator	str
bt_locator	str
build_locator	str
field	str

Return type:: str

Back to top

serve_build_type¶

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

try:
    api_response = tc.project_api.serve_build_type(project_locator, bt_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->serve_build_type: %s\n" % e)

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

Return type:: BuildType

Back to top

serve_build_type_field_with_project¶

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

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

Name	Types	Notes
project_locator	str
bt_locator	str
field	str

Return type:: str

Back to top

serve_build_type_templates¶

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

try:
    api_response = tc.project_api.serve_build_type_templates(project_locator, bt_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->serve_build_type_templates: %s\n" % e)

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

Return type:: BuildType

Back to top

serve_build_types_in_project¶

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

try:
    api_response = tc.project_api.serve_build_types_in_project(project_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->serve_build_types_in_project: %s\n" % e)

Name	Types	Notes
project_locator	str
fields	str	[optional]

Return type:: BuildTypes

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

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

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

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

project_locator = 'project_locator_example' # str |
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.project_api.serve_builds(project_locator, 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 ProjectApi->serve_builds: %s\n" % e)

Name	Types	Notes
project_locator	str
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

serve_project¶

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

try:
    api_response = tc.project_api.serve_project(project_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->serve_project: %s\n" % e)

Name	Types	Notes
project_locator	str
fields	str	[optional]

Return type:: Project

Back to top

serve_project_field¶

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

try:
    api_response = tc.project_api.serve_project_field(project_locator, field)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->serve_project_field: %s\n" % e)

Name	Types	Notes
project_locator	str
field	str

Return type:: str

Back to top

serve_projects¶

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

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

Return type:: Projects

Back to top

serve_templates_in_project¶

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

try:
    api_response = tc.project_api.serve_templates_in_project(project_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->serve_templates_in_project: %s\n" % e)

Name	Types	Notes
project_locator	str
fields	str	[optional]

Return type:: BuildTypes

Back to top

set_build_types_order¶

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 |
field = 'field_example' # str |
body = dohq_teamcity.BuildTypes() # BuildTypes |  (optional)

try:
    api_response = tc.project_api.set_build_types_order(project_locator, field, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->set_build_types_order: %s\n" % e)

Name	Types	Notes
project_locator	str
field	str
body	BuildTypes	[optional]

Return type:: BuildTypes

Back to top

set_default_template¶

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

try:
    api_response = tc.project_api.set_default_template(project_locator, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->set_default_template: %s\n" % e)

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

Return type:: BuildType

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

project_locator = 'project_locator_example' # str |
body = dohq_teamcity.ModelProperty() # ModelProperty |  (optional)
fields = 'fields_example' # str |  (optional)

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

Name	Types	Notes
project_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 |
project_locator = 'project_locator_example' # str |
body = dohq_teamcity.ModelProperty() # ModelProperty |  (optional)
fields = 'fields_example' # str |  (optional)

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

Name	Types	Notes
name	str
project_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'))

feature_locator = 'feature_locator_example' # str |
project_locator = 'project_locator_example' # str |
body = dohq_teamcity.ModelProperty() # ModelProperty |  (optional)
fields = 'fields_example' # str |  (optional)
fields2 = 'fields_example' # str |  (optional)

try:
    api_response = tc.project_api.set_parameter_1(feature_locator, project_locator, body=body, fields=fields, fields2=fields2)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->set_parameter_1: %s\n" % e)

Name	Types	Notes
feature_locator	str
project_locator	str
body	ModelProperty	[optional]
fields	str	[optional]
fields2	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 |
feature_locator = 'feature_locator_example' # str |
project_locator = 'project_locator_example' # str |
body = dohq_teamcity.ModelProperty() # ModelProperty |  (optional)
fields = 'fields_example' # str |  (optional)
fields2 = 'fields_example' # str |  (optional)

try:
    api_response = tc.project_api.set_parameter_2(name, feature_locator, project_locator, body=body, fields=fields, fields2=fields2)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->set_parameter_2: %s\n" % e)

Name	Types	Notes
name	str
feature_locator	str
project_locator	str
body	ModelProperty	[optional]
fields	str	[optional]
fields2	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 |
project_locator = 'project_locator_example' # str |
body = dohq_teamcity.Type() # Type |  (optional)

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

Name	Types	Notes
name	str
project_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 |
project_locator = 'project_locator_example' # str |
body = 'body_example' # str |  (optional)

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

Name	Types	Notes
name	str
project_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 |
project_locator = 'project_locator_example' # str |
body = 'body_example' # str |  (optional)

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

Name	Types	Notes
name	str
project_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 |
feature_locator = 'feature_locator_example' # str |
project_locator = 'project_locator_example' # str |
body = 'body_example' # str |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.project_api.set_parameter_value_long_0(name, feature_locator, project_locator, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->set_parameter_value_long_0: %s\n" % e)

Name	Types	Notes
name	str
feature_locator	str
project_locator	str
body	str	[optional]
fields	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'))

project_locator = 'project_locator_example' # str |
body = dohq_teamcity.Properties() # Properties |  (optional)
fields = 'fields_example' # str |  (optional)

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

Name	Types	Notes
project_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'))

feature_locator = 'feature_locator_example' # str |
project_locator = 'project_locator_example' # str |
body = dohq_teamcity.Properties() # Properties |  (optional)
fields = 'fields_example' # str |  (optional)
fields2 = 'fields_example' # str |  (optional)

try:
    api_response = tc.project_api.set_parameters_0(feature_locator, project_locator, body=body, fields=fields, fields2=fields2)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->set_parameters_0: %s\n" % e)

Name	Types	Notes
feature_locator	str
project_locator	str
body	Properties	[optional]
fields	str	[optional]
fields2	str	[optional]

Return type:: Properties

Back to top

set_parent_project¶

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

try:
    api_response = tc.project_api.set_parent_project(project_locator, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->set_parent_project: %s\n" % e)

Name	Types	Notes
project_locator	str
body	Project	[optional]
fields	str	[optional]

Return type:: Project

Back to top

set_project_agent_pools¶

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

try:
    api_response = tc.project_api.set_project_agent_pools(project_locator, body=body, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->set_project_agent_pools: %s\n" % e)

Name	Types	Notes
project_locator	str
body	AgentPools	[optional]
fields	str	[optional]

Return type:: AgentPools

Back to top

set_project_agent_pools_0¶

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 |
body = dohq_teamcity.AgentPool() # AgentPool |  (optional)

try:
    api_response = tc.project_api.set_project_agent_pools_0(project_locator, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->set_project_agent_pools_0: %s\n" % e)

Name	Types	Notes
project_locator	str
body	AgentPool	[optional]

Return type:: AgentPool

Back to top

set_project_field¶

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

try:
    api_response = tc.project_api.set_project_field(project_locator, field, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->set_project_field: %s\n" % e)

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

Return type:: str

Back to top

set_projects_order¶

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 |
field = 'field_example' # str |
body = dohq_teamcity.Projects() # Projects |  (optional)

try:
    api_response = tc.project_api.set_projects_order(project_locator, field, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->set_projects_order: %s\n" % e)

Name	Types	Notes
project_locator	str
field	str
body	Projects	[optional]

Return type:: Projects

Back to top