Statuses - Create

Reference

Service:: Git

API Version:: 5.0

Create Git commit status.

POST https://{instance}/{collection}/{project}/_apis/git/repositories/{repositoryId}/commits/{commitId}/statuses?api-version=5.0

URI Parameters

Name	In	Required	Type	Description
collection	path	True	string	The name of the Azure DevOps collection.
commitId	path	True	string	ID of the Git commit.
instance	path	True	string	Azure DevOps server name ({server:port})
repositoryId	path	True	string	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.0' to use this version of the api.

Request Body

Name	Type	Description
_links	ReferenceLinks	Reference links.
context	GitStatusContext	Context of the status.
createdBy	IdentityRef	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	GitStatusState	State of the status.
targetUrl	string	URL with status details.
updatedDate	string	Last update date and time of the status.

Responses

Name	Type	Description
200 OK	GitStatus	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_write	Grants the ability to read, update, and delete source code, access metadata about commits, changesets, branches, and other version control artifacts. Also grants the ability to create and manage pull requests and code reviews and to receive notifications about version control events via service hooks.
vso.code_status	Grants the ability to read and write commit and pull request status.

Examples

Sample Request

HTTP

POST https://{instance}/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/67cae2b029dff7eb3dc062b49403aaedca5bad8d/statuses?api-version=5.0

{
  "state": "succeeded",
  "description": "The build is successful",
  "targetUrl": "https://ci.fabrikam.com/my-project/build/123 ",
  "context": {
    "name": "Build123",
    "genre": "continuous-integration"
  }
}

Sample Response

Status code:: 201

{
  "state": "succeeded",
  "description": "The build is successful",
  "context": {
    "name": "Build123",
    "genre": "continuous-integration"
  },
  "creationDate": "2016-01-27T09:33:07Z",
  "createdBy": {
    "id": "278d5cd2-584d-4b63-824a-2ba458937249",
    "displayName": "Norman Paulk",
    "uniqueName": "Fabrikamfiber16",
    "url": "https://fabrikam:8080/tfs/_apis/Identities/278d5cd2-584d-4b63-824a-2ba458937249",
    "imageUrl": "https://fabrikam:8080/tfs/_api/_common/identityImage?id=278d5cd2-584d-4b63-824a-2ba458937249"
  },
  "targetUrl": "https://ci.fabrikam.com/my-project/build/123 "
}

Definitions

Name	Description
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.
IdentityRef
ReferenceLinks	The class to represent a collection of REST reference links.

GitStatus

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

Name	Type	Description
_links	ReferenceLinks	Reference links.
context	GitStatusContext	Context of the status.
createdBy	IdentityRef	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	GitStatusState	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.

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 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
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	This url is the full route to the source resource of this graph subject.

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.

Share via