dohq_teamcity.ProjectApi ###################################### .. note:: + All ``serve_*`` method have aliases with get: ``serve_something`` == ``get_something`` + Some API have ``get`` method - default method to get object by locator (e.g ``agent_api.get('id:123')`` return ``Agent`` model by id + See more examples on page :doc:`/examples/api/ProjectApi` 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` - **POST** ``/app/rest/projects/{projectLocator}/projectFeatures`` * - :ref:`create_build_type` - **POST** ``/app/rest/projects/{projectLocator}/buildTypes`` * - :ref:`create_build_type_template` - **POST** ``/app/rest/projects/{projectLocator}/templates`` * - :ref:`create_project` - **POST** ``/app/rest/projects`` * - :ref:`create_secure_token` - **POST** ``/app/rest/projects/{projectLocator}/secure/tokens`` * - :ref:`delete` - **DELETE** ``/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}`` * - :ref:`delete_all_parameters` - **DELETE** ``/app/rest/projects/{projectLocator}/parameters`` * - :ref:`delete_all_parameters_0` - **DELETE** ``/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}/properties`` * - :ref:`delete_parameter` - **DELETE** ``/app/rest/projects/{projectLocator}/parameters/{name}`` * - :ref:`delete_parameter_0` - **DELETE** ``/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}/properties/{name}`` * - :ref:`delete_project` - **DELETE** ``/app/rest/projects/{projectLocator}`` * - :ref:`delete_project_agent_pools` - **DELETE** ``/app/rest/projects/{projectLocator}/agentPools/{agentPoolLocator}`` * - :ref:`get` - **GET** ``/app/rest/projects/{projectLocator}/projectFeatures`` * - :ref:`get_branches` - **GET** ``/app/rest/projects/{projectLocator}/branches`` * - :ref:`get_build_types_order` - **GET** ``/app/rest/projects/{projectLocator}/order/buildTypes`` * - :ref:`get_default_template` - **GET** ``/app/rest/projects/{projectLocator}/defaultTemplate`` * - :ref:`get_example_new_project_description` - **GET** ``/app/rest/projects/{projectLocator}/example/newProjectDescription`` * - :ref:`get_example_new_project_description_compatibility_version1` - **GET** ``/app/rest/projects/{projectLocator}/newProjectDescription`` * - :ref:`get_parameter` - **GET** ``/app/rest/projects/{projectLocator}/parameters/{name}`` * - :ref:`get_parameter_0` - **GET** ``/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}/properties/{name}`` * - :ref:`get_parameter_type` - **GET** ``/app/rest/projects/{projectLocator}/parameters/{name}/type`` * - :ref:`get_parameter_type_raw_value` - **GET** ``/app/rest/projects/{projectLocator}/parameters/{name}/type/rawValue`` * - :ref:`get_parameter_value_long` - **GET** ``/app/rest/projects/{projectLocator}/parameters/{name}/value`` * - :ref:`get_parameter_value_long_0` - **GET** ``/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}/properties/{name}/value`` * - :ref:`get_parameters` - **GET** ``/app/rest/projects/{projectLocator}/parameters`` * - :ref:`get_parameters_0` - **GET** ``/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}/properties`` * - :ref:`get_parent_project` - **GET** ``/app/rest/projects/{projectLocator}/parentProject`` * - :ref:`get_project_agent_pools` - **GET** ``/app/rest/projects/{projectLocator}/agentPools`` * - :ref:`get_projects_order` - **GET** ``/app/rest/projects/{projectLocator}/order/projects`` * - :ref:`get_secure_value` - **GET** ``/app/rest/projects/{projectLocator}/secure/values/{token}`` * - :ref:`get_settings_file` - **GET** ``/app/rest/projects/{projectLocator}/settingsFile`` * - :ref:`get_single` - **GET** ``/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}`` * - :ref:`reload_settings_file` - **GET** ``/app/rest/projects/{projectLocator}/latest`` * - :ref:`remove_default_template` - **DELETE** ``/app/rest/projects/{projectLocator}/defaultTemplate`` * - :ref:`replace` - **PUT** ``/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}`` * - :ref:`replace_all` - **PUT** ``/app/rest/projects/{projectLocator}/projectFeatures`` * - :ref:`serve_build_field_with_project` - **GET** ``/app/rest/projects/{projectLocator}/buildTypes/{btLocator}/builds/{buildLocator}/{field}`` * - :ref:`serve_build_type` - **GET** ``/app/rest/projects/{projectLocator}/buildTypes/{btLocator}`` * - :ref:`serve_build_type_field_with_project` - **GET** ``/app/rest/projects/{projectLocator}/buildTypes/{btLocator}/{field}`` * - :ref:`serve_build_type_templates` - **GET** ``/app/rest/projects/{projectLocator}/templates/{btLocator}`` * - :ref:`serve_build_types_in_project` - **GET** ``/app/rest/projects/{projectLocator}/buildTypes`` * - :ref:`serve_build_with_project` - **GET** ``/app/rest/projects/{projectLocator}/buildTypes/{btLocator}/builds/{buildLocator}`` * - :ref:`serve_builds` - **GET** ``/app/rest/projects/{projectLocator}/buildTypes/{btLocator}/builds`` * - :ref:`serve_project` - **GET** ``/app/rest/projects/{projectLocator}`` * - :ref:`serve_project_field` - **GET** ``/app/rest/projects/{projectLocator}/{field}`` * - :ref:`serve_projects` - **GET** ``/app/rest/projects`` * - :ref:`serve_templates_in_project` - **GET** ``/app/rest/projects/{projectLocator}/templates`` * - :ref:`set_build_types_order` - **PUT** ``/app/rest/projects/{projectLocator}/order/buildTypes`` * - :ref:`set_default_template` - **PUT** ``/app/rest/projects/{projectLocator}/defaultTemplate`` * - :ref:`set_parameter` - **POST** ``/app/rest/projects/{projectLocator}/parameters`` * - :ref:`set_parameter_0` - **PUT** ``/app/rest/projects/{projectLocator}/parameters/{name}`` * - :ref:`set_parameter_1` - **POST** ``/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}/properties`` * - :ref:`set_parameter_2` - **PUT** ``/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}/properties/{name}`` * - :ref:`set_parameter_type` - **PUT** ``/app/rest/projects/{projectLocator}/parameters/{name}/type`` * - :ref:`set_parameter_type_raw_value` - **PUT** ``/app/rest/projects/{projectLocator}/parameters/{name}/type/rawValue`` * - :ref:`set_parameter_value_long` - **PUT** ``/app/rest/projects/{projectLocator}/parameters/{name}/value`` * - :ref:`set_parameter_value_long_0` - **PUT** ``/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}/properties/{name}/value`` * - :ref:`set_parameters` - **PUT** ``/app/rest/projects/{projectLocator}/parameters`` * - :ref:`set_parameters_0` - **PUT** ``/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}/properties`` * - :ref:`set_parent_project` - **PUT** ``/app/rest/projects/{projectLocator}/parentProject`` * - :ref:`set_project_agent_pools` - **PUT** ``/app/rest/projects/{projectLocator}/agentPools`` * - :ref:`set_project_agent_pools_0` - **POST** ``/app/rest/projects/{projectLocator}/agentPools`` * - :ref:`set_project_field` - **PUT** ``/app/rest/projects/{projectLocator}/{field}`` * - :ref:`set_projects_order` - **PUT** ``/app/rest/projects/{projectLocator}/order/projects`` .. _add: add ----------------- .. 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')) project_locator = 'project_locator_example' # str | body = dohq_teamcity.ProjectFeature() # ProjectFeature | (optional) fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.add(project_locator, body=body, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->add: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **body** - `ProjectFeature <../models/ProjectFeature.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: **object** `Back to top <#>`_ .. _create_build_type: create_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')) project_locator = 'project_locator_example' # str | body = dohq_teamcity.NewBuildTypeDescription() # NewBuildTypeDescription | (optional) fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.create_build_type(project_locator, body=body, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->create_build_type: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **body** - `NewBuildTypeDescription <../models/NewBuildTypeDescription.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: `BuildType <../models/BuildType.html>`_ `Back to top <#>`_ .. _create_build_type_template: create_build_type_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')) project_locator = 'project_locator_example' # str | body = dohq_teamcity.NewBuildTypeDescription() # NewBuildTypeDescription | (optional) fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.create_build_type_template(project_locator, body=body, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->create_build_type_template: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **body** - `NewBuildTypeDescription <../models/NewBuildTypeDescription.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: `BuildType <../models/BuildType.html>`_ `Back to top <#>`_ .. _create_project: create_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')) body = dohq_teamcity.NewProjectDescription() # NewProjectDescription | (optional) try: api_response = tc.project_api.create_project(body=body) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->create_project: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **body** - `NewProjectDescription <../models/NewProjectDescription.html>`_ - [optional] Return type: `Project <../models/Project.html>`_ `Back to top <#>`_ .. _create_secure_token: create_secure_token ----------------- .. 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')) project_locator = 'project_locator_example' # str | body = 'body_example' # str | (optional) try: api_response = tc.project_api.create_secure_token(project_locator, body=body) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->create_secure_token: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **body** - **str** - [optional] Return type: **str** `Back to top <#>`_ .. _delete: delete ----------------- .. 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')) feature_locator = 'feature_locator_example' # str | project_locator = 'project_locator_example' # str | try: tc.project_api.delete(feature_locator, project_locator) except ApiException as e: print("Exception when calling ProjectApi->delete: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **feature_locator** - **str** - * - **project_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')) project_locator = 'project_locator_example' # str | try: tc.project_api.delete_all_parameters(project_locator) except ApiException as e: print("Exception when calling ProjectApi->delete_all_parameters: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_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')) feature_locator = 'feature_locator_example' # str | project_locator = 'project_locator_example' # str | fields = 'fields_example' # str | (optional) try: tc.project_api.delete_all_parameters_0(feature_locator, project_locator, fields=fields) except ApiException as e: print("Exception when calling ProjectApi->delete_all_parameters_0: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **feature_locator** - **str** - * - **project_locator** - **str** - * - **fields** - **str** - [optional] 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 | project_locator = 'project_locator_example' # str | try: tc.project_api.delete_parameter(name, project_locator) except ApiException as e: print("Exception when calling ProjectApi->delete_parameter: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **project_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 | feature_locator = 'feature_locator_example' # str | project_locator = 'project_locator_example' # str | fields = 'fields_example' # str | (optional) try: tc.project_api.delete_parameter_0(name, feature_locator, project_locator, fields=fields) except ApiException as e: print("Exception when calling ProjectApi->delete_parameter_0: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **feature_locator** - **str** - * - **project_locator** - **str** - * - **fields** - **str** - [optional] Return type: void (empty response body) `Back to top <#>`_ .. _delete_project: delete_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')) project_locator = 'project_locator_example' # str | try: tc.project_api.delete_project(project_locator) except ApiException as e: print("Exception when calling ProjectApi->delete_project: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - Return type: void (empty response body) `Back to top <#>`_ .. _delete_project_agent_pools: delete_project_agent_pools ----------------- .. 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')) project_locator = 'project_locator_example' # str | agent_pool_locator = 'agent_pool_locator_example' # str | try: tc.project_api.delete_project_agent_pools(project_locator, agent_pool_locator) except ApiException as e: print("Exception when calling ProjectApi->delete_project_agent_pools: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **agent_pool_locator** - **str** - Return type: void (empty response body) `Back to top <#>`_ .. _get: get ----------------- .. 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')) project_locator = 'project_locator_example' # str | locator = 'locator_example' # str | (optional) fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.get(project_locator, locator=locator, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **locator** - **str** - [optional] * - **fields** - **str** - [optional] Return type: **object** `Back to top <#>`_ .. _get_branches: get_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')) project_locator = 'project_locator_example' # str | locator = 'locator_example' # str | (optional) fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.get_branches(project_locator, locator=locator, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_branches: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **locator** - **str** - [optional] * - **fields** - **str** - [optional] Return type: `Branches <../models/Branches.html>`_ `Back to top <#>`_ .. _get_build_types_order: get_build_types_order ----------------- .. 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')) project_locator = 'project_locator_example' # str | field = 'field_example' # str | try: api_response = tc.project_api.get_build_types_order(project_locator, field) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_build_types_order: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **field** - **str** - Return type: `BuildTypes <../models/BuildTypes.html>`_ `Back to top <#>`_ .. _get_default_template: get_default_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')) project_locator = 'project_locator_example' # str | fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.get_default_template(project_locator, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_default_template: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **fields** - **str** - [optional] Return type: `BuildType <../models/BuildType.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')) project_locator = 'project_locator_example' # str | id = 'id_example' # str | (optional) try: api_response = tc.project_api.get_example_new_project_description(project_locator, id=id) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_example_new_project_description: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **id** - **str** - [optional] Return type: `NewProjectDescription <../models/NewProjectDescription.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')) project_locator = 'project_locator_example' # str | id = 'id_example' # str | (optional) try: api_response = tc.project_api.get_example_new_project_description_compatibility_version1(project_locator, id=id) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_example_new_project_description_compatibility_version1: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **id** - **str** - [optional] Return type: `NewProjectDescription <../models/NewProjectDescription.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 | project_locator = 'project_locator_example' # str | fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.get_parameter(name, project_locator, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_parameter: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **project_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 | feature_locator = 'feature_locator_example' # str | project_locator = 'project_locator_example' # str | fields = 'fields_example' # str | (optional) fields2 = 'fields_example' # str | (optional) try: api_response = tc.project_api.get_parameter_0(name, feature_locator, project_locator, fields=fields, fields2=fields2) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_parameter_0: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **feature_locator** - **str** - * - **project_locator** - **str** - * - **fields** - **str** - [optional] * - **fields2** - **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 | project_locator = 'project_locator_example' # str | try: api_response = tc.project_api.get_parameter_type(name, project_locator) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_parameter_type: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **project_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 | project_locator = 'project_locator_example' # str | try: api_response = tc.project_api.get_parameter_type_raw_value(name, project_locator) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_parameter_type_raw_value: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **project_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 | project_locator = 'project_locator_example' # str | try: api_response = tc.project_api.get_parameter_value_long(name, project_locator) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_parameter_value_long: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **project_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 | feature_locator = 'feature_locator_example' # str | project_locator = 'project_locator_example' # str | fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.get_parameter_value_long_0(name, feature_locator, project_locator, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_parameter_value_long_0: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **feature_locator** - **str** - * - **project_locator** - **str** - * - **fields** - **str** - [optional] 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')) project_locator = 'project_locator_example' # str | locator = 'locator_example' # str | (optional) fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.get_parameters(project_locator, locator=locator, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_parameters: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_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')) feature_locator = 'feature_locator_example' # str | project_locator = 'project_locator_example' # str | locator = 'locator_example' # str | (optional) fields = 'fields_example' # str | (optional) fields2 = 'fields_example' # str | (optional) try: api_response = tc.project_api.get_parameters_0(feature_locator, project_locator, locator=locator, fields=fields, fields2=fields2) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_parameters_0: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **feature_locator** - **str** - * - **project_locator** - **str** - * - **locator** - **str** - [optional] * - **fields** - **str** - [optional] * - **fields2** - **str** - [optional] Return type: `Properties <../models/Properties.html>`_ `Back to top <#>`_ .. _get_parent_project: get_parent_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')) project_locator = 'project_locator_example' # str | fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.get_parent_project(project_locator, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_parent_project: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **fields** - **str** - [optional] Return type: `Project <../models/Project.html>`_ `Back to top <#>`_ .. _get_project_agent_pools: get_project_agent_pools ----------------- .. 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')) project_locator = 'project_locator_example' # str | fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.get_project_agent_pools(project_locator, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_project_agent_pools: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **fields** - **str** - [optional] Return type: `AgentPools <../models/AgentPools.html>`_ `Back to top <#>`_ .. _get_projects_order: get_projects_order ----------------- .. 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')) project_locator = 'project_locator_example' # str | field = 'field_example' # str | try: api_response = tc.project_api.get_projects_order(project_locator, field) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_projects_order: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **field** - **str** - Return type: `Projects <../models/Projects.html>`_ `Back to top <#>`_ .. _get_secure_value: get_secure_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')) project_locator = 'project_locator_example' # str | token = 'token_example' # str | try: api_response = tc.project_api.get_secure_value(project_locator, token) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_secure_value: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **token** - **str** - Return type: **str** `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')) project_locator = 'project_locator_example' # str | try: api_response = tc.project_api.get_settings_file(project_locator) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_settings_file: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - Return type: **str** `Back to top <#>`_ .. _get_single: get_single ----------------- .. 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')) feature_locator = 'feature_locator_example' # str | project_locator = 'project_locator_example' # str | fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.get_single(feature_locator, project_locator, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_single: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **feature_locator** - **str** - * - **project_locator** - **str** - * - **fields** - **str** - [optional] Return type: **object** `Back to top <#>`_ .. _reload_settings_file: reload_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')) project_locator = 'project_locator_example' # str | fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.reload_settings_file(project_locator, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->reload_settings_file: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **fields** - **str** - [optional] Return type: `Project <../models/Project.html>`_ `Back to top <#>`_ .. _remove_default_template: remove_default_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')) project_locator = 'project_locator_example' # str | fields = 'fields_example' # str | (optional) try: tc.project_api.remove_default_template(project_locator, fields=fields) except ApiException as e: print("Exception when calling ProjectApi->remove_default_template: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **fields** - **str** - [optional] Return type: void (empty response body) `Back to top <#>`_ .. _replace: replace ----------------- .. 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')) feature_locator = 'feature_locator_example' # str | project_locator = 'project_locator_example' # str | body = dohq_teamcity.ProjectFeature() # ProjectFeature | (optional) fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.replace(feature_locator, project_locator, body=body, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->replace: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **feature_locator** - **str** - * - **project_locator** - **str** - * - **body** - `ProjectFeature <../models/ProjectFeature.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: **object** `Back to top <#>`_ .. _replace_all: replace_all ----------------- .. 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')) project_locator = 'project_locator_example' # str | body = dohq_teamcity.ProjectFeatures() # ProjectFeatures | (optional) fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.replace_all(project_locator, body=body, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->replace_all: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **body** - `ProjectFeatures <../models/ProjectFeatures.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: **object** `Back to top <#>`_ .. _serve_build_field_with_project: serve_build_field_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')) project_locator = 'project_locator_example' # str | bt_locator = 'bt_locator_example' # str | build_locator = 'build_locator_example' # str | field = 'field_example' # str | try: api_response = tc.project_api.serve_build_field_with_project(project_locator, bt_locator, build_locator, field) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->serve_build_field_with_project: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **bt_locator** - **str** - * - **build_locator** - **str** - * - **field** - **str** - Return type: **str** `Back to top <#>`_ .. _serve_build_type: serve_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')) project_locator = 'project_locator_example' # str | bt_locator = 'bt_locator_example' # str | fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.serve_build_type(project_locator, bt_locator, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->serve_build_type: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **bt_locator** - **str** - * - **fields** - **str** - [optional] Return type: `BuildType <../models/BuildType.html>`_ `Back to top <#>`_ .. _serve_build_type_field_with_project: serve_build_type_field_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')) project_locator = 'project_locator_example' # str | bt_locator = 'bt_locator_example' # str | field = 'field_example' # str | try: api_response = tc.project_api.serve_build_type_field_with_project(project_locator, bt_locator, field) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->serve_build_type_field_with_project: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **bt_locator** - **str** - * - **field** - **str** - Return type: **str** `Back to top <#>`_ .. _serve_build_type_templates: serve_build_type_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')) project_locator = 'project_locator_example' # str | bt_locator = 'bt_locator_example' # str | fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.serve_build_type_templates(project_locator, bt_locator, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->serve_build_type_templates: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **bt_locator** - **str** - * - **fields** - **str** - [optional] Return type: `BuildType <../models/BuildType.html>`_ `Back to top <#>`_ .. _serve_build_types_in_project: serve_build_types_in_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')) project_locator = 'project_locator_example' # str | fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.serve_build_types_in_project(project_locator, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->serve_build_types_in_project: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **fields** - **str** - [optional] Return type: `BuildTypes <../models/BuildTypes.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')) project_locator = 'project_locator_example' # str | bt_locator = 'bt_locator_example' # str | build_locator = 'build_locator_example' # str | fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.serve_build_with_project(project_locator, bt_locator, build_locator, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->serve_build_with_project: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **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')) project_locator = 'project_locator_example' # str | bt_locator = 'bt_locator_example' # str | status = 'status_example' # str | (optional) triggered_by_user = 'triggered_by_user_example' # str | (optional) include_personal = true # bool | (optional) include_canceled = true # bool | (optional) only_pinned = true # bool | (optional) tag = ['tag_example'] # list[str] | (optional) agent_name = 'agent_name_example' # str | (optional) since_build = 'since_build_example' # str | (optional) since_date = 'since_date_example' # str | (optional) start = 789 # int | (optional) count = 56 # int | (optional) locator = 'locator_example' # str | (optional) fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.serve_builds(project_locator, bt_locator, status=status, triggered_by_user=triggered_by_user, include_personal=include_personal, include_canceled=include_canceled, only_pinned=only_pinned, tag=tag, agent_name=agent_name, since_build=since_build, since_date=since_date, start=start, count=count, locator=locator, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->serve_builds: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **bt_locator** - **str** - * - **status** - **str** - [optional] * - **triggered_by_user** - **str** - [optional] * - **include_personal** - **bool** - [optional] * - **include_canceled** - **bool** - [optional] * - **only_pinned** - **bool** - [optional] * - **tag** - `list[str] <../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 <#>`_ .. _serve_project: serve_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')) project_locator = 'project_locator_example' # str | fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.serve_project(project_locator, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->serve_project: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **fields** - **str** - [optional] Return type: `Project <../models/Project.html>`_ `Back to top <#>`_ .. _serve_project_field: serve_project_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')) project_locator = 'project_locator_example' # str | field = 'field_example' # str | try: api_response = tc.project_api.serve_project_field(project_locator, field) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->serve_project_field: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **field** - **str** - Return type: **str** `Back to top <#>`_ .. _serve_projects: serve_projects ----------------- .. 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.project_api.serve_projects(locator=locator, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->serve_projects: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **locator** - **str** - [optional] * - **fields** - **str** - [optional] Return type: `Projects <../models/Projects.html>`_ `Back to top <#>`_ .. _serve_templates_in_project: serve_templates_in_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')) project_locator = 'project_locator_example' # str | fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.serve_templates_in_project(project_locator, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->serve_templates_in_project: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **fields** - **str** - [optional] Return type: `BuildTypes <../models/BuildTypes.html>`_ `Back to top <#>`_ .. _set_build_types_order: set_build_types_order ----------------- .. 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')) project_locator = 'project_locator_example' # str | field = 'field_example' # str | body = dohq_teamcity.BuildTypes() # BuildTypes | (optional) try: api_response = tc.project_api.set_build_types_order(project_locator, field, body=body) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->set_build_types_order: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **field** - **str** - * - **body** - `BuildTypes <../models/BuildTypes.html>`_ - [optional] Return type: `BuildTypes <../models/BuildTypes.html>`_ `Back to top <#>`_ .. _set_default_template: set_default_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')) project_locator = 'project_locator_example' # str | body = dohq_teamcity.BuildType() # BuildType | (optional) fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.set_default_template(project_locator, body=body, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->set_default_template: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **body** - `BuildType <../models/BuildType.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: `BuildType <../models/BuildType.html>`_ `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')) project_locator = 'project_locator_example' # str | body = dohq_teamcity.ModelProperty() # ModelProperty | (optional) fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.set_parameter(project_locator, body=body, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->set_parameter: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_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 | project_locator = 'project_locator_example' # str | body = dohq_teamcity.ModelProperty() # ModelProperty | (optional) fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.set_parameter_0(name, project_locator, body=body, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->set_parameter_0: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **project_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')) feature_locator = 'feature_locator_example' # str | project_locator = 'project_locator_example' # str | body = dohq_teamcity.ModelProperty() # ModelProperty | (optional) fields = 'fields_example' # str | (optional) fields2 = 'fields_example' # str | (optional) try: api_response = tc.project_api.set_parameter_1(feature_locator, project_locator, body=body, fields=fields, fields2=fields2) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->set_parameter_1: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **feature_locator** - **str** - * - **project_locator** - **str** - * - **body** - `ModelProperty <../models/ModelProperty.html>`_ - [optional] * - **fields** - **str** - [optional] * - **fields2** - **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 | feature_locator = 'feature_locator_example' # str | project_locator = 'project_locator_example' # str | body = dohq_teamcity.ModelProperty() # ModelProperty | (optional) fields = 'fields_example' # str | (optional) fields2 = 'fields_example' # str | (optional) try: api_response = tc.project_api.set_parameter_2(name, feature_locator, project_locator, body=body, fields=fields, fields2=fields2) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->set_parameter_2: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **feature_locator** - **str** - * - **project_locator** - **str** - * - **body** - `ModelProperty <../models/ModelProperty.html>`_ - [optional] * - **fields** - **str** - [optional] * - **fields2** - **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 | project_locator = 'project_locator_example' # str | body = dohq_teamcity.Type() # Type | (optional) try: api_response = tc.project_api.set_parameter_type(name, project_locator, body=body) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->set_parameter_type: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **project_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 | project_locator = 'project_locator_example' # str | body = 'body_example' # str | (optional) try: api_response = tc.project_api.set_parameter_type_raw_value(name, project_locator, body=body) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->set_parameter_type_raw_value: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **project_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 | project_locator = 'project_locator_example' # str | body = 'body_example' # str | (optional) try: api_response = tc.project_api.set_parameter_value_long(name, project_locator, body=body) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->set_parameter_value_long: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **project_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 | feature_locator = 'feature_locator_example' # str | project_locator = 'project_locator_example' # str | body = 'body_example' # str | (optional) fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.set_parameter_value_long_0(name, feature_locator, project_locator, body=body, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->set_parameter_value_long_0: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **name** - **str** - * - **feature_locator** - **str** - * - **project_locator** - **str** - * - **body** - **str** - [optional] * - **fields** - **str** - [optional] Return type: **str** `Back to top <#>`_ .. _set_parameters: 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')) project_locator = 'project_locator_example' # str | body = dohq_teamcity.Properties() # Properties | (optional) fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.set_parameters(project_locator, body=body, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->set_parameters: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_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')) feature_locator = 'feature_locator_example' # str | project_locator = 'project_locator_example' # str | body = dohq_teamcity.Properties() # Properties | (optional) fields = 'fields_example' # str | (optional) fields2 = 'fields_example' # str | (optional) try: api_response = tc.project_api.set_parameters_0(feature_locator, project_locator, body=body, fields=fields, fields2=fields2) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->set_parameters_0: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **feature_locator** - **str** - * - **project_locator** - **str** - * - **body** - `Properties <../models/Properties.html>`_ - [optional] * - **fields** - **str** - [optional] * - **fields2** - **str** - [optional] Return type: `Properties <../models/Properties.html>`_ `Back to top <#>`_ .. _set_parent_project: set_parent_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')) project_locator = 'project_locator_example' # str | body = dohq_teamcity.Project() # Project | (optional) fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.set_parent_project(project_locator, body=body, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->set_parent_project: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **body** - `Project <../models/Project.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: `Project <../models/Project.html>`_ `Back to top <#>`_ .. _set_project_agent_pools: set_project_agent_pools ----------------- .. 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')) project_locator = 'project_locator_example' # str | body = dohq_teamcity.AgentPools() # AgentPools | (optional) fields = 'fields_example' # str | (optional) try: api_response = tc.project_api.set_project_agent_pools(project_locator, body=body, fields=fields) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->set_project_agent_pools: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **body** - `AgentPools <../models/AgentPools.html>`_ - [optional] * - **fields** - **str** - [optional] Return type: `AgentPools <../models/AgentPools.html>`_ `Back to top <#>`_ .. _set_project_agent_pools_0: set_project_agent_pools_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')) project_locator = 'project_locator_example' # str | body = dohq_teamcity.AgentPool() # AgentPool | (optional) try: api_response = tc.project_api.set_project_agent_pools_0(project_locator, body=body) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->set_project_agent_pools_0: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **body** - `AgentPool <../models/AgentPool.html>`_ - [optional] Return type: `AgentPool <../models/AgentPool.html>`_ `Back to top <#>`_ .. _set_project_field: set_project_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')) project_locator = 'project_locator_example' # str | field = 'field_example' # str | body = 'body_example' # str | (optional) try: api_response = tc.project_api.set_project_field(project_locator, field, body=body) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->set_project_field: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **field** - **str** - * - **body** - **str** - [optional] Return type: **str** `Back to top <#>`_ .. _set_projects_order: set_projects_order ----------------- .. 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')) project_locator = 'project_locator_example' # str | field = 'field_example' # str | body = dohq_teamcity.Projects() # Projects | (optional) try: api_response = tc.project_api.set_projects_order(project_locator, field, body=body) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->set_projects_order: %s\n" % e) .. list-table:: :widths: 20 20 60 :header-rows: 1 * - Name - Types - Notes * - **project_locator** - **str** - * - **field** - **str** - * - **body** - `Projects <../models/Projects.html>`_ - [optional] Return type: `Projects <../models/Projects.html>`_ `Back to top <#>`_