Branches - Get Branches

Referenz

Dienst:: Tfvc

API-Version:: 7.1

Dient zum Abrufen einer Sammlung von Verzweigungswurzeln – untergeordnete Untergeordnete Elemente, Zweige ohne Eltern.

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

Mit optionalen Parametern:

GET https://dev.azure.com/{organization}/{project}/_apis/tfvc/branches?includeParent={includeParent}&includeChildren={includeChildren}&includeDeleted={includeDeleted}&includeLinks={includeLinks}&api-version=7.1

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
project	path		string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1" festgelegt werden, um diese Version der API zu verwenden.
includeChildren	query		boolean	Gibt die untergeordneten Verzweigungen für jeden Stammzweig zurück. Standard: False
includeDeleted	query		boolean	Gibt gelöschte Verzweigungen zurück. Standard: False
includeLinks	query		boolean	Gibt Links zurück. Standard: False
includeParent	query		boolean	Gibt die übergeordnete Verzweigung zurück, falls vorhanden. Standard: False

Antworten

Name	Typ	Beschreibung
200 OK	TfvcBranch[]	Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name	Beschreibung
vso.code	Gewährt die Möglichkeit, Quellcode und Metadaten zu Commits, Changesets, Verzweigungen und anderen Versionskontrollartefakten zu lesen. Gewährt außerdem die Möglichkeit, Code zu durchsuchen und über Dienst-Hooks über Versionssteuerungsereignisse benachrichtigt zu werden.

Beispiele

GET a list of root branches

GET a list of root branches with children

GET a list of root branches with deleted

GET a list of root branches

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "count": 1,
  "value": [
    {
      "path": "$/Fabrikam-Fiber-TFVC/AuthSample",
      "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-24T16:25:17.39Z",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/branches/%24/Fabrikam-Fiber-TFVC/AuthSample",
      "relatedBranches": [],
      "mappings": []
    }
  ]
}

GET a list of root branches with children

Beispielanforderung

HTTP

GET https://dev.azure.com/fabrikam/_apis/tfvc/branches?includeChildren=true&api-version=7.1

Beispiel für eine Antwort

Statuscode:: 200

{
  "count": 1,
  "value": [
    {
      "path": "$/Fabrikam-Fiber-TFVC/AuthSample",
      "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-24T16:25:17.39Z",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/branches/%24/Fabrikam-Fiber-TFVC/AuthSample",
      "relatedBranches": [],
      "mappings": [],
      "children": [
        {
          "path": "$/Fabrikam-Fiber-TFVC/AuthSample-dev",
          "description": "",
          "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-24T16:46:48.253Z",
          "url": "https://dev.azure.com/fabrikam/_apis/tfvc/branches/%24/Fabrikam-Fiber-TFVC/AuthSample-dev",
          "relatedBranches": [],
          "mappings": [],
          "children": [
            {
              "path": "$/Fabrikam-Fiber-TFVC/AuthSample+Special",
              "description": "Branched from $/Fabrikam-Fiber-TFVC/AuthSample-dev",
              "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-24T16:52:10.407Z",
              "url": "https://dev.azure.com/fabrikam/_apis/tfvc/branches/%24/Fabrikam-Fiber-TFVC/AuthSample%2bSpecial",
              "relatedBranches": [],
              "mappings": [],
              "children": []
            }
          ]
        }
      ]
    }
  ]
}

GET a list of root branches with deleted

Beispielanforderung

HTTP

GET https://dev.azure.com/fabrikam/_apis/tfvc/branches?includeDeleted=true&api-version=7.1

Beispiel für eine Antwort

Statuscode:: 200

{
  "count": 2,
  "value": [
    {
      "path": "$/Fabrikam-Fiber-TFVC/AuthSample",
      "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-24T16:25:17.39Z",
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/branches/%24/Fabrikam-Fiber-TFVC/AuthSample",
      "relatedBranches": [
        {
          "path": "$/Fabrikam-Fiber-TFVC/MyBranch"
        }
      ],
      "mappings": []
    },
    {
      "path": "$/Fabrikam-Fiber-TFVC/MyBranch",
      "description": "Branched from $/Fabrikam-Fiber-TFVC/AuthSample",
      "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-24T16:44:13.277Z",
      "isDeleted": true,
      "url": "https://dev.azure.com/fabrikam/_apis/tfvc/branches/%24/Fabrikam-Fiber-TFVC/MyBranch",
      "relatedBranches": [
        {
          "path": "$/Fabrikam-Fiber-TFVC/AuthSample"
        }
      ],
      "mappings": []
    }
  ]
}

Definitionen

Name	Beschreibung
IdentityRef
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
TfvcBranch	Klasse, die ein Verzweigungsobjekt darstellt.
TfvcBranchMapping	Eine Verzweigungszuordnung.
TfvcShallowBranchRef	Dies ist die flache Branchref-Klasse.

IdentityRef

Objekt

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Thema Diagramm. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Diagrammbetreff zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Möglichkeit, auf den Diagrammbetreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird dasselbe Diagrammthema sowohl in Firmen als auch in Organisationen eindeutig identifiziert.
directoryAlias	string	Veraltet – Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im "Self"-Eintrag des IdentityRef -Wörterbuchs "_links" verwiesen wird
displayName	string	Dies ist der nicht eindeutige Anzeigename des Diagrammbetreffs. Um dieses Feld zu ändern, müssen Sie den Wert im Quellanbieter ändern.
id	string
imageUrl	string	Veraltet – Verfügbar im "Avatar"-Eintrag des IdentityRef-Wörterbuchs "_links"
inactive	boolean	Veraltet – Kann abgerufen werden, indem der Graph-Mitgliedschaftsstatus abgefragt wird, auf den im Eintrag "membershipState" des GraphUser-Wörterbuchs "_links" verwiesen wird.
isAadIdentity	boolean	Veraltet – Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Veraltet – Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Veraltet – nicht in den meisten bereits vorhandenen Implementierungen von ToIdentityRef verwendet
uniqueName	string	Veraltet – Verwenden Sie stattdessen "Domain+PrincipalName".
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

ReferenceLinks

Objekt

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Referenzlinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

TfvcBranch

Objekt

Klasse, die ein Verzweigungsobjekt darstellt.

Name	Typ	Beschreibung
_links	ReferenceLinks	Eine Sammlung von REST-Referenzverknüpfungslinks.
children	TfvcBranch[]	Liste der untergeordneten Elemente für die Verzweigung.
createdDate	string (date-time)	Erstellungsdatum der Verzweigung.
description	string	Verzweigungsbeschreibung.
isDeleted	boolean	Wird die Verzweigung gelöscht?
mappings	TfvcBranchMapping[]	Liste der Verzweigungszuordnungen.
owner	IdentityRef	Alias oder Anzeigename des Benutzers
parent	TfvcShallowBranchRef	Pfad des übergeordneten Elements der Verzweigung.
path	string	Pfad für die Verzweigung.
relatedBranches	TfvcShallowBranchRef[]	Liste der Pfade der verwandten Verzweigungen.
url	string	URL zum Abrufen des Elements.

TfvcBranchMapping

Objekt

Eine Verzweigungszuordnung.

Name	Typ	Beschreibung
depth	string	Tiefe des Zweigs.
serverItem	string	Serverelement für die Verzweigung.
type	string	Typ der Verzweigung.

TfvcShallowBranchRef

Objekt

Dies ist die flache Branchref-Klasse.

Name	Typ	Beschreibung
path	string	Pfad für die Verzweigung.

Freigeben über

Branches - Get Branches

URI-Parameter

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

GET a list of root branches

Beispielanforderung

Beispiel für eine Antwort

GET a list of root branches with children

Beispielanforderung

Beispiel für eine Antwort

GET a list of root branches with deleted

Beispielanforderung

Beispiel für eine Antwort

Definitionen

IdentityRef

ReferenceLinks

TfvcBranch

TfvcBranchMapping

TfvcShallowBranchRef