Favorites - Get Favorite By Artifact

参考

服务:: Favorite

API 版本:: 7.1-preview.1

GET https://dev.azure.com/{organization}/_apis/favorite/favorites?artifactType={artifactType}&artifactId={artifactId}&artifactScopeType={artifactScopeType}&api-version=7.1-preview.1

具有可选参数:

GET https://dev.azure.com/{organization}/_apis/favorite/favorites?artifactType={artifactType}&artifactId={artifactId}&artifactScopeType={artifactScopeType}&artifactScopeId={artifactScopeId}&includeExtendedDetails={includeExtendedDetails}&api-version=7.1-preview.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1-preview.1”才能使用此版本的 API。
artifactId	query	True	string
artifactScopeType	query	True	string
artifactType	query	True	string
artifactScopeId	query		string
includeExtendedDetails	query		boolean

响应

名称	类型	说明
200 OK	Favorite	成功的操作

安全性

oauth2

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 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

作用域

名称	说明
vso.profile	授予读取个人资料、帐户、集合、项目、团队和其他顶级组织项目的能力。

示例

示例请求

HTTP

GET https://dev.azure.com/{organization}/_apis/favorite/favorites?artifactType=Microsoft.TeamFoundation.Build.Definition&artifactId=vstfs:///Build/Definition/1&artifactScopeType=Project&api-version=7.1-preview.1

示例响应

状态代码:: 200

{
  "artifactScope": {
    "type": "Project",
    "id": "ee27e18d-f04c-456d-af1e-d335a6ecff2e",
    "name": "SampleProject"
  },
  "id": "399c096c-beb6-42f1-b497-f579913bd4bd",
  "owner": {
    "displayName": "John Doe",
    "id": "df1a0816-9fa8-6752-86bb-ddc55c149629",
    "uniqueName": "Identity df1a0816-9fa8-6752-86bb-ddc55c149629 (IdentityType: Microsoft.IdentityModel.Claims.ClaimsIdentity; Identifier: 000300009FE5275C@Live.com; DisplayName: John Doe)"
  },
  "artifactName": "pipeline",
  "artifactType": "Microsoft.TeamFoundation.Build.Definition",
  "artifactId": "vstfs:///Build/Definition/1",
  "_links": {
    "page": {
      "href": "https://dev.azure.com/fabrikam/SampleProject/_build/definition?definitionId=1"
    }
  }
}

定义

名称	说明
ArtifactProperties
ArtifactScope	描述收藏的项目所在的范围。例如，团队项目。
Favorite	实现新式存储后的收藏夹协定
IdentityRef
ReferenceLinks	表示 REST 引用链接集合的类。

ArtifactProperties

Object

ArtifactScope

Object

描述收藏的项目所在的范围。例如，团队项目。

名称	类型	说明
id	string	项目所在的范围的标识符。对于 TFS 项目，这指的是 Project GUID 字符串。对于集合，用空字符串标记此属性。
name	string	项目范围的名称 (例如项目名称) 注意：此属性是存储的收藏模型的只读扩展。此值在写入时无法重写。
type	string	收藏项目所在的范围类型。已知范围包括“项目”或“集合”

Favorite

Object

实现新式存储后的收藏夹协定

名称	类型	说明
_links	ReferenceLinks	链接到与基础项目关联的资源。
artifactId	string	收藏项目的 ID，在该项目类型的上下文中是唯一的。
artifactIsDeleted	boolean	指示是否找不到此收藏夹描述的项目。
artifactName	string	项目的姓氏。
artifactProperties	ArtifactProperties	描述收藏夹项目的缓存属性字典。结构由处理此项目类型的服务端功能元数据提供程序生成。
artifactScope	ArtifactScope	项目范围 - 此对象描述包含项目的位置。例如，用于创建所有收藏夹的 Project 必需参数。
artifactType	string	项目类型。
creationDate	string	在服务器上创建此收藏夹的日期和时间。
id	string	收藏项的唯一 ID，由服务器在创建时定义。
owner	IdentityRef	服务器基于活动用户上下文定义的用户标识。
url	string	Fully-Qualified指向此资源的链接

IdentityRef

Object

名称	类型	说明
_links	ReferenceLinks	此字段包含零个或多个有关图形主题的有趣链接。可以调用这些链接来获取有关此图主题的其他关系或更详细的信息。
descriptor	string	描述符是在系统运行时引用图形主题的主要方法。此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias	string	已弃用 - 可以通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索
displayName	string	这是图形主题的非唯一显示名称。若要更改此字段，必须在源提供程序中更改其值。
id	string
imageUrl	string	已弃用 - 在 IdentityRef“_links”字典的“头像”条目中可用
inactive	boolean	已弃用 - 可通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索
isAadIdentity	boolean	已弃用 - 可以从描述符的主题类型推断 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	已弃用 - 可以从描述符的主题类型推断 (描述符.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	已弃用 - 未在 ToIdentityRef 的大多数预先存在的实现中使用
uniqueName	string	已弃用 - 改用 Domain+PrincipalName
url	string	此 URL 是指向此图主题的源资源的完整路由。

ReferenceLinks

Object

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。由于引用链接是只读的，因此我们只想将其公开为只读。

通过

Favorites - Get Favorite By Artifact

URI 参数

响应

安全性

oauth2

作用域

示例

示例请求

示例响应

定义

ArtifactProperties

ArtifactScope

Favorite

IdentityRef

ReferenceLinks

其他资源