Commits - Get Commits Batch

Retrieve git commits for a project matching the search criteria

POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commitsbatch?api-version=5.1
POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commitsbatch?$skip={$skip}&$top={$top}&includeStatuses={includeStatuses}&api-version=5.1

URI Parameters

Name In Required Type Description
organization
path True
  • string

The name of the Azure DevOps organization.

repositoryId
path True
  • string

The name or ID of the repository.

project
path
  • string

Project ID or project name

api-version
query True
  • string

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

$skip
query
  • integer
int32

Number of commits to skip.

$top
query
  • integer
int32

Maximum number of commits to return.

includeStatuses
query
  • boolean

True to include additional commit status information.

Request Body

Name Type Description
$skip
  • integer

Number of entries to skip

$top
  • integer

Maximum number of entries to retrieve

author
  • string

Alias or display name of the author

compareVersion

Only applicable when ItemVersion specified. If provided, start walking history starting at this commit.

excludeDeletes
  • boolean

Only applies when an itemPath is specified. This determines whether to exclude delete entries of the specified path.

fromCommitId
  • string

If provided, a lower bound for filtering commits alphabetically

fromDate
  • string

If provided, only include history entries created after this date (string)

historyMode

What Git history mode should be used. This only applies to the search criteria when Ids = null and an itemPath is specified.

ids
  • string[]

If provided, specifies the exact commit ids of the commits to fetch. May not be combined with other parameters.

includeLinks
  • boolean

Whether to include the _links field on the shallow references

includePushData
  • boolean

Whether to include the push information

includeUserImageUrl
  • boolean

Whether to include the image Url for committers and authors

includeWorkItems
  • boolean

Whether to include linked work items

itemPath
  • string

Path of item to search under

itemVersion

If provided, identifies the commit or branch to search

toCommitId
  • string

If provided, an upper bound for filtering commits alphabetically

toDate
  • string

If provided, only include history entries created before this date (string)

user
  • string

Alias or display name of the committer

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.code Grants the ability to read source code and metadata about commits, changesets, branches, and other version control artifacts. Also grants the ability to search code and get notified about version control events via service hooks.

Examples

Commits between two versions
Commits by a list of commit IDs

Commits between two versions

Sample Request

POST https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commitsbatch?api-version=5.1
{
  "itemVersion": {
    "versionType": "branch",
    "version": "develop"
  },
  "compareVersion": {
    "versionType": "branch",
    "version": "master"
  }
}

Sample Response

{
  "count": 17,
  "value": [
    {
      "commitId": "23d0bc5b128a10056dc68afece360d8a0fabb014",
      "author": {
        "name": "Norman Paulk",
        "email": "Fabrikamfiber16@hotmail.com",
        "date": "2014-06-30T18:10:55Z"
      },
      "committer": {
        "name": "Norman Paulk",
        "email": "Fabrikamfiber16@hotmail.com",
        "date": "2014-06-30T18:10:55Z"
      },
      "comment": "Better description for hello world",
      "changeCounts": {
        "Edit": 1
      },
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/23d0bc5b128a10056dc68afece360d8a0fabb014",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/23d0bc5b128a10056dc68afece360d8a0fabb014"
    },
    {
      "commitId": "fe17a84cc2dfe0ea3a2202ab4dbac0706058e41f",
      "author": {
        "name": "Norman Paulk",
        "email": "Fabrikamfiber16@hotmail.com",
        "date": "2014-06-30T17:51:09Z"
      },
      "committer": {
        "name": "Norman Paulk",
        "email": "Fabrikamfiber16@hotmail.com",
        "date": "2014-06-30T17:51:09Z"
      },
      "comment": "Better description for hello world",
      "changeCounts": {
        "Edit": 1
      },
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/fe17a84cc2dfe0ea3a2202ab4dbac0706058e41f",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/fe17a84cc2dfe0ea3a2202ab4dbac0706058e41f"
    },
    {
      "commitId": "0360c963d7d86d040e9c33bba836feab14da4ad3",
      "author": {
        "name": "Norman Paulk",
        "email": "Fabrikamfiber16@hotmail.com",
        "date": "2014-06-10T19:42:13Z"
      },
      "committer": {
        "name": "Norman Paulk",
        "email": "Fabrikamfiber16@hotmail.com",
        "date": "2014-06-10T19:42:13Z"
      },
      "comment": "Fix for hello world class",
      "changeCounts": {
        "Edit": 1
      },
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/0360c963d7d86d040e9c33bba836feab14da4ad3",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/0360c963d7d86d040e9c33bba836feab14da4ad3"
    },
    {
      "commitId": "097d82b8aeabe493bf4c3553d320ae2529bba591",
      "author": {
        "name": "Chuck Reinhart",
        "email": "fabrikamfiber3@hotmail.com",
        "date": "2014-06-09T21:43:25Z"
      },
      "committer": {
        "name": "Chuck Reinhart",
        "email": "fabrikamfiber3@hotmail.com",
        "date": "2014-06-09T21:43:25Z"
      },
      "comment": "fix registration page",
      "changeCounts": {
        "Edit": 1
      },
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/097d82b8aeabe493bf4c3553d320ae2529bba591",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/097d82b8aeabe493bf4c3553d320ae2529bba591"
    },
    {
      "commitId": "33b55f7cb7e7e245323987634f960cf4a6e6bc74",
      "author": {
        "name": "Will Smythe",
        "email": "wismythe@microsoft.com",
        "date": "2014-05-02T19:17:05Z"
      },
      "committer": {
        "name": "Will Smythe",
        "email": "wismythe@microsoft.com",
        "date": "2014-05-02T19:17:05Z"
      },
      "comment": "Fixed bug in web.config file",
      "changeCounts": {
        "Edit": 1
      },
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/33b55f7cb7e7e245323987634f960cf4a6e6bc74",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/33b55f7cb7e7e245323987634f960cf4a6e6bc74"
    },
    {
      "commitId": "aad331d8d3b131fa9ae03cf5e53965b51942618a",
      "author": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-04-14T21:34:52Z"
      },
      "committer": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-04-14T21:34:52Z"
      },
      "comment": "Fixed bug for address validation.",
      "changeCounts": {
        "Edit": 1
      },
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/aad331d8d3b131fa9ae03cf5e53965b51942618a",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/aad331d8d3b131fa9ae03cf5e53965b51942618a"
    },
    {
      "commitId": "7c18355d8c2d946c5e1ce7a56f49653854445a1a",
      "author": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-28T17:05:58Z"
      },
      "committer": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-28T17:05:58Z"
      },
      "comment": "Added validation logic.",
      "changeCounts": {
        "Edit": 1
      },
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/7c18355d8c2d946c5e1ce7a56f49653854445a1a",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/7c18355d8c2d946c5e1ce7a56f49653854445a1a"
    },
    {
      "commitId": "cdaeef70a358ede7b4dc7b4a089f3853f37a6d2c",
      "author": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-27T19:51:11Z"
      },
      "committer": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-27T19:51:11Z"
      },
      "comment": "Added validation logic for zip code.",
      "changeCounts": {
        "Edit": 1
      },
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/cdaeef70a358ede7b4dc7b4a089f3853f37a6d2c",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/cdaeef70a358ede7b4dc7b4a089f3853f37a6d2c"
    },
    {
      "commitId": "ef837766c5eb3ae81a4c663d36bf95a8aed91312",
      "author": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-26T20:25:39Z"
      },
      "committer": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-26T20:25:39Z"
      },
      "comment": "Add validation code for zip code values.",
      "changeCounts": {
        "Edit": 1
      },
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/ef837766c5eb3ae81a4c663d36bf95a8aed91312",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/ef837766c5eb3ae81a4c663d36bf95a8aed91312"
    },
    {
      "commitId": "bd73638408daff89bcdac549a5a3396c9a7ce9dd",
      "author": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-26T18:56:21Z"
      },
      "committer": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-26T18:56:21Z"
      },
      "comment": "Added validation logic for zip code values.",
      "changeCounts": {
        "Edit": 1
      },
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/bd73638408daff89bcdac549a5a3396c9a7ce9dd",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/bd73638408daff89bcdac549a5a3396c9a7ce9dd"
    },
    {
      "commitId": "03bea1cebffa5726da0e3c0bc1487796d0dd0ee8",
      "author": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-26T18:42:24Z"
      },
      "committer": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-26T18:42:24Z"
      },
      "comment": "Added validation logic for address values.",
      "changeCounts": {
        "Edit": 1
      },
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/03bea1cebffa5726da0e3c0bc1487796d0dd0ee8",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/03bea1cebffa5726da0e3c0bc1487796d0dd0ee8"
    },
    {
      "commitId": "c093714168cdd190c1e171a803e996d685454352",
      "author": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-26T18:37:32Z"
      },
      "committer": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-26T18:37:32Z"
      },
      "comment": "Added validation logic for zip code values.",
      "changeCounts": {
        "Edit": 1
      },
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/c093714168cdd190c1e171a803e996d685454352",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/c093714168cdd190c1e171a803e996d685454352"
    },
    {
      "commitId": "3d203ea73427cec36b77a3a5a2e4f1f8ba7de170",
      "author": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-26T18:00:14Z"
      },
      "committer": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-26T18:00:14Z"
      },
      "comment": "Added code.",
      "changeCounts": {
        "Edit": 1
      },
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/3d203ea73427cec36b77a3a5a2e4f1f8ba7de170",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/3d203ea73427cec36b77a3a5a2e4f1f8ba7de170"
    },
    {
      "commitId": "1eea03b2ad9f14a5e7297c1307e36c980eb910ea",
      "author": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-26T16:17:11Z"
      },
      "committer": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-26T16:17:11Z"
      },
      "comment": "Added code.",
      "changeCounts": {
        "Edit": 1
      },
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/1eea03b2ad9f14a5e7297c1307e36c980eb910ea",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/1eea03b2ad9f14a5e7297c1307e36c980eb910ea"
    },
    {
      "commitId": "c40b5ceb9c77096b9f59e6a9193dae527bda79d9",
      "author": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-10T20:54:10Z"
      },
      "committer": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-10T20:54:10Z"
      },
      "comment": "Added method for submitting new customer addrress.",
      "changeCounts": {
        "Edit": 2
      },
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/c40b5ceb9c77096b9f59e6a9193dae527bda79d9",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/c40b5ceb9c77096b9f59e6a9193dae527bda79d9"
    },
    {
      "commitId": "6ff5e8f6256cc58aa062dbb1e096c1e3b3435ebe",
      "author": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-10T20:50:08Z"
      },
      "committer": {
        "name": "Howie Hilliker",
        "email": "hhill@microsoft.com",
        "date": "2014-03-10T20:50:08Z"
      },
      "comment": "Adding customer address module project",
      "changeCounts": {
        "Add": 12
      },
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/6ff5e8f6256cc58aa062dbb1e096c1e3b3435ebe",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/6ff5e8f6256cc58aa062dbb1e096c1e3b3435ebe"
    },
    {
      "commitId": "03b1b831e41df536d836c95e2f68a42db4f3e0db",
      "author": {
        "name": "Chuck Reinhart",
        "email": "fabrikamfiber3@hotmail.com",
        "date": "2014-02-10T21:52:47Z"
      },
      "committer": {
        "name": "Chuck Reinhart",
        "email": "fabrikamfiber3@hotmail.com",
        "date": "2014-02-10T21:52:47Z"
      },
      "comment": "Add Hello World to TFS",
      "changeCounts": {
        "Add": 5
      },
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/03b1b831e41df536d836c95e2f68a42db4f3e0db",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/03b1b831e41df536d836c95e2f68a42db4f3e0db"
    }
  ]
}

Commits by a list of commit IDs

Sample Request

POST https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commitsbatch?api-version=5.1
{
  "ids": [
    "23d0bc5b128a10056dc68afece360d8a0fabb014",
    "fe17a84cc2dfe0ea3a2202ab4dbac0706058e41f"
  ]
}

Sample Response

{
  "count": 2,
  "value": [
    {
      "commitId": "23d0bc5b128a10056dc68afece360d8a0fabb014",
      "author": {
        "name": "Norman Paulk",
        "email": "Fabrikamfiber16@hotmail.com",
        "date": "2014-06-30T18:10:55Z"
      },
      "committer": {
        "name": "Norman Paulk",
        "email": "Fabrikamfiber16@hotmail.com",
        "date": "2014-06-30T18:10:55Z"
      },
      "comment": "Better description for hello world",
      "changeCounts": {
        "Edit": 1
      },
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/23d0bc5b128a10056dc68afece360d8a0fabb014",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/23d0bc5b128a10056dc68afece360d8a0fabb014"
    },
    {
      "commitId": "fe17a84cc2dfe0ea3a2202ab4dbac0706058e41f",
      "author": {
        "name": "Norman Paulk",
        "email": "Fabrikamfiber16@hotmail.com",
        "date": "2014-06-30T17:51:09Z"
      },
      "committer": {
        "name": "Norman Paulk",
        "email": "Fabrikamfiber16@hotmail.com",
        "date": "2014-06-30T17:51:09Z"
      },
      "comment": "Better description for hello world",
      "changeCounts": {
        "Edit": 1
      },
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/fe17a84cc2dfe0ea3a2202ab4dbac0706058e41f",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/fe17a84cc2dfe0ea3a2202ab4dbac0706058e41f"
    }
  ]
}

Definitions

ChangeCountDictionary
GitChange
GitCommitRef

Provides properties that describe a Git commit and associated metadata.

GitHistoryMode

What Git history mode should be used. This only applies to the search criteria when Ids = null and an itemPath is specified.

GitPushRef
GitQueryCommitsCriteria
GitStatus

This class contains the metadata of a service/extension posting a status.

GitStatusContext

Status context that uniquely identifies the status.

GitStatusState

State of the status.

GitTemplate
GitUserDate

User info and date for Git operations.

GitVersionDescriptor
GitVersionOptions

Version options - Specify additional modifiers to version (e.g Previous)

GitVersionType

Version type (branch, tag, or commit). Determines how Id is interpreted

IdentityRef
ItemContent
ItemContentType
ReferenceLinks

The class to represent a collection of REST reference links.

ResourceRef
VersionControlChangeType

The type of change that was made to the item.

ChangeCountDictionary

GitChange

Name Type Description
changeId
  • integer

ID of the change within the group of changes.

changeType

The type of change that was made to the item.

item
  • string

Current version.

newContent

Content of the item after the change.

newContentTemplate

New Content template to be used when pushing new changes.

originalPath
  • string

Original path of item if different from current path.

sourceServerItem
  • string

Path of the item on the server.

url
  • string

URL to retrieve the item.

GitCommitRef

Provides properties that describe a Git commit and associated metadata.

Name Type Description
_links

A collection of related REST reference links.

author

Author of the commit.

changeCounts

Counts of the types of changes (edits, deletes, etc.) included with the commit.

changes

An enumeration of the changes included with the commit.

comment
  • string

Comment or message of the commit.

commentTruncated
  • boolean

Indicates if the comment is truncated from the full Git commit comment message.

commitId
  • string

ID (SHA-1) of the commit.

committer

Committer of the commit.

parents
  • string[]

An enumeration of the parent commit IDs for this commit.

push

The push associated with this commit.

remoteUrl
  • string

Remote URL path to the commit.

statuses

A list of status metadata from services and extensions that may associate additional information to the commit.

url
  • string

REST URL for this resource.

workItems

A list of workitems associated with this commit.

GitHistoryMode

What Git history mode should be used. This only applies to the search criteria when Ids = null and an itemPath is specified.

Name Type Description
firstParent
  • string

The history mode used by git log --first-parent

fullHistory
  • string

The history mode used by git log --full-history

fullHistorySimplifyMerges
  • string

The history mode used by git log --full-history --simplify-merges

simplifiedHistory
  • string

The history mode used by git log. This is the default.

GitPushRef

Name Type Description
_links

The class to represent a collection of REST reference links.

date
  • string
pushId
  • integer
pushedBy
url
  • string

GitQueryCommitsCriteria

Name Type Description
$skip
  • integer

Number of entries to skip

$top
  • integer

Maximum number of entries to retrieve

author
  • string

Alias or display name of the author

compareVersion

Only applicable when ItemVersion specified. If provided, start walking history starting at this commit.

excludeDeletes
  • boolean

Only applies when an itemPath is specified. This determines whether to exclude delete entries of the specified path.

fromCommitId
  • string

If provided, a lower bound for filtering commits alphabetically

fromDate
  • string

If provided, only include history entries created after this date (string)

historyMode

What Git history mode should be used. This only applies to the search criteria when Ids = null and an itemPath is specified.

ids
  • string[]

If provided, specifies the exact commit ids of the commits to fetch. May not be combined with other parameters.

includeLinks
  • boolean

Whether to include the _links field on the shallow references

includePushData
  • boolean

Whether to include the push information

includeUserImageUrl
  • boolean

Whether to include the image Url for committers and authors

includeWorkItems
  • boolean

Whether to include linked work items

itemPath
  • string

Path of item to search under

itemVersion

If provided, identifies the commit or branch to search

toCommitId
  • string

If provided, an upper bound for filtering commits alphabetically

toDate
  • string

If provided, only include history entries created before this date (string)

user
  • string

Alias or display name of the committer

GitStatus

This class contains the metadata of a service/extension posting a status.

Name Type Description
_links

Reference links.

context

Context of the status.

createdBy

Identity that created the status.

creationDate
  • string

Creation date and time of the status.

description
  • string

Status description. Typically describes current state of the status.

id
  • integer

Status identifier.

state

State of the status.

targetUrl
  • string

URL with status details.

updatedDate
  • string

Last update date and time of the status.

GitStatusContext

Status context that uniquely identifies the status.

Name Type Description
genre
  • string

Genre of the status. Typically name of the service/tool generating the status, can be empty.

name
  • string

Name identifier of the status, cannot be null or empty.

GitStatusState

State of the status.

Name Type Description
error
  • string

Status with an error.

failed
  • string

Status failed.

notApplicable
  • string

Status is not applicable to the target object.

notSet
  • string

Status state not set. Default state.

pending
  • string

Status pending.

succeeded
  • string

Status succeeded.

GitTemplate

Name Type Description
name
  • string

Name of the Template

type
  • string

Type of the Template

GitUserDate

User info and date for Git operations.

Name Type Description
date
  • string

Date of the Git operation.

email
  • string

Email address of the user performing the Git operation.

imageUrl
  • string

Url for the user's avatar.

name
  • string

Name of the user performing the Git operation.

GitVersionDescriptor

Name Type Description
version
  • string

Version string identifier (name of tag/branch, SHA1 of commit)

versionOptions

Version options - Specify additional modifiers to version (e.g Previous)

versionType

Version type (branch, tag, or commit). Determines how Id is interpreted

GitVersionOptions

Version options - Specify additional modifiers to version (e.g Previous)

Name Type Description
firstParent
  • string

First parent of commit (HEAD^)

none
  • string

Not specified

previousChange
  • string

Commit that changed item prior to the current version

GitVersionType

Version type (branch, tag, or commit). Determines how Id is interpreted

Name Type Description
branch
  • string

Interpret the version as a branch name

commit
  • string

Interpret the version as a commit ID (SHA1)

tag
  • string

Interpret the version as a tag name

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

Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary

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

Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary

inactive
  • boolean

Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary

isAadIdentity
  • boolean

Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)

isContainer
  • boolean

Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)

isDeletedInOrigin
  • boolean
profileUrl
  • string

Deprecated - not in use in most preexisting implementations of ToIdentityRef

uniqueName
  • string

Deprecated - use Domain+PrincipalName instead

url
  • string

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

ItemContent

Name Type Description
content
  • string
contentType

ItemContentType

Name Type Description
base64Encoded
  • string
rawText
  • string

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.

ResourceRef

Name Type Description
id
  • string
url
  • string

VersionControlChangeType

The type of change that was made to the item.

Name Type Description
add
  • string
all
  • string
branch
  • string
delete
  • string
edit
  • string
encoding
  • string
lock
  • string
merge
  • string
none
  • string
property
  • string
rename
  • string
rollback
  • string
sourceRename
  • string
targetRename
  • string
undelete
  • string