Shelvesets - List

Service:: Tfvc

API Version:: 7.1

Return a collection of shallow shelveset references.

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

With optional parameters:

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 Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
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.
$skip	query		integer (int32)	Number of shelvesets to skip
$top	query		integer (int32)	Max number of shelvesets to return
requestData.includeDetails	query		boolean	Whether to include policyOverride and notes Only applies when requesting a single deep shelveset
requestData.includeLinks	query		boolean	Whether to include the _links field on the shallow references. Does not apply when requesting a single deep shelveset object. Links will always be included in the deep shelveset.
requestData.includeWorkItems	query		boolean	Whether to include workItems
requestData.maxChangeCount	query		integer (int32)	Max number of changes to include
requestData.maxCommentLength	query		integer (int32)	Max length of comment
requestData.name	query		string	Shelveset name
requestData.owner	query		string	Owner's ID. Could be a name or a guid.

Responses

Name	Type	Description
200 OK	TfvcShelvesetRef[]	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.

Examples

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.

Sample request

HTTP

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

Sample response

Status code:: 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.

Sample request

HTTP

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

Sample response

Status code:: 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.

Sample request

HTTP

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

Sample response

Status code:: 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.

Sample request

HTTP

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

Sample response

Status code:: 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"
    }
  ]
}

Definitions

Name	Description
IdentityRef
ReferenceLinks	The class to represent a collection of REST reference links.
TfvcShelvesetRef	Metadata for a shallow shelveset.

IdentityRef

Object

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	Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary
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	Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary
inactive	boolean	Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary
isAadIdentity	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Deprecated - not in use in most preexisting implementations of ToIdentityRef
uniqueName	string	Deprecated - use Domain+PrincipalName instead
url	string	This url is the full route to the source resource of this graph subject.

ReferenceLinks

Object

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.

TfvcShelvesetRef

Object

Metadata for a shallow shelveset.

Name	Type	Description
_links	ReferenceLinks	List of reference links for the shelveset.
comment	string	Shelveset comment.
commentTruncated	boolean	Shelveset comment truncated as applicable.
createdDate	string (date-time)	Shelveset create date.
id	string	Shelveset Id.
name	string	Shelveset name.
owner	IdentityRef	Shelveset Owner.
url	string	Shelveset Url.

Share via

Shelvesets - List

URI Parameters

Responses

Security

oauth2

Scopes

Examples

GET a list of shelveset refs for a specific Owner.

Sample request

Sample response

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

Sample request

Sample response

GET a list of shelveset refs with top and skip.

Sample request

Sample response

GET a list of shelveset refs.

Sample request

Sample response

Definitions

IdentityRef

ReferenceLinks

TfvcShelvesetRef