通过

Shelvesets - List

  • 参考
服务:
Tfvc
API 版本:
7.1

返回浅架集引用的集合。

GET https://dev.azure.com/{organization}/_apis/tfvc/shelvesets?api-version=7.1
具有可选参数: 
GET https://dev.azure.com/{organization}/_apis/tfvc/shelvesets?requestData.includeDetails={requestData.includeDetails}&requestData.includeLinks={requestData.includeLinks}&requestData.includeWorkItems={requestData.includeWorkItems}&requestData.maxChangeCount={requestData.maxChangeCount}&requestData.maxCommentLength={requestData.maxCommentLength}&requestData.name={requestData.name}&requestData.owner={requestData.owner}&$top={$top}&$skip={$skip}&api-version=7.1

URI 参数

名称 在 必需 类型 说明
organization
 path True

string

Azure DevOps 组织的名称。
api-version
 query True

string

要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。
$skip
 query

integer (int32)

要跳过的货架集数
$top
 query

integer (int32)

要返回的最大货架集数
requestData.includeDetails
 query

boolean

是否包含 policyOverride 和备注仅在请求单个深层搁置集时适用
requestData.includeLinks
 query

boolean

是否在浅引用中包含_links字段。 请求单个深层搁置集对象时不适用。 链接将始终包含在深层货架集中。
requestData.includeWorkItems
 query

boolean

是否包含 workItems
requestData.maxChangeCount
 query

integer (int32)

要包含的最大更改数
requestData.maxCommentLength
 query

integer (int32)

批注的最大长度
requestData.name
 query

string

搁置集名称
requestData.owner
 query

string

所有者的 ID。 可以是名称或 guid。

响应

名称 类型 说明
200 OK

TfvcShelvesetRef[]

成功作

安全性

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.code 授予读取有关提交、更改集、分支和其他版本控制项目的源代码和元数据的能力。 此外，还可以通过服务挂钩搜索代码并获取有关版本控制事件的通知。

示例

GET a list of shelveset refs for a specific Owner.
GET a list of shelveset refs with a max comment length.
GET a list of shelveset refs with top and skip.
GET a list of shelveset refs.

GET a list of shelveset refs for a specific Owner.

示例请求

GET https://dev.azure.com/fabrikam/_apis/tfvc/shelvesets?requestData.owner=Normal Paulk&api-version=7.1

示例响应

状态代码:
200 
{
  "count": 3,
  "value": [
    {
      "name": "My first shelveset",
      "id": "My first shelveset;d6245f20-2af8-44f4-9451-8107cb2767db",
      "owner": {
        "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
        "displayName": "Normal Paulk",
        "uniqueName": "fabrikamfiber16@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
      },
      "createdDate": "2014-07-18T03:37:52.277Z",
      "comment": "Here is a really long comment describing this shelveset.",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/shelvesets/My%20first%20shelveset%3bd6245f20-2af8-44f4-9451-8107cb2767db"
    },
    {
      "name": "More changes",
      "id": "More changes;d6245f20-2af8-44f4-9451-8107cb2767db",
      "owner": {
        "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
        "displayName": "Normal Paulk",
        "uniqueName": "fabrikamfiber16@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
      },
      "createdDate": "2014-07-18T03:29:45.91Z",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/shelvesets/More%20changes%3bd6245f20-2af8-44f4-9451-8107cb2767db"
    },
    {
      "name": "Doc updates",
      "id": "Doc updates;d6245f20-2af8-44f4-9451-8107cb2767db",
      "owner": {
        "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
        "displayName": "Normal Paulk",
        "uniqueName": "fabrikamfiber16@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
      },
      "createdDate": "2014-07-18T03:27:25.18Z",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/shelvesets/Doc%20updates%3bd6245f20-2af8-44f4-9451-8107cb2767db"
    }
  ]
}

GET a list of shelveset refs with a max comment length.

示例请求

GET https://dev.azure.com/fabrikam/_apis/tfvc/shelvesets?requestData.maxCommentLength=6&api-version=7.1

示例响应

状态代码:
200 
{
  "count": 4,
  "value": [
    {
      "name": "My first shelveset",
      "id": "My first shelveset;d6245f20-2af8-44f4-9451-8107cb2767db",
      "owner": {
        "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
        "displayName": "Normal Paulk",
        "uniqueName": "fabrikamfiber16@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
      },
      "createdDate": "2014-07-18T03:37:52.277Z",
      "comment": "Here i",
      "commentTruncated": true,
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/shelvesets/My%20first%20shelveset%3bd6245f20-2af8-44f4-9451-8107cb2767db"
    },
    {
      "name": "More changes",
      "id": "More changes;d6245f20-2af8-44f4-9451-8107cb2767db",
      "owner": {
        "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
        "displayName": "Normal Paulk",
        "uniqueName": "fabrikamfiber16@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
      },
      "createdDate": "2014-07-18T03:29:45.91Z",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/shelvesets/More%20changes%3bd6245f20-2af8-44f4-9451-8107cb2767db"
    },
    {
      "name": "Doc updates",
      "id": "Doc updates;d6245f20-2af8-44f4-9451-8107cb2767db",
      "owner": {
        "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
        "displayName": "Normal Paulk",
        "uniqueName": "fabrikamfiber16@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
      },
      "createdDate": "2014-07-18T03:27:25.18Z",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/shelvesets/Doc%20updates%3bd6245f20-2af8-44f4-9451-8107cb2767db"
    },
    {
      "name": "Set this aside for now",
      "id": "Set this aside for now;8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
      "owner": {
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "createdDate": "2014-03-24T20:32:25.37Z",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/shelvesets/Set%20this%20aside%20for%20now%3b8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
    }
  ]
}

GET a list of shelveset refs with top and skip.

示例请求

GET https://dev.azure.com/fabrikam/_apis/tfvc/shelvesets?$top=2&$skip=2&api-version=7.1

示例响应

状态代码:
200 
{
  "count": 2,
  "value": [
    {
      "name": "Doc updates",
      "id": "Doc updates;d6245f20-2af8-44f4-9451-8107cb2767db",
      "owner": {
        "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
        "displayName": "Normal Paulk",
        "uniqueName": "fabrikamfiber16@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
      },
      "createdDate": "2014-07-18T03:27:25.18Z",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/shelvesets/Doc%20updates%3bd6245f20-2af8-44f4-9451-8107cb2767db"
    },
    {
      "name": "Set this aside for now",
      "id": "Set this aside for now;8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
      "owner": {
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "createdDate": "2014-03-24T20:32:25.37Z",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/shelvesets/Set%20this%20aside%20for%20now%3b8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
    }
  ]
}

GET a list of shelveset refs.

示例请求

GET https://dev.azure.com/fabrikam/_apis/tfvc/shelvesets?api-version=7.1

示例响应

状态代码:
200 
{
  "count": 4,
  "value": [
    {
      "name": "My first shelveset",
      "id": "My first shelveset;d6245f20-2af8-44f4-9451-8107cb2767db",
      "owner": {
        "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
        "displayName": "Normal Paulk",
        "uniqueName": "fabrikamfiber16@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
      },
      "createdDate": "2014-07-18T03:37:52.277Z",
      "comment": "Here is a really long comment describing this shelveset.",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/shelvesets/My%20first%20shelveset%3bd6245f20-2af8-44f4-9451-8107cb2767db"
    },
    {
      "name": "More changes",
      "id": "More changes;d6245f20-2af8-44f4-9451-8107cb2767db",
      "owner": {
        "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
        "displayName": "Normal Paulk",
        "uniqueName": "fabrikamfiber16@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
      },
      "createdDate": "2014-07-18T03:29:45.91Z",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/shelvesets/More%20changes%3bd6245f20-2af8-44f4-9451-8107cb2767db"
    },
    {
      "name": "Doc updates",
      "id": "Doc updates;d6245f20-2af8-44f4-9451-8107cb2767db",
      "owner": {
        "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
        "displayName": "Normal Paulk",
        "uniqueName": "fabrikamfiber16@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
      },
      "createdDate": "2014-07-18T03:27:25.18Z",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/shelvesets/Doc%20updates%3bd6245f20-2af8-44f4-9451-8107cb2767db"
    },
    {
      "name": "Set this aside for now",
      "id": "Set this aside for now;8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
      "owner": {
        "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabrikamfiber3@hotmail.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
      },
      "createdDate": "2014-03-24T20:32:25.37Z",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/shelvesets/Set%20this%20aside%20for%20now%3b8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
    }
  ]
}

定义

名称 说明
IdentityRef
ReferenceLinks

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

浅层货架集的元数据。

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 是指向此图形主题的源资源的完整路由。
Object

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

名称 类型 说明
links

object

链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读链接。

TfvcShelvesetRef

Object

浅层货架集的元数据。

名称 类型 说明
_links

ReferenceLinks

货架集的参考链接列表。
comment

string

搁置集注释。
commentTruncated

boolean

已截断的搁置集注释（如果适用）。
createdDate

string (date-time)

货架集创建日期。
id

string

货架 ID。
name

string

搁置集名称。
owner

IdentityRef

货架所有者。
url

string

货架 URL。