ProjectApi.md

\ProjectApi

All URIs are relative to https://teamcity.jetbrains.com

Method	HTTP request	Description
AddAgentPoolsProject	Post /app/rest/projects/{projectLocator}/agentPools	Assign the matching project to the agent pool.
AddBuildType	Post /app/rest/projects/{projectLocator}/buildTypes	Add a build configuration to the matching project.
AddFeature	Post /app/rest/projects/{projectLocator}/projectFeatures	Add a feature.
AddProject	Post /app/rest/projects	Create a new project.
AddSecureToken	Post /app/rest/projects/{projectLocator}/secure/tokens	Create a new secure token for the matching project.
AddTemplate	Post /app/rest/projects/{projectLocator}/templates	Add a build configuration template to the matching project.
CreateBuildParameter	Post /app/rest/projects/{projectLocator}/parameters	Create a build parameter.
DeleteBuildParameter	Delete /app/rest/projects/{projectLocator}/parameters/{name}	Delete build parameter.
DeleteBuildParameters	Delete /app/rest/projects/{projectLocator}/parameters	Delete all build parameters.
DeleteFeature	Delete /app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}	Delete a matching feature.
DeleteProject	Delete /app/rest/projects/{projectLocator}	Delete project matching the locator.
GetAgentPoolsProject	Get /app/rest/projects/{projectLocator}/agentPools	Get agent pools appointed to the matching project.
GetAllBranches	Get /app/rest/projects/{projectLocator}/branches	Get all branches of the matching project.
GetAllBuildTypesOrdered	Get /app/rest/projects/{projectLocator}/order/buildTypes	Get all build configurations from the matching project, with custom ordering applied.
GetAllProjects	Get /app/rest/projects	Get all projects.
GetAllSubprojectsOrdered	Get /app/rest/projects/{projectLocator}/order/projects	Get all subprojects of the matching project, with custom ordering applied.
GetBuildParameter	Get /app/rest/projects/{projectLocator}/parameters/{name}	Get build parameter.
GetBuildParameterSpecification	Get /app/rest/projects/{projectLocator}/parameters/{name}/type/rawValue	Get build parameter specification.
GetBuildParameterType	Get /app/rest/projects/{projectLocator}/parameters/{name}/type	Get type of build parameter.
GetBuildParameterValue	Get /app/rest/projects/{projectLocator}/parameters/{name}/value	Get value of build parameter.
GetBuildParameters	Get /app/rest/projects/{projectLocator}/parameters	Get build parameters.
GetDefaultTemplate	Get /app/rest/projects/{projectLocator}/defaultTemplate	Get the default template of the matching project.
GetFeature	Get /app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}	Get a matching feature.
GetFeatures	Get /app/rest/projects/{projectLocator}/projectFeatures	Get all features.
GetProject	Get /app/rest/projects/{projectLocator}	Get project matching the locator.
GetProjectField	Get /app/rest/projects/{projectLocator}/{field}	Get a field of the matching project.
GetProjectParentProject	Get /app/rest/projects/{projectLocator}/parentProject	Get the parent project of the matching project.
GetProjectSettingsFile	Get /app/rest/projects/{projectLocator}/settingsFile	Get the settings file of the matching build configuration.
GetProjectTemplates	Get /app/rest/projects/{projectLocator}/templates	Get all templates of the matching project.
GetSecureValue	Get /app/rest/projects/{projectLocator}/secure/values/{token}	Get a secure token of the matching project.
RemoveDefaultTemplate	Delete /app/rest/projects/{projectLocator}/defaultTemplate	Remove the default template from the matching project.
RemoveProjectFromAgentPool	Delete /app/rest/projects/{projectLocator}/agentPools/{agentPoolLocator}	Unassign a project from the matching agent pool.
SetAgentPoolsProject	Put /app/rest/projects/{projectLocator}/agentPools	Update agent pools apppointed to the matching project.
SetBuildTypesOrder	Put /app/rest/projects/{projectLocator}/order/buildTypes	Update custom ordering of build configurations of the matching project.
SetDefaultTemplate	Put /app/rest/projects/{projectLocator}/defaultTemplate	Update the default template of the matching project.
SetParentProject	Put /app/rest/projects/{projectLocator}/parentProject	Update the parent project of the matching project.
SetProjectField	Put /app/rest/projects/{projectLocator}/{field}	Update a field of the matching project.
SetSubprojectsOrder	Put /app/rest/projects/{projectLocator}/order/projects	Update custom ordering of subprojects of the matching project.
UpdateBuildParameter	Put /app/rest/projects/{projectLocator}/parameters/{name}	Update build parameter.
UpdateBuildParameterSpecification	Put /app/rest/projects/{projectLocator}/parameters/{name}/type/rawValue	Update build parameter specification.
UpdateBuildParameterType	Put /app/rest/projects/{projectLocator}/parameters/{name}/type	Update type of build parameter.
UpdateBuildParameterValue	Put /app/rest/projects/{projectLocator}/parameters/{name}/value	Update value of build parameter.
UpdateBuildParameters	Put /app/rest/projects/{projectLocator}/parameters	Update build parameters.
UpdateFeature	Put /app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}	Update a matching feature.
UpdateFeatures	Put /app/rest/projects/{projectLocator}/projectFeatures	Update all features.

AddAgentPoolsProject

AgentPool AddAgentPoolsProject(ctx, projectLocator, optional) Assign the matching project to the agent pool.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*AddAgentPoolsProjectOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a AddAgentPoolsProjectOpts struct

Name	Type	Description	Notes

body | optional.Interface of AgentPool| |

Return type

AgentPool

Authorization

No authorization required

HTTP request headers

• Content-Type: application/xml, application/json
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddBuildType

BuildType AddBuildType(ctx, projectLocator, optional) Add a build configuration to the matching project.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*AddBuildTypeOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a AddBuildTypeOpts struct

Name	Type	Description	Notes

body | optional.Interface of NewBuildTypeDescription| | fields | optional.String| |

Return type

BuildType

Authorization

No authorization required

HTTP request headers

• Content-Type: application/xml, application/json
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddFeature

interface{} AddFeature(ctx, projectLocator, optional) Add a feature.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*AddFeatureOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a AddFeatureOpts struct

Name	Type	Description	Notes

body | optional.Interface of ProjectFeature| | fields | optional.String| |

Return type

interface{}

Authorization

No authorization required

HTTP request headers

• Content-Type: application/xml, application/json
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddProject

Project AddProject(ctx, optional) Create a new project.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*AddProjectOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a AddProjectOpts struct

Name	Type	Description	Notes
body	optional.Interface of NewProjectDescription

Return type

Project

Authorization

No authorization required

HTTP request headers

• Content-Type: application/xml, application/json
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddSecureToken

string AddSecureToken(ctx, projectLocator, optional) Create a new secure token for the matching project.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*AddSecureTokenOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a AddSecureTokenOpts struct

Name	Type	Description	Notes

body | optional.String| |

Return type

string

Authorization

No authorization required

HTTP request headers

• Content-Type: text/plain
• Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddTemplate

BuildType AddTemplate(ctx, projectLocator, optional) Add a build configuration template to the matching project.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*AddTemplateOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a AddTemplateOpts struct

Name	Type	Description	Notes

body | optional.Interface of NewBuildTypeDescription| | fields | optional.String| |

Return type

BuildType

Authorization

No authorization required

HTTP request headers

• Content-Type: application/xml, application/json
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateBuildParameter

Property CreateBuildParameter(ctx, projectLocator, optional) Create a build parameter.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*CreateBuildParameterOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateBuildParameterOpts struct

Name	Type	Description	Notes

body | optional.Interface of Property| | fields | optional.String| |

Return type

Property

Authorization

No authorization required

HTTP request headers

• Content-Type: application/xml, application/json
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteBuildParameter

DeleteBuildParameter(ctx, name, projectLocator) Delete build parameter.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
name	string
projectLocator	string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteBuildParameters

DeleteBuildParameters(ctx, projectLocator) Delete all build parameters.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteFeature

DeleteFeature(ctx, featureLocator, projectLocator) Delete a matching feature.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
featureLocator	string
projectLocator	string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteProject

DeleteProject(ctx, projectLocator) Delete project matching the locator.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAgentPoolsProject

AgentPools GetAgentPoolsProject(ctx, projectLocator, optional) Get agent pools appointed to the matching project.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*GetAgentPoolsProjectOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAgentPoolsProjectOpts struct

Name	Type	Description	Notes

fields | optional.String| |

Return type

AgentPools

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllBranches

Branches GetAllBranches(ctx, projectLocator, optional) Get all branches of the matching project.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*GetAllBranchesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAllBranchesOpts struct

Name	Type	Description	Notes

locator | optional.String| | fields | optional.String| |

Return type

Branches

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllBuildTypesOrdered

BuildTypes GetAllBuildTypesOrdered(ctx, projectLocator, optional) Get all build configurations from the matching project, with custom ordering applied.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*GetAllBuildTypesOrderedOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAllBuildTypesOrderedOpts struct

Name	Type	Description	Notes

field | optional.String| |

Return type

BuildTypes

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllProjects

Projects GetAllProjects(ctx, optional) Get all projects.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetAllProjectsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAllProjectsOpts struct

Name	Type	Description	Notes
locator	optional.String
fields	optional.String

Return type

Projects

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllSubprojectsOrdered

Projects GetAllSubprojectsOrdered(ctx, projectLocator, optional) Get all subprojects of the matching project, with custom ordering applied.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*GetAllSubprojectsOrderedOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAllSubprojectsOrderedOpts struct

Name	Type	Description	Notes

field | optional.String| |

Return type

Projects

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBuildParameter

Property GetBuildParameter(ctx, name, projectLocator, optional) Get build parameter.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
name	string
projectLocator	string
optional	*GetBuildParameterOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetBuildParameterOpts struct

Name	Type	Description	Notes

fields | optional.String| |

Return type

Property

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBuildParameterSpecification

string GetBuildParameterSpecification(ctx, name, projectLocator) Get build parameter specification.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
name	string
projectLocator	string

Return type

string

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBuildParameterType

ModelType GetBuildParameterType(ctx, name, projectLocator) Get type of build parameter.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
name	string
projectLocator	string

Return type

ModelType

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBuildParameterValue

string GetBuildParameterValue(ctx, name, projectLocator) Get value of build parameter.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
name	string
projectLocator	string

Return type

string

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBuildParameters

Properties GetBuildParameters(ctx, projectLocator, optional) Get build parameters.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*GetBuildParametersOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetBuildParametersOpts struct

Name	Type	Description	Notes

locator | optional.String| | fields | optional.String| |

Return type

Properties

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDefaultTemplate

BuildType GetDefaultTemplate(ctx, projectLocator, optional) Get the default template of the matching project.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*GetDefaultTemplateOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetDefaultTemplateOpts struct

Name	Type	Description	Notes

fields | optional.String| |

Return type

BuildType

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetFeature

interface{} GetFeature(ctx, featureLocator, projectLocator, optional) Get a matching feature.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
featureLocator	string
projectLocator	string
optional	*GetFeatureOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetFeatureOpts struct

Name	Type	Description	Notes

fields | optional.String| |

Return type

interface{}

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetFeatures

interface{} GetFeatures(ctx, projectLocator, optional) Get all features.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*GetFeaturesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetFeaturesOpts struct

Name	Type	Description	Notes

locator | optional.String| | fields | optional.String| |

Return type

interface{}

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetProject

Project GetProject(ctx, projectLocator, optional) Get project matching the locator.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*GetProjectOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetProjectOpts struct

Name	Type	Description	Notes

fields | optional.String| |

Return type

Project

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetProjectField

string GetProjectField(ctx, projectLocator, field) Get a field of the matching project.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
field	string

Return type

string

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetProjectParentProject

Project GetProjectParentProject(ctx, projectLocator, optional) Get the parent project of the matching project.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*GetProjectParentProjectOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetProjectParentProjectOpts struct

Name	Type	Description	Notes

fields | optional.String| |

Return type

Project

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetProjectSettingsFile

string GetProjectSettingsFile(ctx, projectLocator) Get the settings file of the matching build configuration.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string

Return type

string

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetProjectTemplates

BuildTypes GetProjectTemplates(ctx, projectLocator, optional) Get all templates of the matching project.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*GetProjectTemplatesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetProjectTemplatesOpts struct

Name	Type	Description	Notes

fields | optional.String| |

Return type

BuildTypes

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSecureValue

string GetSecureValue(ctx, projectLocator, token) Get a secure token of the matching project.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
token	string

Return type

string

Authorization

No authorization required

HTTP request headers

• Content-Type: text/plain
• Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveDefaultTemplate

RemoveDefaultTemplate(ctx, projectLocator, optional) Remove the default template from the matching project.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*RemoveDefaultTemplateOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RemoveDefaultTemplateOpts struct

Name	Type	Description	Notes

fields | optional.String| |

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveProjectFromAgentPool

RemoveProjectFromAgentPool(ctx, projectLocator, agentPoolLocator) Unassign a project from the matching agent pool.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
agentPoolLocator	string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetAgentPoolsProject

AgentPools SetAgentPoolsProject(ctx, projectLocator, optional) Update agent pools apppointed to the matching project.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*SetAgentPoolsProjectOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SetAgentPoolsProjectOpts struct

Name	Type	Description	Notes

body | optional.Interface of AgentPools| | fields | optional.String| |

Return type

AgentPools

Authorization

No authorization required

HTTP request headers

• Content-Type: application/xml, application/json
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetBuildTypesOrder

BuildTypes SetBuildTypesOrder(ctx, projectLocator, optional) Update custom ordering of build configurations of the matching project.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*SetBuildTypesOrderOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SetBuildTypesOrderOpts struct

Name	Type	Description	Notes

body | optional.Interface of BuildTypes| | field | optional.String| |

Return type

BuildTypes

Authorization

No authorization required

HTTP request headers

• Content-Type: application/xml, application/json
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetDefaultTemplate

BuildType SetDefaultTemplate(ctx, projectLocator, optional) Update the default template of the matching project.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*SetDefaultTemplateOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SetDefaultTemplateOpts struct

Name	Type	Description	Notes

body | optional.Interface of BuildType| | fields | optional.String| |

Return type

BuildType

Authorization

No authorization required

HTTP request headers

• Content-Type: application/xml, application/json
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetParentProject

Project SetParentProject(ctx, projectLocator, optional) Update the parent project of the matching project.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*SetParentProjectOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SetParentProjectOpts struct

Name	Type	Description	Notes

body | optional.Interface of Project| | fields | optional.String| |

Return type

Project

Authorization

No authorization required

HTTP request headers

• Content-Type: application/xml, application/json
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetProjectField

string SetProjectField(ctx, projectLocator, field, optional) Update a field of the matching project.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
field	string
optional	*SetProjectFieldOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SetProjectFieldOpts struct

Name	Type	Description	Notes

body | optional.String| |

Return type

string

Authorization

No authorization required

HTTP request headers

• Content-Type: text/plain
• Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetSubprojectsOrder

Projects SetSubprojectsOrder(ctx, projectLocator, optional) Update custom ordering of subprojects of the matching project.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*SetSubprojectsOrderOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SetSubprojectsOrderOpts struct

Name	Type	Description	Notes

body | optional.Interface of Projects| | field | optional.String| |

Return type

Projects

Authorization

No authorization required

HTTP request headers

• Content-Type: application/xml, application/json
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateBuildParameter

Property UpdateBuildParameter(ctx, name, projectLocator, optional) Update build parameter.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
name	string
projectLocator	string
optional	*UpdateBuildParameterOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UpdateBuildParameterOpts struct

Name	Type	Description	Notes

body | optional.Interface of Property| | fields | optional.String| |

Return type

Property

Authorization

No authorization required

HTTP request headers

• Content-Type: application/xml, application/json
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateBuildParameterSpecification

string UpdateBuildParameterSpecification(ctx, name, projectLocator, optional) Update build parameter specification.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
name	string
projectLocator	string
optional	*UpdateBuildParameterSpecificationOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UpdateBuildParameterSpecificationOpts struct

Name	Type	Description	Notes

body | optional.String| |

Return type

string

Authorization

No authorization required

HTTP request headers

• Content-Type: text/plain
• Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateBuildParameterType

ModelType UpdateBuildParameterType(ctx, name, projectLocator, optional) Update type of build parameter.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
name	string
projectLocator	string
optional	*UpdateBuildParameterTypeOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UpdateBuildParameterTypeOpts struct

Name	Type	Description	Notes

body | optional.Interface of ModelType| |

Return type

ModelType

Authorization

No authorization required

HTTP request headers

• Content-Type: application/xml, application/json
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateBuildParameterValue

string UpdateBuildParameterValue(ctx, name, projectLocator, optional) Update value of build parameter.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
name	string
projectLocator	string
optional	*UpdateBuildParameterValueOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UpdateBuildParameterValueOpts struct

Name	Type	Description	Notes

body | optional.String| |

Return type

string

Authorization

No authorization required

HTTP request headers

• Content-Type: text/plain
• Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateBuildParameters

Properties UpdateBuildParameters(ctx, projectLocator, optional) Update build parameters.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*UpdateBuildParametersOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UpdateBuildParametersOpts struct

Name	Type	Description	Notes

body | optional.Interface of Properties| | fields | optional.String| |

Return type

Properties

Authorization

No authorization required

HTTP request headers

• Content-Type: application/xml, application/json
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateFeature

interface{} UpdateFeature(ctx, featureLocator, projectLocator, optional) Update a matching feature.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
featureLocator	string
projectLocator	string
optional	*UpdateFeatureOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UpdateFeatureOpts struct

Name	Type	Description	Notes

body | optional.Interface of ProjectFeature| | fields | optional.String| |

Return type

interface{}

Authorization

No authorization required

HTTP request headers

• Content-Type: application/xml, application/json
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateFeatures

interface{} UpdateFeatures(ctx, projectLocator, optional) Update all features.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectLocator	string
optional	*UpdateFeaturesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UpdateFeaturesOpts struct

Name	Type	Description	Notes

body | optional.Interface of ProjectFeatures| | fields | optional.String| |

Return type

interface{}

Authorization

No authorization required

HTTP request headers

• Content-Type: application/xml, application/json
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]