Manual Interventions - Update

Update manual intervention.

PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/manualinterventions/{manualInterventionId}?api-version=5.0

URI Parameters

Name In Required Type Description
organization
path True
  • string

The name of the Azure DevOps organization.

project
path True
  • string

Project ID or project name

releaseId
path True
  • integer
int32

Id of the release.

manualInterventionId
path True
  • integer
int32

Id of the manual intervention.

api-version
query True
  • string

Version of the API to use. This should be set to '5.0' to use this version of the api.

Request Body

Name Type Description
comment
  • string

Sets the comment for manual intervention update.

status

Sets the status of the manual intervention.

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.

Examples

Reject manual intervention
Resume manual intervention

Reject manual intervention

Sample Request

PATCH https://vsrm.dev.azure.com/fabrikam/A13d3daac-03b8-4a23-9cc4-2c3de65dab63/_apis/Release/releases/{releaseId}/manualinterventions/{manualInterventionId}?api-version=5.0
{
  "status": "rejected",
  "comment": "Reject MI"
}

Sample Response

{
  "id": 19,
  "status": "rejected",
  "approver": {
    "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
  },
  "taskInstanceId": "ebc0fff2-d164-48fd-b884-13f560d9851b",
  "comments": "Reject MI",
  "instructions": "",
  "createdOn": "2017-08-30T15:30:52.537Z",
  "modifiedOn": "2017-08-30T15:30:55.677Z",
  "release": {
    "id": 103,
    "name": "Release-2",
    "_links": {}
  },
  "releaseDefinition": {
    "id": 64,
    "name": "Fabrikam-web-with-MI",
    "_links": {}
  },
  "releaseEnvironment": {
    "id": 166,
    "name": "PROD",
    "_links": {}
  },
  "name": "Manual Intervention"
}

Resume manual intervention

Sample Request

PATCH https://vsrm.dev.azure.com/fabrikam/A13d3daac-03b8-4a23-9cc4-2c3de65dab63/_apis/Release/releases/{releaseId}/manualinterventions/{manualInterventionId}?api-version=5.0
{
  "status": "approved",
  "comment": "Good to resume"
}

Sample Response

{
  "id": 1,
  "status": "approved",
  "approver": {
    "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
  },
  "taskInstanceId": "c6500104-7b44-4188-9e1c-8a0a0714152e",
  "comments": "Good to resume",
  "instructions": "",
  "createdOn": "2017-08-28T13:11:10.007Z",
  "modifiedOn": "2017-08-28T13:11:26.333Z",
  "release": {
    "id": 37,
    "name": "Release-1",
    "_links": {}
  },
  "releaseDefinition": {
    "id": 29,
    "name": "Fabrikam-web-with-MI",
    "_links": {}
  },
  "releaseEnvironment": {
    "id": 100,
    "name": "PROD",
    "_links": {}
  },
  "name": "Manual Intervention"
}

Definitions

IdentityRef
ManualIntervention
ManualInterventionStatus

Gets or sets the status of the manual intervention.

ManualInterventionUpdateMetadata
ProjectReference
ReferenceLinks

The class to represent a collection of REST reference links.

ReleaseDefinitionShallowReference
ReleaseEnvironmentShallowReference
ReleaseShallowReference

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 Organizations.

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
isDeletedInOrigin
  • boolean
profileUrl
  • string
uniqueName
  • string
url
  • string

This url is the full route to the source resource of this graph subject.

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.

ManualInterventionUpdateMetadata

Name Type Description
comment
  • string

Sets the comment for manual intervention update.

status

Sets the status of the manual intervention.

ProjectReference

Name Type Description
id
  • string

Gets the unique identifier of this field.

name
  • string

Gets name of project.

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.

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.

path
  • string

Gets or sets the path of the release definition.

projectReference

Gets or sets project reference.

url
  • string

Gets the REST API url to access the release definition.

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.

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.