Cherry Picks - Create

Service:

Git

API Version:

5.0-preview.1

Cherry pick a specific commit or commits that are associated to a pull request into a new branch.

POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/cherryPicks?api-version=5.0-preview.1

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
repositoryId	path	True	string	ID of the repository.
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.

Request Body

Name	Type	Description
generatedRefName	string	Proposed target branch name for the cherry pick or revert operation.
ontoRefName	string	The target branch for the cherry pick or revert operation.
repository	GitRepository	The git repository for the cherry pick or revert operation.
source	GitAsyncRefOperationSource	Details about the source of the cherry pick or revert operation (e.g. A pull request or a specific commit).

Responses

Name	Type	Description
200 OK	GitCherryPick	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_manage	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 code repositories, create and manage pull requests and code reviews, and to receive notifications about version control events via service hooks.

Definitions

Name	Description
ChangeCountDictionary
GitAsyncOperationStatus
GitAsyncRefOperationDetail	Information about the progress of a cherry pick or revert operation.
GitAsyncRefOperationFailureStatus	Provides a status code that indicates the reason the cherry pick or revert failed.
GitAsyncRefOperationParameters	Parameters that are provided in the request body when requesting to cherry pick or revert.
GitAsyncRefOperationSource	GitAsyncRefOperationSource specifies the pull request or list of commits to use when making a cherry pick and revert operation request. Only one should be provided.
GitChange
GitCherryPick	This object is returned from Cherry Pick operations and provides the id and status of the operation
GitCommitRef	Provides properties that describe a Git commit and associated metadata.
GitPushRef
GitRepository
GitRepositoryRef
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.
IdentityRef
ItemContent
ItemContentType
ProjectState	Project state.
ProjectVisibility	Project visibility.
ReferenceLinks	The class to represent a collection of REST reference links.
ResourceRef
TeamProjectCollectionReference	Reference object for a TeamProjectCollection.
TeamProjectReference	Represents a shallow reference to a TeamProject.
VersionControlChangeType	The type of change that was made to the item.

ChangeCountDictionary

GitAsyncOperationStatus

Name	Type	Description
abandoned	string	The operation has been abandoned.
completed	string	The operation has completed.
failed	string	The operation has failed. Check for an error message.
inProgress	string	The operation is currently in progress.
queued	string	The operation is waiting in a queue and has not yet started.

GitAsyncRefOperationDetail

Information about the progress of a cherry pick or revert operation.

Name	Type	Description
conflict	boolean	Indicates if there was a conflict generated when trying to cherry pick or revert the changes.
currentCommitId	string	The current commit from the list of commits that are being cherry picked or reverted.
failureMessage	string	Detailed information about why the cherry pick or revert failed to complete.
progress	number	A number between 0 and 1 indicating the percent complete of the operation.
status	GitAsyncRefOperationFailureStatus	Provides a status code that indicates the reason the cherry pick or revert failed.
timedout	boolean	Indicates if the operation went beyond the maximum time allowed for a cherry pick or revert operation.

GitAsyncRefOperationFailureStatus

Provides a status code that indicates the reason the cherry pick or revert failed.

Name	Type	Description
asyncOperationNotFound	string	Async operation was not found
createBranchPermissionRequired	string	The ref update request could not be completed because the user lacks the permission to create a branch
emptyCommitterSignature	string	Initiator of async operation has signature with empty name or email
gitObjectTooLarge	string	Git object is too large to materialize into memory
invalidRefName	string	Indicates that the ref update request could not be completed because the ref name presented in the request was not valid.
none	string	No status
operationIndentityNotFound	string	Identity who authorized the operation was not found
other	string	Unexpected failure
refNameConflict	string	The ref update could not be completed because, in case-insensitive mode, the ref name conflicts with an existing, differently-cased ref name.
targetBranchDeleted	string	Target branch was deleted after Git async operation started
writePermissionRequired	string	The ref update request could not be completed because the user lacks write permissions required to write this ref

GitAsyncRefOperationParameters

Parameters that are provided in the request body when requesting to cherry pick or revert.

Name	Type	Description
generatedRefName	string	Proposed target branch name for the cherry pick or revert operation.
ontoRefName	string	The target branch for the cherry pick or revert operation.
repository	GitRepository	The git repository for the cherry pick or revert operation.
source	GitAsyncRefOperationSource	Details about the source of the cherry pick or revert operation (e.g. A pull request or a specific commit).

GitAsyncRefOperationSource

GitAsyncRefOperationSource specifies the pull request or list of commits to use when making a cherry pick and revert operation request. Only one should be provided.

Name	Type	Description
commitList	GitCommitRef[]	A list of commits to cherry pick or revert
pullRequestId	integer	Id of the pull request to cherry pick or revert

GitChange

Name	Type	Description
changeId	integer	ID of the change within the group of changes.
changeType	VersionControlChangeType	The type of change that was made to the item.
item	string	Current version.
newContent	ItemContent	Content of the item after the change.
newContentTemplate	GitTemplate	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.

GitCherryPick

This object is returned from Cherry Pick operations and provides the id and status of the operation

Name	Type	Description
_links	ReferenceLinks	The class to represent a collection of REST reference links.
cherryPickId	integer
detailedStatus	GitAsyncRefOperationDetail	Information about the progress of a cherry pick or revert operation.
parameters	GitAsyncRefOperationParameters	Parameters that are provided in the request body when requesting to cherry pick or revert.
status	GitAsyncOperationStatus
url	string	A URL that can be used to make further requests for status about the operation

GitCommitRef

Provides properties that describe a Git commit and associated metadata.

Name	Type	Description
_links	ReferenceLinks	A collection of related REST reference links.
author	GitUserDate	Author of the commit.
changeCounts	ChangeCountDictionary	Counts of the types of changes (edits, deletes, etc.) included with the commit.
changes	GitChange[]	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	GitUserDate	Committer of the commit.
parents	string[]	An enumeration of the parent commit IDs for this commit.
push	GitPushRef	The push associated with this commit.
remoteUrl	string	Remote URL path to the commit.
statuses	GitStatus[]	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	ResourceRef[]	A list of workitems associated with this commit.

GitPushRef

Name	Type	Description
_links	ReferenceLinks	The class to represent a collection of REST reference links.
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitRepository

Name	Type	Description
_links	ReferenceLinks	The class to represent a collection of REST reference links.
defaultBranch	string
id	string
isFork	boolean	True if the repository was created as a fork
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	Represents a shallow reference to a TeamProject.
remoteUrl	string
size	integer	Compressed size (bytes) of the repository.
sshUrl	string
url	string
validRemoteUrls	string[]

GitRepositoryRef

Name	Type	Description
collection	TeamProjectCollectionReference	Team Project Collection where this Fork resides
id	string
isFork	boolean	True if the repository was created as a fork
name	string
project	TeamProjectReference	Represents a shallow reference to a TeamProject.
remoteUrl	string
sshUrl	string
url	string

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.

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.

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.

ItemContent

Name	Type	Description
content	string
contentType	ItemContentType

ItemContentType

Name	Type	Description
base64Encoded	string
rawText	string

ProjectState

Project state.

Name	Type	Description
all	string	All projects regardless of state.
createPending	string	Project has been queued for creation, but the process has not yet started.
deleted	string	Project has been deleted.
deleting	string	Project is in the process of being deleted.
new	string	Project is in the process of being created.
unchanged	string	Project has not been changed.
wellFormed	string	Project is completely created and ready to use.

ProjectVisibility

Project visibility.

Name	Type	Description
private	string	The project is only visible to users with explicit access.
public	string	The project is visible to all.

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.

ResourceRef

Name	Type	Description
id	string
url	string

TeamProjectCollectionReference

Reference object for a TeamProjectCollection.

Name	Type	Description
id	string	Collection Id.
name	string	Collection Name.
url	string	Collection REST Url.

TeamProjectReference

Represents a shallow reference to a TeamProject.

Name	Type	Description
abbreviation	string	Project abbreviation.
defaultTeamImageUrl	string	Url to default team identity image.
description	string	The project's description (if any).
id	string	Project identifier.
name	string	Project name.
revision	integer	Project revision.
state	ProjectState	Project state.
url	string	Url to the full version of the object.
visibility	ProjectVisibility	Project visibility.

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