Refs Favorites - List
Gets the refs favorites for a repo and an identity.
GET https://dev.azure.com/{organization}/{project}/_apis/git/favorites/refs?api-version=7.1
GET https://dev.azure.com/{organization}/{project}/_apis/git/favorites/refs?repositoryId={repositoryId}&identityId={identityId}&api-version=7.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 |
api-version
|
query | True |
string |
Version of the API to use. This should be set to '7.1' to use this version of the api. |
identity
|
query |
string |
The id of the identity whose favorites are to be retrieved. If null, the requesting identity is used. |
|
repository
|
query |
string |
The id of the repository. |
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. |
Definitions
Name | Description |
---|---|
Git |
|
Reference |
The class to represent a collection of REST reference links. |
Ref |
GitRefFavorite
Name | Type | Description |
---|---|---|
_links |
The class to represent a collection of REST reference links. |
|
id |
integer (int32) |
|
identityId |
string (uuid) |
|
name |
string |
|
repositoryId |
string (uuid) |
|
type | ||
url |
string |
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. |
RefFavoriteType
Value | Description |
---|---|
folder | |
invalid | |
ref |