Definitions - Get Release Definition History

Get revision history for a release definition

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/definitions/{definitionId}/revisions?api-version=5.0-preview.1

URI Parameters

Name In Required Type Description
definitionId
path True

integer

int32

Id of the definition.

organization
path True

string

The name of the Azure DevOps organization.

project
path True

string

Project ID or project name

api-version
query True

string

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

Responses

Name Type Description
200 OK

ReleaseDefinitionRevision[]

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 Grants the ability to read release artifacts, including releases, release definitions and release environment.

Examples

Sample Request

GET https://vsrm.dev.azure.com/fabrikam/{project}/_apis/Release/definitions/{definitionId}/revisions?api-version=5.0-preview.1

Sample Response

{
  "count": 2,
  "value": [
    {
      "definitionId": 10,
      "revision": 1,
      "changedDate": "2017-06-13T09:54:52.457Z",
      "changeType": "add",
      "definitionUrl": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/definitions/10?Revision=1",
      "changedBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      }
    },
    {
      "definitionId": 10,
      "revision": 2,
      "changedDate": "2017-06-13T09:54:53.753Z",
      "changeType": "update",
      "definitionUrl": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/definitions/10?Revision=2",
      "changedBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      }
    }
  ]
}

Definitions

Name Description
AuditAction

Gets type of change.

IdentityRef
ReferenceLinks

The class to represent a collection of REST reference links.

ReleaseDefinitionRevision

AuditAction

Gets type of change.

Name Type Description
add

string

delete

string

undelete

string

update

string

IdentityRef

Name Type Description
_links

ReferenceLinks

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.

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.

ReleaseDefinitionRevision

Name Type Description
apiVersion

string

Gets api-version for revision object.

changeType

AuditAction

Gets type of change.

changedBy

IdentityRef

Gets the identity who did change.

changedDate

string

Gets date on which it got changed.

comment

string

Gets comments for revision.

definitionId

integer

Get id of the definition.

definitionUrl

string

Gets definition url.

revision

integer

Get revision number of the definition.