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 :doc:`/examples/api/BuildTypeApi` and model examples + This is autogenerated page, don't change them directly, use template. Read more in :doc:`/development` .. list-table:: :widths: 20 80 :header-rows: 1 * - Method - HTTP request * - :ref:`add_agent_requirement` - **POST** ``/app/rest/buildTypes/{btLocator}/agent-requirements`` * - :ref:`add_artifact_dep` - **POST** ``/app/rest/buildTypes/{btLocator}/artifact-dependencies`` * - :ref:`add_build_type` - **POST** ``/app/rest/buildTypes`` * - :ref:`add_feature` - **POST** ``/app/rest/buildTypes/{btLocator}/features`` * - :ref:`add_feature_parameter` - **PUT** ``/app/rest/buildTypes/{btLocator}/features/{featureId}/parameters/{parameterName}`` * - :ref:`add_snapshot_dep` - **POST** ``/app/rest/buildTypes/{btLocator}/snapshot-dependencies`` * - :ref:`add_step` - **POST** ``/app/rest/buildTypes/{btLocator}/steps`` * - :ref:`add_step_parameter` - **PUT** ``/app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters/{parameterName}`` * - :ref:`add_template` - **POST** ``/app/rest/buildTypes/{btLocator}/templates`` * - :ref:`add_trigger` - **POST** ``/app/rest/buildTypes/{btLocator}/triggers`` * - :ref:`add_vcs_root_entry` - **POST** ``/app/rest/buildTypes/{btLocator}/vcs-root-entries`` * - :ref:`change_artifact_dep_setting` - **PUT** ``/app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}/{fieldName}`` * - :ref:`change_feature_setting` - **PUT** ``/app/rest/buildTypes/{btLocator}/features/{featureId}/{name}`` * - :ref:`change_requirement_setting` - **PUT** ``/app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}/{fieldName}`` * - :ref:`change_step_setting` - **PUT** ``/app/rest/buildTypes/{btLocator}/steps/{stepId}/{fieldName}`` * - :ref:`change_trigger_setting` - **PUT** ``/app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}/{fieldName}`` * - :ref:`delete_agent_requirement` - **DELETE** ``/app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}`` * - :ref:`delete_all_parameters` - **DELETE** ``/app/rest/buildTypes/{btLocator}/parameters`` * - :ref:`delete_all_parameters_0` - **DELETE** ``/app/rest/buildTypes/{btLocator}/settings`` * - :ref:`delete_artifact_dep` - **DELETE** ``/app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}`` * - :ref:`delete_build_type` - **DELETE** ``/app/rest/buildTypes/{btLocator}`` * - :ref:`delete_feature` - **DELETE** ``/app/rest/buildTypes/{btLocator}/features/{featureId}`` * - :ref:`delete_parameter` - **DELETE** ``/app/rest/buildTypes/{btLocator}/parameters/{name}`` * - :ref:`delete_parameter_0` - **DELETE** ``/app/rest/buildTypes/{btLocator}/settings/{name}`` * - :ref:`delete_snapshot_dep` - **DELETE** ``/app/rest/buildTypes/{btLocator}/snapshot-dependencies/{snapshotDepLocator}`` * - :ref:`delete_step` - **DELETE** ``/app/rest/buildTypes/{btLocator}/steps/{stepId}`` * - :ref:`delete_trigger` - **DELETE** ``/app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}`` * - :ref:`delete_vcs_root_entry` - **DELETE** ``/app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}`` * - :ref:`get_agent_requirement` - **GET** ``/app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}`` * - :ref:`get_agent_requirements` - **GET** ``/app/rest/buildTypes/{btLocator}/agent-requirements`` * - :ref:`get_aliases` - **GET** ``/app/rest/buildTypes/{btLocator}/aliases`` * - :ref:`get_artifact_dep` - **GET** ``/app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}`` * - :ref:`get_artifact_dep_setting` - **GET** ``/app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}/{fieldName}`` * - :ref:`get_artifact_deps` - **GET** ``/app/rest/buildTypes/{btLocator}/artifact-dependencies`` * - :ref:`get_build_types` - **GET** ``/app/rest/buildTypes`` * - :ref:`get_children` - **GET** ``/app/rest/buildTypes/{btLocator}/vcs/files/latest/children{path}`` * - :ref:`get_children_alias` - **GET** ``/app/rest/buildTypes/{btLocator}/vcs/files/latest/{path}`` * - :ref:`get_content` - **GET** ``/app/rest/buildTypes/{btLocator}/vcs/files/latest/content{path}`` * - :ref:`get_content_alias` - **GET** ``/app/rest/buildTypes/{btLocator}/vcs/files/latest/files{path}`` * - :ref:`get_current_vcs_instances` - **GET** ``/app/rest/buildTypes/{btLocator}/vcsRootInstances`` * - :ref:`get_current_vcs_instances_obsolete` - **GET** ``/app/rest/buildTypes/{btLocator}/vcs-root-instances`` * - :ref:`get_example_new_project_description` - **GET** ``/app/rest/buildTypes/{btLocator}/example/newBuildTypeDescription`` * - :ref:`get_example_new_project_description_compatibility_version1` - **GET** ``/app/rest/buildTypes/{btLocator}/newBuildTypeDescription`` * - :ref:`get_feature` - **GET** ``/app/rest/buildTypes/{btLocator}/features/{featureId}`` * - :ref:`get_feature_parameter` - **GET** ``/app/rest/buildTypes/{btLocator}/features/{featureId}/parameters/{parameterName}`` * - :ref:`get_feature_parameters` - **GET** ``/app/rest/buildTypes/{btLocator}/features/{featureId}/parameters`` * - :ref:`get_feature_setting` - **GET** ``/app/rest/buildTypes/{btLocator}/features/{featureId}/{name}`` * - :ref:`get_features` - **GET** ``/app/rest/buildTypes/{btLocator}/features`` * - :ref:`get_investigations` - **GET** ``/app/rest/buildTypes/{btLocator}/investigations`` * - :ref:`get_metadata` - **GET** ``/app/rest/buildTypes/{btLocator}/vcs/files/latest/metadata{path}`` * - :ref:`get_parameter` - **GET** ``/app/rest/buildTypes/{btLocator}/parameters/{name}`` * - :ref:`get_parameter_0` - **GET** ``/app/rest/buildTypes/{btLocator}/settings/{name}`` * - :ref:`get_parameter_type` - **GET** ``/app/rest/buildTypes/{btLocator}/parameters/{name}/type`` * - :ref:`get_parameter_type_raw_value` - **GET** ``/app/rest/buildTypes/{btLocator}/parameters/{name}/type/rawValue`` * - :ref:`get_parameter_value_long` - **GET** ``/app/rest/buildTypes/{btLocator}/parameters/{name}/value`` * - :ref:`get_parameter_value_long_0` - **GET** ``/app/rest/buildTypes/{btLocator}/settings/{name}/value`` * - :ref:`get_parameters` - **GET** ``/app/rest/buildTypes/{btLocator}/parameters`` * - :ref:`get_parameters_0` - **GET** ``/app/rest/buildTypes/{btLocator}/settings`` * - :ref:`get_requirement_setting` - **GET** ``/app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}/{fieldName}`` * - :ref:`get_root` - **GET** ``/app/rest/buildTypes/{btLocator}/vcs/files/latest`` * - :ref:`get_settings_file` - **GET** ``/app/rest/buildTypes/{btLocator}/settingsFile`` * - :ref:`get_snapshot_dep` - **GET** ``/app/rest/buildTypes/{btLocator}/snapshot-dependencies/{snapshotDepLocator}`` * - :ref:`get_snapshot_deps` - **GET** ``/app/rest/buildTypes/{btLocator}/snapshot-dependencies`` * - :ref:`get_step` - **GET** ``/app/rest/buildTypes/{btLocator}/steps/{stepId}`` * - :ref:`get_step_parameter` - **GET** ``/app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters/{parameterName}`` * - :ref:`get_step_parameters` - **GET** ``/app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters`` * - :ref:`get_step_setting` - **GET** ``/app/rest/buildTypes/{btLocator}/steps/{stepId}/{fieldName}`` * - :ref:`get_steps` - **GET** ``/app/rest/buildTypes/{btLocator}/steps`` * - :ref:`get_template` - **GET** ``/app/rest/buildTypes/{btLocator}/templates/{templateLocator}`` * - :ref:`get_templates` - **GET** ``/app/rest/buildTypes/{btLocator}/templates`` * - :ref:`get_trigger` - **GET** ``/app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}`` * - :ref:`get_trigger_setting` - **GET** ``/app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}/{fieldName}`` * - :ref:`get_triggers` - **GET** ``/app/rest/buildTypes/{btLocator}/triggers`` * - :ref:`get_vcs_labeling_options` - **GET** ``/app/rest/buildTypes/{btLocator}/vcsLabeling`` * - :ref:`get_vcs_root_entries` - **GET** ``/app/rest/buildTypes/{btLocator}/vcs-root-entries`` * - :ref:`get_vcs_root_entry` - **GET** ``/app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}`` * - :ref:`get_vcs_root_entry_checkout_rules` - **GET** ``/app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}/checkout-rules`` * - :ref:`get_zipped` - **GET** ``/app/rest/buildTypes/{btLocator}/vcs/files/latest/archived{path}`` * - :ref:`remove_all_templates` - **DELETE** ``/app/rest/buildTypes/{btLocator}/templates`` * - :ref:`remove_template` - **DELETE** ``/app/rest/buildTypes/{btLocator}/templates/{templateLocator}`` * - :ref:`replace_agent_requirement` - **PUT** ``/app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}`` * - :ref:`replace_agent_requirements` - **PUT** ``/app/rest/buildTypes/{btLocator}/agent-requirements`` * - :ref:`replace_artifact_dep` - **PUT** ``/app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}`` * - :ref:`replace_artifact_deps` - **PUT** ``/app/rest/buildTypes/{btLocator}/artifact-dependencies`` * - :ref:`replace_feature` - **PUT** ``/app/rest/buildTypes/{btLocator}/features/{featureId}`` * - :ref:`replace_feature_parameters` - **PUT** ``/app/rest/buildTypes/{btLocator}/features/{featureId}/parameters`` * - :ref:`replace_features` - **PUT** ``/app/rest/buildTypes/{btLocator}/features`` * - :ref:`replace_snapshot_dep` - **PUT** ``/app/rest/buildTypes/{btLocator}/snapshot-dependencies/{snapshotDepLocator}`` * - :ref:`replace_snapshot_deps` - **PUT** ``/app/rest/buildTypes/{btLocator}/snapshot-dependencies`` * - :ref:`replace_step` - **PUT** ``/app/rest/buildTypes/{btLocator}/steps/{stepId}`` * - :ref:`replace_step_parameters` - **PUT** ``/app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters`` * - :ref:`replace_steps` - **PUT** ``/app/rest/buildTypes/{btLocator}/steps`` * - :ref:`replace_trigger` - **PUT** ``/app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}`` * - :ref:`replace_triggers` - **PUT** ``/app/rest/buildTypes/{btLocator}/triggers`` * - :ref:`replace_vcs_root_entries` - **PUT** ``/app/rest/buildTypes/{btLocator}/vcs-root-entries`` * - :ref:`serve_branches` - **GET** ``/app/rest/buildTypes/{btLocator}/branches`` * - :ref:`serve_build_field` - **GET** ``/app/rest/buildTypes/{btLocator}/builds/{buildLocator}/{field}`` * - :ref:`serve_build_type_builds_tags` - **GET** ``/app/rest/buildTypes/{btLocator}/buildTags`` * - :ref:`serve_build_type_field` - **GET** ``/app/rest/buildTypes/{btLocator}/{field}`` * - :ref:`serve_build_type_xml` - **GET** ``/app/rest/buildTypes/{btLocator}`` * - :ref:`serve_build_with_project` - **GET** ``/app/rest/buildTypes/{btLocator}/builds/{buildLocator}`` * - :ref:`serve_builds` - **GET** ``/app/rest/buildTypes/{btLocator}/builds`` * - :ref:`set_build_type_field` - **PUT** ``/app/rest/buildTypes/{btLocator}/{field}`` * - :ref:`set_parameter` - **POST** ``/app/rest/buildTypes/{btLocator}/parameters`` * - :ref:`set_parameter_0` - **PUT** ``/app/rest/buildTypes/{btLocator}/parameters/{name}`` * - :ref:`set_parameter_1` - **POST** ``/app/rest/buildTypes/{btLocator}/settings`` * - :ref:`set_parameter_2` - **PUT** ``/app/rest/buildTypes/{btLocator}/settings/{name}`` * - :ref:`set_parameter_type` - **PUT** ``/app/rest/buildTypes/{btLocator}/parameters/{name}/type`` * - :ref:`set_parameter_type_raw_value` - **PUT** ``/app/rest/buildTypes/{btLocator}/parameters/{name}/type/rawValue`` * - :ref:`set_parameter_value_long` - **PUT** ``/app/rest/buildTypes/{btLocator}/parameters/{name}/value`` * - :ref:`set_parameter_value_long_0` - **PUT** ``/app/rest/buildTypes/{btLocator}/settings/{name}/value`` * - :ref:`set_parameters` - **PUT** ``/app/rest/buildTypes/{btLocator}/parameters`` * - :ref:`set_parameters_0` - **PUT** ``/app/rest/buildTypes/{btLocator}/settings`` * - :ref:`set_templates` - **PUT** ``/app/rest/buildTypes/{btLocator}/templates`` * - :ref:`set_vcs_labeling_options` - **PUT** ``/app/rest/buildTypes/{btLocator}/vcsLabeling`` * - :ref:`update_vcs_root_entry` - **PUT** ``/app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}`` * - :ref:`update_vcs_root_entry_checkout_rules` - **PUT** ``/app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}/checkout-rules`` .. _add_agent_requirement: add_agent_requirement ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] * - **body** - `AgentRequirement <../models/AgentRequirement.html>`_ - [optional] Return type: `AgentRequirement <../models/AgentRequirement.html>`_ `Back to top <#>`_ .. _add_artifact_dep: add_artifact_dep ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] * - **body** - `ArtifactDependency <../models/ArtifactDependency.html>`_ - [optional] Return type: `ArtifactDependency <../models/ArtifactDependency.html>`_ `Back to top <#>`_ .. _add_build_type: add_build_type ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **body** - `BuildType <../models/BuildType.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: `BuildType <../models/BuildType.html>`_ `Back to top <#>`_ .. _add_feature: add_feature ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] * - **body** - `Feature <../models/Feature.html>`_ - [optional] Return type: `Feature <../models/Feature.html>`_ `Back to top <#>`_ .. _add_feature_parameter: add_feature_parameter ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **feature_id** - **str** - * - **parameter_name** - **str** - * - **body** - **str** - [optional] Return type: **str** `Back to top <#>`_ .. _add_snapshot_dep: add_snapshot_dep ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] * - **body** - `SnapshotDependency <../models/SnapshotDependency.html>`_ - [optional] Return type: `SnapshotDependency <../models/SnapshotDependency.html>`_ `Back to top <#>`_ .. _add_step: add_step ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] * - **body** - `Step <../models/Step.html>`_ - [optional] Return type: `Step <../models/Step.html>`_ `Back to top <#>`_ .. _add_step_parameter: add_step_parameter ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **step_id** - **str** - * - **parameter_name** - **str** - * - **body** - **str** - [optional] Return type: **str** `Back to top <#>`_ .. _add_template: add_template ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **body** - `BuildType <../models/BuildType.html>`_ - [optional] * - **optimize_settings** - **bool** - [optional] * - **fields** - **str** - [optional] Return type: `BuildType <../models/BuildType.html>`_ `Back to top <#>`_ .. _add_trigger: add_trigger ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] * - **body** - `Trigger <../models/Trigger.html>`_ - [optional] Return type: `Trigger <../models/Trigger.html>`_ `Back to top <#>`_ .. _add_vcs_root_entry: add_vcs_root_entry ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **body** - `VcsRootEntry <../models/VcsRootEntry.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: `VcsRootEntry <../models/VcsRootEntry.html>`_ `Back to top <#>`_ .. _change_artifact_dep_setting: change_artifact_dep_setting ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - 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: change_feature_setting ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **feature_id** - **str** - * - **name** - **str** - * - **body** - **str** - [optional] Return type: **str** `Back to top <#>`_ .. _change_requirement_setting: change_requirement_setting ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - 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: change_step_setting ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **step_id** - **str** - * - **field_name** - **str** - * - **body** - **str** - [optional] Return type: **str** `Back to top <#>`_ .. _change_trigger_setting: change_trigger_setting ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **trigger_locator** - **str** - * - **field_name** - **str** - * - **body** - **str** - [optional] Return type: **str** `Back to top <#>`_ .. _delete_agent_requirement: delete_agent_requirement ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **agent_requirement_locator** - **str** - Return type: void (empty response body) `Back to top <#>`_ .. _delete_all_parameters: delete_all_parameters ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - Return type: void (empty response body) `Back to top <#>`_ .. _delete_all_parameters_0: delete_all_parameters_0 ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - Return type: void (empty response body) `Back to top <#>`_ .. _delete_artifact_dep: delete_artifact_dep ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **artifact_dep_locator** - **str** - Return type: void (empty response body) `Back to top <#>`_ .. _delete_build_type: delete_build_type ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - Return type: void (empty response body) `Back to top <#>`_ .. _delete_feature: delete_feature ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **feature_id** - **str** - Return type: void (empty response body) `Back to top <#>`_ .. _delete_parameter: delete_parameter ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **bt_locator** - **str** - Return type: void (empty response body) `Back to top <#>`_ .. _delete_parameter_0: delete_parameter_0 ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **bt_locator** - **str** - Return type: void (empty response body) `Back to top <#>`_ .. _delete_snapshot_dep: delete_snapshot_dep ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **snapshot_dep_locator** - **str** - Return type: void (empty response body) `Back to top <#>`_ .. _delete_step: delete_step ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **step_id** - **str** - Return type: void (empty response body) `Back to top <#>`_ .. _delete_trigger: delete_trigger ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **trigger_locator** - **str** - Return type: void (empty response body) `Back to top <#>`_ .. _delete_vcs_root_entry: delete_vcs_root_entry ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **vcs_root_locator** - **str** - Return type: void (empty response body) `Back to top <#>`_ .. _get_agent_requirement: get_agent_requirement ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **agent_requirement_locator** - **str** - * - **fields** - **str** - [optional] Return type: `AgentRequirement <../models/AgentRequirement.html>`_ `Back to top <#>`_ .. _get_agent_requirements: get_agent_requirements ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] Return type: `AgentRequirements <../models/AgentRequirements.html>`_ `Back to top <#>`_ .. _get_aliases: get_aliases ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **field** - **str** - Return type: `Items <../models/Items.html>`_ `Back to top <#>`_ .. _get_artifact_dep: get_artifact_dep ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **artifact_dep_locator** - **str** - * - **fields** - **str** - [optional] Return type: `ArtifactDependency <../models/ArtifactDependency.html>`_ `Back to top <#>`_ .. _get_artifact_dep_setting: get_artifact_dep_setting ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **artifact_dep_locator** - **str** - * - **field_name** - **str** - Return type: **str** `Back to top <#>`_ .. _get_artifact_deps: get_artifact_deps ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] Return type: `ArtifactDependencies <../models/ArtifactDependencies.html>`_ `Back to top <#>`_ .. _get_build_types: get_build_types ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **locator** - **str** - [optional] * - **fields** - **str** - [optional] Return type: `BuildTypes <../models/BuildTypes.html>`_ `Back to top <#>`_ .. _get_children: get_children ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - 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 <../models/Files.html>`_ `Back to top <#>`_ .. _get_children_alias: get_children_alias ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - 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 <../models/Files.html>`_ `Back to top <#>`_ .. _get_content: get_content ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - 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: get_content_alias ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - 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: get_current_vcs_instances ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] Return type: `VcsRootInstances <../models/VcsRootInstances.html>`_ `Back to top <#>`_ .. _get_current_vcs_instances_obsolete: get_current_vcs_instances_obsolete ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] Return type: `VcsRootInstances <../models/VcsRootInstances.html>`_ `Back to top <#>`_ .. _get_example_new_project_description: get_example_new_project_description ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - Return type: `NewBuildTypeDescription <../models/NewBuildTypeDescription.html>`_ `Back to top <#>`_ .. _get_example_new_project_description_compatibility_version1: get_example_new_project_description_compatibility_version1 ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - Return type: `NewBuildTypeDescription <../models/NewBuildTypeDescription.html>`_ `Back to top <#>`_ .. _get_feature: get_feature ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **feature_id** - **str** - * - **fields** - **str** - [optional] Return type: `Feature <../models/Feature.html>`_ `Back to top <#>`_ .. _get_feature_parameter: get_feature_parameter ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **feature_id** - **str** - * - **parameter_name** - **str** - Return type: **str** `Back to top <#>`_ .. _get_feature_parameters: get_feature_parameters ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **feature_id** - **str** - * - **fields** - **str** - [optional] Return type: `Properties <../models/Properties.html>`_ `Back to top <#>`_ .. _get_feature_setting: get_feature_setting ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **feature_id** - **str** - * - **name** - **str** - Return type: **str** `Back to top <#>`_ .. _get_features: get_features ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] Return type: `Features <../models/Features.html>`_ `Back to top <#>`_ .. _get_investigations: get_investigations ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] Return type: `Investigations <../models/Investigations.html>`_ `Back to top <#>`_ .. _get_metadata: get_metadata ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **path** - **str** - * - **bt_locator** - **str** - * - **fields** - **str** - [optional] * - **resolve_parameters** - **bool** - [optional] Return type: `file <../models/file.html>`_ `Back to top <#>`_ .. _get_parameter: get_parameter ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **bt_locator** - **str** - * - **fields** - **str** - [optional] Return type: `ModelProperty <../models/ModelProperty.html>`_ `Back to top <#>`_ .. _get_parameter_0: get_parameter_0 ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **bt_locator** - **str** - * - **fields** - **str** - [optional] Return type: `ModelProperty <../models/ModelProperty.html>`_ `Back to top <#>`_ .. _get_parameter_type: get_parameter_type ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **bt_locator** - **str** - Return type: `Type <../models/Type.html>`_ `Back to top <#>`_ .. _get_parameter_type_raw_value: get_parameter_type_raw_value ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **bt_locator** - **str** - Return type: **str** `Back to top <#>`_ .. _get_parameter_value_long: get_parameter_value_long ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **bt_locator** - **str** - Return type: **str** `Back to top <#>`_ .. _get_parameter_value_long_0: get_parameter_value_long_0 ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **bt_locator** - **str** - Return type: **str** `Back to top <#>`_ .. _get_parameters: get_parameters ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **locator** - **str** - [optional] * - **fields** - **str** - [optional] Return type: `Properties <../models/Properties.html>`_ `Back to top <#>`_ .. _get_parameters_0: get_parameters_0 ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **locator** - **str** - [optional] * - **fields** - **str** - [optional] Return type: `Properties <../models/Properties.html>`_ `Back to top <#>`_ .. _get_requirement_setting: get_requirement_setting ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **agent_requirement_locator** - **str** - * - **field_name** - **str** - Return type: **str** `Back to top <#>`_ .. _get_root: get_root ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **base_path** - **str** - [optional] * - **locator** - **str** - [optional] * - **fields** - **str** - [optional] * - **resolve_parameters** - **bool** - [optional] Return type: `Files <../models/Files.html>`_ `Back to top <#>`_ .. _get_settings_file: get_settings_file ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - Return type: **str** `Back to top <#>`_ .. _get_snapshot_dep: get_snapshot_dep ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **snapshot_dep_locator** - **str** - * - **fields** - **str** - [optional] Return type: `SnapshotDependency <../models/SnapshotDependency.html>`_ `Back to top <#>`_ .. _get_snapshot_deps: get_snapshot_deps ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] Return type: `SnapshotDependencies <../models/SnapshotDependencies.html>`_ `Back to top <#>`_ .. _get_step: get_step ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **step_id** - **str** - * - **fields** - **str** - [optional] Return type: `Step <../models/Step.html>`_ `Back to top <#>`_ .. _get_step_parameter: get_step_parameter ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **step_id** - **str** - * - **parameter_name** - **str** - Return type: **str** `Back to top <#>`_ .. _get_step_parameters: get_step_parameters ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **step_id** - **str** - * - **fields** - **str** - [optional] Return type: `Properties <../models/Properties.html>`_ `Back to top <#>`_ .. _get_step_setting: get_step_setting ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **step_id** - **str** - * - **field_name** - **str** - Return type: **str** `Back to top <#>`_ .. _get_steps: get_steps ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] Return type: `Steps <../models/Steps.html>`_ `Back to top <#>`_ .. _get_template: get_template ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **template_locator** - **str** - * - **fields** - **str** - [optional] Return type: `BuildType <../models/BuildType.html>`_ `Back to top <#>`_ .. _get_templates: get_templates ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] Return type: `BuildTypes <../models/BuildTypes.html>`_ `Back to top <#>`_ .. _get_trigger: get_trigger ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **trigger_locator** - **str** - * - **fields** - **str** - [optional] Return type: `Trigger <../models/Trigger.html>`_ `Back to top <#>`_ .. _get_trigger_setting: get_trigger_setting ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **trigger_locator** - **str** - * - **field_name** - **str** - Return type: **str** `Back to top <#>`_ .. _get_triggers: get_triggers ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] Return type: `Triggers <../models/Triggers.html>`_ `Back to top <#>`_ .. _get_vcs_labeling_options: get_vcs_labeling_options ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - Return type: `VcsLabeling <../models/VcsLabeling.html>`_ `Back to top <#>`_ .. _get_vcs_root_entries: get_vcs_root_entries ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] Return type: `VcsRootEntries <../models/VcsRootEntries.html>`_ `Back to top <#>`_ .. _get_vcs_root_entry: get_vcs_root_entry ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **vcs_root_locator** - **str** - * - **fields** - **str** - [optional] Return type: `VcsRootEntry <../models/VcsRootEntry.html>`_ `Back to top <#>`_ .. _get_vcs_root_entry_checkout_rules: get_vcs_root_entry_checkout_rules ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **vcs_root_locator** - **str** - Return type: **str** `Back to top <#>`_ .. _get_zipped: get_zipped ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - 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: remove_all_templates ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **inline_settings** - **bool** - [optional] Return type: void (empty response body) `Back to top <#>`_ .. _remove_template: remove_template ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - 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: replace_agent_requirement ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **agent_requirement_locator** - **str** - * - **fields** - **str** - [optional] * - **body** - `AgentRequirement <../models/AgentRequirement.html>`_ - [optional] Return type: `AgentRequirement <../models/AgentRequirement.html>`_ `Back to top <#>`_ .. _replace_agent_requirements: replace_agent_requirements ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] * - **body** - `AgentRequirements <../models/AgentRequirements.html>`_ - [optional] Return type: `AgentRequirements <../models/AgentRequirements.html>`_ `Back to top <#>`_ .. _replace_artifact_dep: replace_artifact_dep ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **artifact_dep_locator** - **str** - * - **fields** - **str** - [optional] * - **body** - `ArtifactDependency <../models/ArtifactDependency.html>`_ - [optional] Return type: `ArtifactDependency <../models/ArtifactDependency.html>`_ `Back to top <#>`_ .. _replace_artifact_deps: replace_artifact_deps ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] * - **body** - `ArtifactDependencies <../models/ArtifactDependencies.html>`_ - [optional] Return type: `ArtifactDependencies <../models/ArtifactDependencies.html>`_ `Back to top <#>`_ .. _replace_feature: replace_feature ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **feature_id** - **str** - * - **fields** - **str** - [optional] * - **body** - `Feature <../models/Feature.html>`_ - [optional] Return type: `Feature <../models/Feature.html>`_ `Back to top <#>`_ .. _replace_feature_parameters: replace_feature_parameters ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **feature_id** - **str** - * - **body** - `Properties <../models/Properties.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: `Properties <../models/Properties.html>`_ `Back to top <#>`_ .. _replace_features: replace_features ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] * - **body** - `Features <../models/Features.html>`_ - [optional] Return type: `Features <../models/Features.html>`_ `Back to top <#>`_ .. _replace_snapshot_dep: replace_snapshot_dep ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **snapshot_dep_locator** - **str** - * - **fields** - **str** - [optional] * - **body** - `SnapshotDependency <../models/SnapshotDependency.html>`_ - [optional] Return type: `SnapshotDependency <../models/SnapshotDependency.html>`_ `Back to top <#>`_ .. _replace_snapshot_deps: replace_snapshot_deps ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] * - **body** - `SnapshotDependencies <../models/SnapshotDependencies.html>`_ - [optional] Return type: `SnapshotDependencies <../models/SnapshotDependencies.html>`_ `Back to top <#>`_ .. _replace_step: replace_step ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **step_id** - **str** - * - **fields** - **str** - [optional] * - **body** - `Step <../models/Step.html>`_ - [optional] Return type: `Step <../models/Step.html>`_ `Back to top <#>`_ .. _replace_step_parameters: replace_step_parameters ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **step_id** - **str** - * - **body** - `Properties <../models/Properties.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: `Properties <../models/Properties.html>`_ `Back to top <#>`_ .. _replace_steps: replace_steps ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] * - **body** - `Steps <../models/Steps.html>`_ - [optional] Return type: `Steps <../models/Steps.html>`_ `Back to top <#>`_ .. _replace_trigger: replace_trigger ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **trigger_locator** - **str** - * - **fields** - **str** - [optional] * - **body** - `Trigger <../models/Trigger.html>`_ - [optional] Return type: `Trigger <../models/Trigger.html>`_ `Back to top <#>`_ .. _replace_triggers: replace_triggers ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] * - **body** - `Triggers <../models/Triggers.html>`_ - [optional] Return type: `Triggers <../models/Triggers.html>`_ `Back to top <#>`_ .. _replace_vcs_root_entries: replace_vcs_root_entries ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **body** - `VcsRootEntries <../models/VcsRootEntries.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: `VcsRootEntries <../models/VcsRootEntries.html>`_ `Back to top <#>`_ .. _serve_branches: serve_branches ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **locator** - **str** - [optional] * - **fields** - **str** - [optional] Return type: `Branches <../models/Branches.html>`_ `Back to top <#>`_ .. _serve_build_field: serve_build_field ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **build_locator** - **str** - * - **field** - **str** - Return type: **str** `Back to top <#>`_ .. _serve_build_type_builds_tags: serve_build_type_builds_tags ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **field** - **str** - Return type: `Tags <../models/Tags.html>`_ `Back to top <#>`_ .. _serve_build_type_field: serve_build_type_field ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **field** - **str** - Return type: **str** `Back to top <#>`_ .. _serve_build_type_xml: serve_build_type_xml ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **fields** - **str** - [optional] Return type: `BuildType <../models/BuildType.html>`_ `Back to top <#>`_ .. _serve_build_with_project: serve_build_with_project ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **build_locator** - **str** - * - **fields** - **str** - [optional] Return type: `Build <../models/Build.html>`_ `Back to top <#>`_ .. _serve_builds: serve_builds ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - 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] <../models/str.html>`_ - [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 <../models/Builds.html>`_ `Back to top <#>`_ .. _set_build_type_field: set_build_type_field ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **field** - **str** - * - **body** - **str** - [optional] Return type: **str** `Back to top <#>`_ .. _set_parameter: set_parameter ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **body** - `ModelProperty <../models/ModelProperty.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: `ModelProperty <../models/ModelProperty.html>`_ `Back to top <#>`_ .. _set_parameter_0: set_parameter_0 ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **bt_locator** - **str** - * - **body** - `ModelProperty <../models/ModelProperty.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: `ModelProperty <../models/ModelProperty.html>`_ `Back to top <#>`_ .. _set_parameter_1: set_parameter_1 ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **body** - `ModelProperty <../models/ModelProperty.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: `ModelProperty <../models/ModelProperty.html>`_ `Back to top <#>`_ .. _set_parameter_2: set_parameter_2 ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **bt_locator** - **str** - * - **body** - `ModelProperty <../models/ModelProperty.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: `ModelProperty <../models/ModelProperty.html>`_ `Back to top <#>`_ .. _set_parameter_type: set_parameter_type ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **bt_locator** - **str** - * - **body** - `Type <../models/Type.html>`_ - [optional] Return type: `Type <../models/Type.html>`_ `Back to top <#>`_ .. _set_parameter_type_raw_value: set_parameter_type_raw_value ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **bt_locator** - **str** - * - **body** - **str** - [optional] Return type: **str** `Back to top <#>`_ .. _set_parameter_value_long: set_parameter_value_long ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **bt_locator** - **str** - * - **body** - **str** - [optional] Return type: **str** `Back to top <#>`_ .. _set_parameter_value_long_0: set_parameter_value_long_0 ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **bt_locator** - **str** - * - **body** - **str** - [optional] Return type: **str** `Back to top <#>`_ .. _set_parameters: set_parameters ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **body** - `Properties <../models/Properties.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: `Properties <../models/Properties.html>`_ `Back to top <#>`_ .. _set_parameters_0: set_parameters_0 ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **body** - `Properties <../models/Properties.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: `Properties <../models/Properties.html>`_ `Back to top <#>`_ .. _set_templates: set_templates ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **body** - `BuildTypes <../models/BuildTypes.html>`_ - [optional] * - **optimize_settings** - **bool** - [optional] * - **fields** - **str** - [optional] Return type: `BuildTypes <../models/BuildTypes.html>`_ `Back to top <#>`_ .. _set_vcs_labeling_options: set_vcs_labeling_options ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **body** - `VcsLabeling <../models/VcsLabeling.html>`_ - [optional] Return type: `VcsLabeling <../models/VcsLabeling.html>`_ `Back to top <#>`_ .. _update_vcs_root_entry: update_vcs_root_entry ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **vcs_root_locator** - **str** - * - **body** - `VcsRootEntry <../models/VcsRootEntry.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: `VcsRootEntry <../models/VcsRootEntry.html>`_ `Back to top <#>`_ .. _update_vcs_root_entry_checkout_rules: update_vcs_root_entry_checkout_rules ----------------- .. code-block:: python 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) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **bt_locator** - **str** - * - **vcs_root_locator** - **str** - * - **body** - **str** - [optional] Return type: **str** `Back to top <#>`_