Pull Request Statuses - Update
Update pull request statuses collection. The only supported operation type is remove
.
This operation allows to delete multiple statuses in one call.
The path of the remove
operation should refer to the ID of the pull request status.
For example path="/1"
refers to the pull request status with ID 1.
PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses?api-version=4.1-preview.1
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
pull
|
path | True |
integer int32 |
ID of the pull request. |
repository
|
path | True |
string |
The repository ID of the pull request’s target branch. |
project
|
path |
string |
Project ID or project name |
|
api-version
|
query | True |
string |
Version of the API to use. This should be set to '4.1-preview.1' to use this version of the api. |
Request Body
Media Types: "application/json-patch+json"
Name | Type | Description |
---|---|---|
from |
string |
The path to copy from for the Move/Copy operation. |
op |
The patch operation |
|
path |
string |
The path for the operation |
value |
object |
The value for the operation. This is either a primitive or a JToken. |
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_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
PATCH https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses?api-version=4.1-preview.1
[
{
"op": "remove",
"path": "/1",
"from": null,
"value": null
},
{
"op": "remove",
"path": "/2",
"from": null,
"value": null
}
]
Sample response
Definitions
Name | Description |
---|---|
Json |
The JSON model for JSON Patch Operations |
Operation |
The patch operation |
JsonPatchDocument
The JSON model for JSON Patch Operations
Name | Type | Description |
---|---|---|
from |
string |
The path to copy from for the Move/Copy operation. |
op |
The patch operation |
|
path |
string |
The path for the operation |
value |
object |
The value for the operation. This is either a primitive or a JToken. |
Operation
The patch operation
Name | Type | Description |
---|---|---|
add |
string |
|
copy |
string |
|
move |
string |
|
remove |
string |
|
replace |
string |
|
test |
string |