Releases - Update Release
Update a complete release object.
PUT https://{instance}/{collection}/{project}/_apis/release/releases/{releaseId}?api-version=4.1-preview.6
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
collection
|
path | True |
string |
The name of the Team Foundation Server collection. |
instance
|
path | True |
string |
TFS server name ({server:port}) |
project
|
path | True |
string |
Project ID or project name |
release
|
path | True |
integer int32 |
Id of the release to update. |
api-version
|
query | True |
string |
Version of the API to use. This should be set to '4.1-preview.6' to use this version of the api. |
Request Body
Name | Type | Description |
---|---|---|
_links |
Gets links to access the release. |
|
artifacts |
Artifact[] |
Gets or sets the list of artifacts. |
comment |
string |
Gets or sets comment. |
createdBy |
Gets or sets the identity who created. |
|
createdOn |
string |
Gets date on which it got created. |
definitionSnapshotRevision |
integer |
Gets revision number of definition snapshot. |
description |
string |
Gets or sets description of release. |
environments |
Gets list of environments. |
|
id |
integer |
Gets the unique identifier of this field. |
keepForever |
boolean |
Whether to exclude the release from retention policies. |
logsContainerUrl |
string |
Gets logs container url. |
modifiedBy |
Gets or sets the identity who modified. |
|
modifiedOn |
string |
Gets date on which it got modified. |
name |
string |
Gets name. |
poolName |
string |
Gets pool name. |
projectReference |
Gets or sets project reference. |
|
properties |
The class represents a property bag as a collection of key-value pairs. Values of all primitive types (any type with a |
|
reason |
Gets reason of release. |
|
releaseDefinition |
Gets releaseDefinitionReference which specifies the reference of the release definition to which this release is associated. |
|
releaseNameFormat |
string |
Gets release name format. |
status |
Gets status. |
|
tags |
string[] |
Gets or sets list of tags. |
triggeringArtifactAlias |
string |
|
variableGroups |
Gets the list of variable groups. |
|
variables |
<string,
Configuration |
Gets or sets the dictionary of variables. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
successful operation |
Security
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Scopes
Name | Description |
---|---|
vso.release_execute | Grants the ability to read and update release artifacts, including releases, release definitions and release envrionment, and the ability to queue a new release. |
Definitions
ApprovalExecutionOrder
Name | Type | Description |
---|---|---|
afterGatesAlways |
string |
|
afterSuccessfulGates |
string |
|
beforeGates |
string |
ApprovalOptions
Name | Type | Description |
---|---|---|
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped |
boolean |
|
enforceIdentityRevalidation |
boolean |
|
executionOrder | ||
releaseCreatorCanBeApprover |
boolean |
|
requiredApproverCount |
integer |
|
timeoutInMinutes |
integer |
ApprovalStatus
Gets or sets the status of the approval.
Name | Type | Description |
---|---|---|
approved |
string |
|
canceled |
string |
|
pending |
string |
|
reassigned |
string |
|
rejected |
string |
|
skipped |
string |
|
undefined |
string |
ApprovalType
Gets or sets the type of approval.
Name | Type | Description |
---|---|---|
all |
string |
|
postDeploy |
string |
|
preDeploy |
string |
|
undefined |
string |
Artifact
Name | Type | Description |
---|---|---|
alias |
string |
Gets or sets alias. |
definitionReference |
<string,
Artifact |
Gets or sets definition reference. e.g. {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}} |
isPrimary |
boolean |
Gets or sets as artifact is primary or not. |
type |
string |
Gets or sets type. It can have value as 'Build', 'Jenkins', 'GitHub', 'Nuget', 'Team Build (external)', 'ExternalTFSBuild', 'Git', 'TFVC', 'ExternalTfsXamlBuild'. |
ArtifactSourceReference
Name | Type | Description |
---|---|---|
id |
string |
|
name |
string |
AuthorizationHeader
Name | Type | Description |
---|---|---|
name |
string |
|
value |
string |
ConditionType
Gets or sets the condition type.
Name | Type | Description |
---|---|---|
artifact |
string |
The condition type is artifact. |
environmentState |
string |
The condition type is environment state. |
event |
string |
The condition type is event. |
undefined |
string |
The condition type is undefined. |
ConfigurationVariableValue
Name | Type | Description |
---|---|---|
isSecret |
boolean |
Gets or sets as variable is secret or not. |
value |
string |
Gets or sets value of the configuration variable. |
DataSourceBindingBase
Represents binding of data source for the service endpoint request.
Name | Type | Description |
---|---|---|
dataSourceName |
string |
Gets or sets the name of the data source. |
endpointId |
string |
Gets or sets the endpoint Id. |
endpointUrl |
string |
Gets or sets the url of the service endpoint. |
headers |
Gets or sets the authorization headers. |
|
parameters |
object |
Gets or sets the parameters for the data source. |
resultSelector |
string |
Gets or sets the result selector. |
resultTemplate |
string |
Gets or sets the result template. |
target |
string |
Gets or sets the target of the data source. |
Demand
Name | Type | Description |
---|---|---|
name |
string |
|
value |
string |
DeploymentAttempt
Name | Type | Description |
---|---|---|
attempt |
integer |
|
deploymentId |
integer |
|
hasStarted |
boolean |
Specifies whether deployment has started or not |
id |
integer |
|
issues |
Issue[] |
All the issues related to the deployment |
job | ||
lastModifiedBy | ||
lastModifiedOn |
string |
|
operationStatus | ||
postDeploymentGates | ||
preDeploymentGates | ||
queuedOn |
string |
|
reason | ||
releaseDeployPhases | ||
requestedBy | ||
requestedFor | ||
runPlanId |
string |
|
status | ||
tasks |
DeploymentJob
Name | Type | Description |
---|---|---|
job | ||
tasks |
DeploymentOperationStatus
Gets operation status of deployment.
Name | Type | Description |
---|---|---|
all |
string |
The deployment operation status is all. |
approved |
string |
The deployment operation status is approved. |
canceled |
string |
The deployment operation status is canceled. |
cancelling |
string |
The deployment operation status is cancelling. |
deferred |
string |
The deployment operation status is deferred. |
evaluatingGates |
string |
The deployment operation status is EvaluatingGates. |
gateFailed |
string |
The deployment operation status is GateFailed. |
manualInterventionPending |
string |
The deployment operation status is manualintervention pending. |
pending |
string |
The deployment operation status is pending. |
phaseCanceled |
string |
The deployment operation status is phase canceled. |
phaseFailed |
string |
The deployment operation status is phase failed. |
phaseInProgress |
string |
The deployment operation status is phase inprogress. |
phasePartiallySucceeded |
string |
The deployment operation status is phase partially succeeded. |
phaseSucceeded |
string |
The deployment operation status is phase succeeded. |
queued |
string |
The deployment operation status is queued. |
queuedForAgent |
string |
The deployment operation status is queued for agent. |
queuedForPipeline |
string |
The deployment operation status is queued for pipeline. |
rejected |
string |
The deployment operation status is rejected. |
scheduled |
string |
The deployment operation status is scheduled. |
undefined |
string |
The deployment operation status is undefined. |
DeploymentReason
Gets reason of deployment.
Name | Type | Description |
---|---|---|
automated |
string |
The deployment reason is automated. |
manual |
string |
The deployment reason is manual. |
none |
string |
The deployment reason is none. |
scheduled |
string |
The deployment reason is scheduled. |
DeploymentStatus
Gets status of the deployment.
Name | Type | Description |
---|---|---|
all |
string |
The deployment status is all. |
failed |
string |
The deployment status is failed. |
inProgress |
string |
The deployment status is inprogress. |
notDeployed |
string |
The deployment status is not deployed. |
partiallySucceeded |
string |
The deployment status is partiallysucceeded. |
succeeded |
string |
The deployment status is succeeded. |
undefined |
string |
The deployment status is undefined. |
DeployPhase
Name | Type | Description |
---|---|---|
name |
string |
|
phaseType | ||
rank |
integer |
|
workflowTasks |
DeployPhaseStatus
Name | Type | Description |
---|---|---|
canceled |
string |
|
cancelling |
string |
|
failed |
string |
|
inProgress |
string |
|
notStarted |
string |
|
partiallySucceeded |
string |
|
skipped |
string |
|
succeeded |
string |
|
undefined |
string |
DeployPhaseTypes
Name | Type | Description |
---|---|---|
agentBasedDeployment |
string |
|
machineGroupBasedDeployment |
string |
|
runOnServer |
string |
|
undefined |
string |
EnvironmentOptions
Name | Type | Description |
---|---|---|
autoLinkWorkItems |
boolean |
|
badgeEnabled |
boolean |
|
emailNotificationType |
string |
|
emailRecipients |
string |
|
enableAccessToken |
boolean |
|
publishDeploymentStatus |
boolean |
|
skipArtifactsDownload |
boolean |
|
timeoutInMinutes |
integer |
EnvironmentStatus
Gets environment status.
Name | Type | Description |
---|---|---|
canceled |
string |
|
inProgress |
string |
|
notStarted |
string |
|
partiallySucceeded |
string |
|
queued |
string |
|
rejected |
string |
|
scheduled |
string |
|
succeeded |
string |
|
undefined |
string |
GateStatus
Name | Type | Description |
---|---|---|
failed |
string |
|
inProgress |
string |
|
none |
string |
|
pending |
string |
|
succeeded |
string |
IdentityRef
Name | Type | Description |
---|---|---|
_links |
This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. |
|
descriptor |
string |
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Collections. |
directoryAlias |
string |
|
displayName |
string |
This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider. |
id |
string |
|
imageUrl |
string |
|
inactive |
boolean |
|
isAadIdentity |
boolean |
|
isContainer |
boolean |
|
profileUrl |
string |
|
uniqueName |
string |
|
url |
string |
This url is the full route to the source resource of this graph subject. |
Issue
Name | Type | Description |
---|---|---|
issueType |
string |
|
message |
string |
ManualIntervention
Name | Type | Description |
---|---|---|
approver |
Gets or sets the identity who should approve. |
|
comments |
string |
Gets or sets comments for approval. |
createdOn |
string |
Gets date on which it got created. |
id |
integer |
Gets the unique identifier for manual intervention. |
instructions |
string |
Gets or sets instructions for approval. |
modifiedOn |
string |
Gets date on which it got modified. |
name |
string |
Gets or sets the name. |
release |
Gets releaseReference for manual intervention. |
|
releaseDefinition |
Gets releaseDefinitionReference for manual intervention. |
|
releaseEnvironment |
Gets releaseEnvironmentReference for manual intervention. |
|
status |
Gets or sets the status of the manual intervention. |
|
taskInstanceId |
string |
Get task instance identifier. |
url |
string |
Gets url to access the manual intervention. |
ManualInterventionStatus
Gets or sets the status of the manual intervention.
Name | Type | Description |
---|---|---|
approved |
string |
The manual intervention is approved. |
canceled |
string |
The manual intervention is canceled. |
pending |
string |
The manual intervention is pending. |
rejected |
string |
The manual intervention is rejected. |
unknown |
string |
The manual intervention does not have the status set. |
ProcessParameters
Name | Type | Description |
---|---|---|
dataSourceBindings |
Represents binding of data source for the service endpoint request. |
|
inputs | ||
sourceDefinitions |
ProjectReference
Name | Type | Description |
---|---|---|
id |
string |
Gets the unique identifier of this field. |
name |
string |
Gets name of project. |
PropertiesCollection
The class represents a property bag as a collection of key-value pairs. Values of all primitive types (any type with a TypeCode != TypeCode.Object
) except for DBNull
are accepted. Values of type Byte[], Int32, Double, DateType and String preserve their type, other primitives are retuned as a String. Byte[] expected as base64 encoded string.
Name | Type | Description |
---|---|---|
count |
integer |
The count of properties in the collection. |
item |
object |
|
keys |
string[] |
The set of keys in the collection. |
values |
string[] |
The set of values in the collection. |
ReferenceLinks
The class to represent a collection of REST reference links.
Name | Type | Description |
---|---|---|
links |
object |
The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. |
Release
Name | Type | Description |
---|---|---|
_links |
Gets links to access the release. |
|
artifacts |
Artifact[] |
Gets or sets the list of artifacts. |
comment |
string |
Gets or sets comment. |
createdBy |
Gets or sets the identity who created. |
|
createdOn |
string |
Gets date on which it got created. |
definitionSnapshotRevision |
integer |
Gets revision number of definition snapshot. |
description |
string |
Gets or sets description of release. |
environments |
Gets list of environments. |
|
id |
integer |
Gets the unique identifier of this field. |
keepForever |
boolean |
Whether to exclude the release from retention policies. |
logsContainerUrl |
string |
Gets logs container url. |
modifiedBy |
Gets or sets the identity who modified. |
|
modifiedOn |
string |
Gets date on which it got modified. |
name |
string |
Gets name. |
poolName |
string |
Gets pool name. |
projectReference |
Gets or sets project reference. |
|
properties |
The class represents a property bag as a collection of key-value pairs. Values of all primitive types (any type with a |
|
reason |
Gets reason of release. |
|
releaseDefinition |
Gets releaseDefinitionReference which specifies the reference of the release definition to which this release is associated. |
|
releaseNameFormat |
string |
Gets release name format. |
status |
Gets status. |
|
tags |
string[] |
Gets or sets list of tags. |
triggeringArtifactAlias |
string |
|
variableGroups |
Gets the list of variable groups. |
|
variables |
<string,
Configuration |
Gets or sets the dictionary of variables. |
ReleaseApproval
Name | Type | Description |
---|---|---|
approvalType |
Gets or sets the type of approval. |
|
approvedBy |
Gets the identity who approved. |
|
approver |
Gets or sets the identity who should approve. |
|
attempt |
integer |
Gets or sets attempt which specifies as which deployment attempt it belongs. |
comments |
string |
Gets or sets comments for approval. |
createdOn |
string |
Gets date on which it got created. |
history |
Gets history which specifies all approvals associated with this approval. |
|
id |
integer |
Gets the unique identifier of this field. |
isAutomated |
boolean |
Gets or sets as approval is automated or not. |
isNotificationOn |
boolean |
|
modifiedOn |
string |
Gets date on which it got modified. |
rank |
integer |
Gets or sets rank which specifies the order of the approval. e.g. Same rank denotes parallel approval. |
release |
Gets releaseReference which specifies the reference of the release to which this approval is associated. |
|
releaseDefinition |
Gets releaseDefinitionReference which specifies the reference of the release definition to which this approval is associated. |
|
releaseEnvironment |
Gets releaseEnvironmentReference which specifies the reference of the release environment to which this approval is associated. |
|
revision |
integer |
Gets the revision number. |
status |
Gets or sets the status of the approval. |
|
trialNumber |
integer |
|
url |
string |
Gets url to access the approval. |
ReleaseApprovalHistory
Name | Type | Description |
---|---|---|
approver | ||
changedBy | ||
comments |
string |
|
createdOn |
string |
|
modifiedOn |
string |
|
revision |
integer |
ReleaseCondition
Name | Type | Description |
---|---|---|
conditionType |
Gets or sets the condition type. |
|
name |
string |
Gets or sets the name of the condition. e.g. 'ReleaseStarted'. |
result |
boolean |
|
value |
string |
Gets or set value of the condition. |
ReleaseDefinitionApprovals
Name | Type | Description |
---|---|---|
approvalOptions | ||
approvals |
ReleaseDefinitionApprovalStep
Name | Type | Description |
---|---|---|
approver | ||
id |
integer |
|
isAutomated |
boolean |
|
isNotificationOn |
boolean |
|
rank |
integer |
ReleaseDefinitionGate
Name | Type | Description |
---|---|---|
tasks |
ReleaseDefinitionGatesOptions
Name | Type | Description |
---|---|---|
isEnabled |
boolean |
|
samplingInterval |
integer |
|
stabilizationTime |
integer |
|
timeout |
integer |
ReleaseDefinitionGatesStep
Name | Type | Description |
---|---|---|
gates | ||
gatesOptions | ||
id |
integer |
ReleaseDefinitionShallowReference
Name | Type | Description |
---|---|---|
_links |
Gets the links to related resources, APIs, and views for the release definition. |
|
id |
integer |
Gets the unique identifier of release definition. |
name |
string |
Gets or sets the name of the release definition. |
url |
string |
Gets the REST API url to access the release definition. |
ReleaseDeployPhase
Name | Type | Description |
---|---|---|
deploymentJobs | ||
errorLog |
string |
|
id |
integer |
|
manualInterventions | ||
name |
string |
|
phaseId |
string |
|
phaseType | ||
rank |
integer |
|
runPlanId |
string |
|
status |
ReleaseEnvironment
Name | Type | Description |
---|---|---|
conditions |
Gets list of conditions. |
|
createdOn |
string |
Gets date on which it got created. |
definitionEnvironmentId |
integer |
Gets definition environment id. |
demands |
Demand[] |
Gets demands. |
deployPhasesSnapshot |
Gets list of deploy phases snapshot. |
|
deploySteps |
Gets deploy steps. |
|
environmentOptions |
Gets environment options. |
|
id |
integer |
Gets the unique identifier of this field. |
modifiedOn |
string |
Gets date on which it got modified. |
name |
string |
Gets name. |
nextScheduledUtcTime |
string |
Gets next scheduled UTC time. |
owner |
Gets the identity who is owner for release environment. |
|
postApprovalsSnapshot |
Gets list of post deploy approvals snapshot. |
|
postDeployApprovals |
Gets list of post deploy approvals. |
|
postDeploymentGatesSnapshot | ||
preApprovalsSnapshot |
Gets list of pre deploy approvals snapshot. |
|
preDeployApprovals |
Gets list of pre deploy approvals. |
|
preDeploymentGatesSnapshot | ||
processParameters |
Gets process parameters. |
|
queueId |
integer |
Gets queue id. |
rank |
integer |
Gets rank. |
release |
Gets release reference which specifies the reference of the release to which this release environment is associated. |
|
releaseCreatedBy |
Gets the identity who created release. |
|
releaseDefinition |
Gets releaseDefinitionReference which specifies the reference of the release definition to which this release environment is associated. |
|
releaseDescription |
string |
Gets release description. |
releaseId |
integer |
Gets release id. |
scheduledDeploymentTime |
string |
Gets schedule deployment time of release environment. |
schedules |
Gets list of schedules. |
|
status |
Gets environment status. |
|
timeToDeploy |
number |
Gets time to deploy. |
triggerReason |
string |
Gets trigger reason. |
variableGroups |
Gets the list of variable groups. |
|
variables |
<string,
Configuration |
Gets the dictionary of variables. |
workflowTasks |
Gets list of workflow tasks. |
ReleaseEnvironmentShallowReference
Name | Type | Description |
---|---|---|
_links |
Gets the links to related resources, APIs, and views for the release environment. |
|
id |
integer |
Gets the unique identifier of release environment. |
name |
string |
Gets or sets the name of the release environment. |
url |
string |
Gets the REST API url to access the release environment. |
ReleaseGates
Name | Type | Description |
---|---|---|
deploymentJobs | ||
id |
integer |
|
lastModifiedOn |
string |
|
runPlanId |
string |
|
stabilizationCompletedOn |
string |
|
startedOn |
string |
|
status |
ReleaseReason
Gets reason for release.
Name | Type | Description |
---|---|---|
continuousIntegration |
string |
|
manual |
string |
|
none |
string |
|
schedule |
string |
ReleaseSchedule
Name | Type | Description |
---|---|---|
daysToRelease |
Days of the week to release |
|
jobId |
string |
Team Foundation Job Definition Job Id |
startHours |
integer |
Local time zone hour to start |
startMinutes |
integer |
Local time zone minute to start |
timeZoneId |
string |
Time zone Id of release schedule, such as 'UTC' |
ReleaseShallowReference
Name | Type | Description |
---|---|---|
_links |
Gets the links to related resources, APIs, and views for the release. |
|
id |
integer |
Gets the unique identifier of release. |
name |
string |
Gets or sets the name of the release. |
url |
string |
Gets the REST API url to access the release. |
ReleaseStatus
Gets status.
Name | Type | Description |
---|---|---|
abandoned |
string |
|
active |
string |
|
draft |
string |
|
undefined |
string |
ReleaseTask
Name | Type | Description |
---|---|---|
agentName |
string |
|
dateEnded |
string |
|
dateStarted |
string |
|
finishTime |
string |
|
id |
integer |
|
issues |
Issue[] |
|
lineCount |
integer |
|
logUrl |
string |
|
name |
string |
|
percentComplete |
integer |
|
rank |
integer |
|
startTime |
string |
|
status | ||
task | ||
timelineRecordId |
string |
ScheduleDays
Days of the week to release
Name | Type | Description |
---|---|---|
all |
string |
|
friday |
string |
|
monday |
string |
|
none |
string |
|
saturday |
string |
|
sunday |
string |
|
thursday |
string |
|
tuesday |
string |
|
wednesday |
string |
TaskInputDefinitionBase
Name | Type | Description |
---|---|---|
aliases |
string[] |
|
defaultValue |
string |
|
groupName |
string |
|
helpMarkDown |
string |
|
label |
string |
|
name |
string |
|
options |
object |
|
properties |
object |
|
required |
boolean |
|
type |
string |
|
validation | ||
visibleRule |
string |
TaskInputValidation
Name | Type | Description |
---|---|---|
expression |
string |
Conditional expression |
message |
string |
Message explaining how user can correct if validation fails |
TaskSourceDefinitionBase
Name | Type | Description |
---|---|---|
authKey |
string |
|
endpoint |
string |
|
keySelector |
string |
|
selector |
string |
|
target |
string |
TaskStatus
Name | Type | Description |
---|---|---|
canceled |
string |
|
failed |
string |
|
failure |
string |
|
inProgress |
string |
|
partiallySucceeded |
string |
|
pending |
string |
|
skipped |
string |
|
succeeded |
string |
|
success |
string |
|
unknown |
string |
VariableGroup
Name | Type | Description |
---|---|---|
createdBy |
Gets or sets the identity who created. |
|
createdOn |
string |
Gets date on which it got created. |
description |
string |
Gets or sets description. |
id |
integer |
Gets the unique identifier of this field. |
modifiedBy |
Gets or sets the identity who modified. |
|
modifiedOn |
string |
Gets date on which it got modified. |
name |
string |
Gets or sets name. |
providerData |
Gets or sets provider data. |
|
type |
string |
Gets or sets type. |
variables |
<string,
Variable |
VariableGroupProviderData
VariableValue
Name | Type | Description |
---|---|---|
isSecret |
boolean |
|
value |
string |
WorkflowTask
Name | Type | Description |
---|---|---|
alwaysRun |
boolean |
|
condition |
string |
|
continueOnError |
boolean |
|
definitionType |
string |
|
enabled |
boolean |
|
inputs |
object |
|
name |
string |
|
overrideInputs |
object |
|
refName |
string |
|
taskId |
string |
|
timeoutInMinutes |
integer |
|
version |
string |
WorkflowTaskReference
Name | Type | Description |
---|---|---|
id |
string |
|
name |
string |
|
version |
string |