Refs - List

指定されたリポジトリに refs のクエリを実行し、それらを返します。

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs?api-version=7.1-preview.1
GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs?filter={filter}&includeLinks={includeLinks}&includeStatuses={includeStatuses}&includeMyBranches={includeMyBranches}&latestStatusesOnly={latestStatusesOnly}&peelTags={peelTags}&filterContains={filterContains}&$top={$top}&continuationToken={continuationToken}&api-version=7.1-preview.1

URI パラメーター

名前 / 必須 説明
organization
path True

string

Azure DevOps 組織の名前です。

repositoryId
path True

string

リポジトリの名前または ID。

project
path

string

プロジェクト ID またはプロジェクト名

api-version
query True

string

使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.1' に設定する必要があります。

$top
query

integer

int32

[省略可能]返される参照の最大数。 1000 より大きくすることはできません。 指定されていないが、continuationToken が の場合、top の既定値は 100 になります。

continuationToken
query

string

改ページ位置付けに使用される継続トークン。

filter
query

string

[省略可能]refs に適用するフィルター (で始まる)。

filterContains
query

string

[省略可能]refs に適用するフィルター (を含む)。

includeLinks
query

boolean

[省略可能]referenceLinks を結果に含めるかどうかを指定します。 既定値は false です。

includeMyBranches
query

boolean

[省略可能]ユーザーが所有するブランチ、ユーザーのお気に入りのブランチ、既定のブランチのみが含まれます。 既定値は false です。 filter パラメーターと組み合わせることはできません。

includeStatuses
query

boolean

[省略可能]各 ref の最初の 1,000 個までのコミット状態が含まれます。既定値は false です。

latestStatusesOnly
query

boolean

[省略可能]True を指定すると、各 ref のチップ コミット状態のみが含まれます。このオプションは true である必要 includeStatuses があります。 既定値は false です。

peelTags
query

boolean

[省略可能]注釈付きタグは、PeeledObjectId プロパティに設定されます。 既定値は false です。

応答

名前 説明
200 OK

GitRef[]

正常な操作

セキュリティ

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

名前 説明
vso.code コミット、変更セット、ブランチ、およびその他のバージョン管理成果物に関するソース コードとメタデータを読み取る機能を付与します。 また、コードを検索し、サービス フックを使用してバージョン管理イベントに関する通知を受け取る機能も付与されます。

Refs
Refs heads
Refs heads statuses
Refs heads that contain a word
Refs tags

Refs

Sample Request

GET https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/refs?api-version=7.1-preview.1

Sample Response

transfer-Encoding: chunked
{
  "value": [
    {
      "name": "refs/heads/feature/calcApp",
      "objectId": "ffe9cba521f00d7f60e322845072238635edb451",
      "creator": {
        "displayName": "Normal Paulk",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
          }
        },
        "id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "uniqueName": "dev@mailserver.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
      },
      "url": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_apis/git/repositories/d3d1760b-311c-4175-a726-20dfc6a7f885/refs?filter=heads%2Ffeature%2FcalcApp"
    },
    {
      "name": "refs/heads/feature/replacer",
      "objectId": "917131a709996c5cfe188c3b57e9a6ad90e8b85c",
      "creator": {
        "displayName": "Normal Paulk",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
          }
        },
        "id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "uniqueName": "dev@mailserver.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
      },
      "url": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_apis/git/repositories/d3d1760b-311c-4175-a726-20dfc6a7f885/refs?filter=heads%2Ffeature%2Freplacer"
    },
    {
      "name": "refs/heads/master",
      "objectId": "ffe9cba521f00d7f60e322845072238635edb451",
      "creator": {
        "displayName": "Normal Paulk",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
          }
        },
        "id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "uniqueName": "dev@mailserver.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
      },
      "url": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_apis/git/repositories/d3d1760b-311c-4175-a726-20dfc6a7f885/refs?filter=heads%2Fmaster"
    },
    {
      "name": "refs/remotes/origin/HEAD",
      "objectId": "ffe9cba521f00d7f60e322845072238635edb451",
      "creator": {
        "displayName": "Normal Paulk",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
          }
        },
        "id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "uniqueName": "dev@mailserver.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
      },
      "url": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_apis/git/repositories/d3d1760b-311c-4175-a726-20dfc6a7f885/refs?filter=remotes%2Forigin%2FHEAD"
    },
    {
      "name": "refs/remotes/origin/feature/replacer",
      "objectId": "467ffea40b630e5252f6e727caa7919d5f7a9444",
      "creator": {
        "displayName": "Normal Paulk",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
          }
        },
        "id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "uniqueName": "dev@mailserver.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
      },
      "url": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_apis/git/repositories/d3d1760b-311c-4175-a726-20dfc6a7f885/refs?filter=remotes%2Forigin%2Ffeature%2Freplacer"
    },
    {
      "name": "refs/remotes/origin/master",
      "objectId": "ffe9cba521f00d7f60e322845072238635edb451",
      "creator": {
        "displayName": "Normal Paulk",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
          }
        },
        "id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "uniqueName": "dev@mailserver.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
      },
      "url": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_apis/git/repositories/d3d1760b-311c-4175-a726-20dfc6a7f885/refs?filter=remotes%2Forigin%2Fmaster"
    },
    {
      "name": "refs/tags/v0.1",
      "objectId": "917131a709996c5cfe188c3b57e9a6ad90e8b85c",
      "creator": {
        "displayName": "Normal Paulk",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
          }
        },
        "id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "uniqueName": "dev@mailserver.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
      },
      "url": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_apis/git/repositories/d3d1760b-311c-4175-a726-20dfc6a7f885/refs?filter=tags%2Fv0.1"
    }
  ],
  "count": 7
}

Refs heads

Sample Request

GET https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/refs?filter=heads/&api-version=7.1-preview.1

Sample Response

transfer-Encoding: chunked
{
  "value": [
    {
      "name": "refs/heads/feature/calcApp",
      "objectId": "ffe9cba521f00d7f60e322845072238635edb451",
      "creator": {
        "displayName": "Normal Paulk",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
          }
        },
        "id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "uniqueName": "dev@mailserver.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
      },
      "url": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_apis/git/repositories/d3d1760b-311c-4175-a726-20dfc6a7f885/refs?filter=heads%2Ffeature%2FcalcApp"
    },
    {
      "name": "refs/heads/feature/replacer",
      "objectId": "917131a709996c5cfe188c3b57e9a6ad90e8b85c",
      "creator": {
        "displayName": "Normal Paulk",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
          }
        },
        "id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "uniqueName": "dev@mailserver.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
      },
      "url": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_apis/git/repositories/d3d1760b-311c-4175-a726-20dfc6a7f885/refs?filter=heads%2Ffeature%2Freplacer"
    },
    {
      "name": "refs/heads/master",
      "objectId": "ffe9cba521f00d7f60e322845072238635edb451",
      "creator": {
        "displayName": "Normal Paulk",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
          }
        },
        "id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "uniqueName": "dev@mailserver.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
      },
      "url": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_apis/git/repositories/d3d1760b-311c-4175-a726-20dfc6a7f885/refs?filter=heads%2Fmaster"
    }
  ],
  "count": 3
}

Refs heads statuses

Sample Request

GET https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/refs?filter=heads/&includeStatuses=True&api-version=7.1-preview.1

Sample Response

transfer-Encoding: chunked
{
  "value": [
    {
      "name": "refs/heads/feature/calcApp",
      "objectId": "ffe9cba521f00d7f60e322845072238635edb451",
      "creator": {
        "displayName": "Normal Paulk",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
          }
        },
        "id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "uniqueName": "dev@mailserver.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
      },
      "url": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_apis/git/repositories/d3d1760b-311c-4175-a726-20dfc6a7f885/refs?filter=heads%2Ffeature%2FcalcApp",
      "statuses": []
    },
    {
      "name": "refs/heads/feature/replacer",
      "objectId": "917131a709996c5cfe188c3b57e9a6ad90e8b85c",
      "creator": {
        "displayName": "Normal Paulk",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
          }
        },
        "id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "uniqueName": "dev@mailserver.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
      },
      "url": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_apis/git/repositories/d3d1760b-311c-4175-a726-20dfc6a7f885/refs?filter=heads%2Ffeature%2Freplacer",
      "statuses": [
        {
          "id": 203802,
          "state": "succeeded",
          "description": "MyProject-.NET Desktop-CI build succeeded",
          "context": {
            "name": "build/MyProject-.NET Desktop-CI",
            "genre": "continuous-integration"
          },
          "creationDate": "2018-07-10T12:45:26.35Z",
          "createdBy": {
            "displayName": "Microsoft.VisualStudio.Services.TFS",
            "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/00000002-0000-8888-8000-000000000000",
            "_links": {
              "avatar": {
                "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/s2s.MDAwMDAwMDItMDAwMC04ODg4LTgwMDAtMDAwMDAwMDAwMDAwQDJjODk1OTA4LTA0ZTAtNDk1Mi04OWZkLTU0YjAwNDZkNjI4OA"
              }
            },
            "id": "00000002-0000-8888-8000-000000000000",
            "uniqueName": "00000002-0000-8888-8000-000000000000@2c895908-04e0-4952-89fd-54b0046d6288",
            "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=00000002-0000-8888-8000-000000000000",
            "descriptor": "s2s.MDAwMDAwMDItMDAwMC04ODg4LTgwMDAtMDAwMDAwMDAwMDAwQDJjODk1OTA4LTA0ZTAtNDk1Mi04OWZkLTU0YjAwNDZkNjI4OA"
          },
          "targetUrl": "vstfs:///Build/Build/2"
        },
        {
          "id": 203797,
          "state": "pending",
          "description": "MyProject-.NET Desktop-CI build running",
          "context": {
            "name": "build/MyProject-.NET Desktop-CI",
            "genre": "continuous-integration"
          },
          "creationDate": "2018-07-10T12:42:05.237Z",
          "createdBy": {
            "displayName": "Microsoft.VisualStudio.Services.TFS",
            "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/00000002-0000-8888-8000-000000000000",
            "_links": {
              "avatar": {
                "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/s2s.MDAwMDAwMDItMDAwMC04ODg4LTgwMDAtMDAwMDAwMDAwMDAwQDJjODk1OTA4LTA0ZTAtNDk1Mi04OWZkLTU0YjAwNDZkNjI4OA"
              }
            },
            "id": "00000002-0000-8888-8000-000000000000",
            "uniqueName": "00000002-0000-8888-8000-000000000000@2c895908-04e0-4952-89fd-54b0046d6288",
            "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=00000002-0000-8888-8000-000000000000",
            "descriptor": "s2s.MDAwMDAwMDItMDAwMC04ODg4LTgwMDAtMDAwMDAwMDAwMDAwQDJjODk1OTA4LTA0ZTAtNDk1Mi04OWZkLTU0YjAwNDZkNjI4OA"
          },
          "targetUrl": "vstfs:///Build/Build/2"
        },
        {
          "id": 203796,
          "state": "pending",
          "description": "MyProject-.NET Desktop-CI build queued",
          "context": {
            "name": "build/MyProject-.NET Desktop-CI",
            "genre": "continuous-integration"
          },
          "creationDate": "2018-07-10T12:42:02.893Z",
          "createdBy": {
            "displayName": "Microsoft.VisualStudio.Services.TFS",
            "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/00000002-0000-8888-8000-000000000000",
            "_links": {
              "avatar": {
                "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/s2s.MDAwMDAwMDItMDAwMC04ODg4LTgwMDAtMDAwMDAwMDAwMDAwQDJjODk1OTA4LTA0ZTAtNDk1Mi04OWZkLTU0YjAwNDZkNjI4OA"
              }
            },
            "id": "00000002-0000-8888-8000-000000000000",
            "uniqueName": "00000002-0000-8888-8000-000000000000@2c895908-04e0-4952-89fd-54b0046d6288",
            "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=00000002-0000-8888-8000-000000000000",
            "descriptor": "s2s.MDAwMDAwMDItMDAwMC04ODg4LTgwMDAtMDAwMDAwMDAwMDAwQDJjODk1OTA4LTA0ZTAtNDk1Mi04OWZkLTU0YjAwNDZkNjI4OA"
          },
          "targetUrl": "vstfs:///Build/Build/2"
        }
      ]
    },
    {
      "name": "refs/heads/master",
      "objectId": "ffe9cba521f00d7f60e322845072238635edb451",
      "creator": {
        "displayName": "Normal Paulk",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
          }
        },
        "id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "uniqueName": "dev@mailserver.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
      },
      "url": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_apis/git/repositories/d3d1760b-311c-4175-a726-20dfc6a7f885/refs?filter=heads%2Fmaster",
      "statuses": []
    }
  ],
  "count": 3
}

Refs heads that contain a word

Sample Request

GET https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/refs?filter=heads/&filterContains=replacer&api-version=7.1-preview.1

Sample Response

transfer-Encoding: chunked
{
  "value": [
    {
      "name": "refs/heads/feature/replacer",
      "objectId": "917131a709996c5cfe188c3b57e9a6ad90e8b85c",
      "creator": {
        "displayName": "Normal Paulk",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
          }
        },
        "id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "uniqueName": "dev@mailserver.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
      },
      "url": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_apis/git/repositories/d3d1760b-311c-4175-a726-20dfc6a7f885/refs?filter=heads%2Ffeature%2Freplacer"
    }
  ],
  "count": 1
}

Refs tags

Sample Request

GET https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/refs?filter=tags/&api-version=7.1-preview.1

Sample Response

transfer-Encoding: chunked
{
  "value": [
    {
      "name": "refs/tags/v0.1",
      "objectId": "917131a709996c5cfe188c3b57e9a6ad90e8b85c",
      "creator": {
        "displayName": "Normal Paulk",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
          }
        },
        "id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "uniqueName": "dev@mailserver.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
        "descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
      },
      "url": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_apis/git/repositories/d3d1760b-311c-4175-a726-20dfc6a7f885/refs?filter=tags%2Fv0.1"
    }
  ],
  "count": 1
}

定義

名前 説明
GitRef
GitStatus

このクラスには、状態を投稿するサービス/拡張機能のメタデータが含まれています。

GitStatusContext

状態を一意に識別する状態コンテキスト。

GitStatusState

状態の状態。

IdentityRef
ReferenceLinks

REST 参照リンクのコレクションを表す クラス。

GitRef

名前 説明
_links

ReferenceLinks

REST 参照リンクのコレクションを表す クラス。

creator

IdentityRef

isLocked

boolean

isLockedBy

IdentityRef

name

string

objectId

string

peeledObjectId

string

statuses

GitStatus[]

このクラスには、状態を投稿するサービス/拡張機能のメタデータが含まれています。

url

string

GitStatus

このクラスには、状態を投稿するサービス/拡張機能のメタデータが含まれています。

名前 説明
_links

ReferenceLinks

参照リンク。

context

GitStatusContext

状態のコンテキスト。

createdBy

IdentityRef

状態を作成した ID。

creationDate

string

状態の作成日時。

description

string

状態の説明。 通常、状態の現在の状態について説明します。

id

integer

状態識別子。

state

GitStatusState

状態の状態。

targetUrl

string

状態の詳細を含む URL。

updatedDate

string

状態の最終更新日時。

GitStatusContext

状態を一意に識別する状態コンテキスト。

名前 説明
genre

string

状態のジャンル。 通常、状態を生成するサービスまたはツールの名前は空にすることができます。

name

string

状態の名前識別子を null または空にすることはできません。

GitStatusState

状態の状態。

名前 説明
error

string

エラーが発生した状態。

failed

string

状態が失敗しました。

notApplicable

string

状態はターゲット オブジェクトには適用されません。

notSet

string

状態の状態が設定されていません。 既定の状態です。

pending

string

状態は保留中です。

succeeded

string

状態が成功しました。

IdentityRef

名前 説明
_links

ReferenceLinks

このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。 これらのリンクを呼び出して、このグラフの主題に関する追加のリレーションシップや詳細情報を取得できます。

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

非推奨 - 記述子のサブジェクト型 (Descriptor.IsGroupType) から推論できます

isDeletedInOrigin

boolean

profileUrl

string

非推奨 - ToIdentityRef の既存のほとんどの実装では使用されていません

uniqueName

string

非推奨 - 代わりに Domain+PrincipalName を使用します

url

string

この URL は、このグラフの件名のソース リソースへの完全なルートです。

REST 参照リンクのコレクションを表す クラス。

名前 説明
links

object

リンクの読み取り時ビュー。 参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。