Refs - Update Ref

Referensi

Service:: Git

API Version:: 5.0

Kunci atau Buka kunci cabang.

PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs?filter={filter}&api-version=5.0

With optional parameters:

PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs?filter={filter}&projectId={projectId}&api-version=5.0

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
organization	path	True	string	Nama organisasi Azure DevOps.
repositoryId	path	True	string	Nama atau ID repositori.
project	path		string	ID proyek atau nama proyek
api-version	query	True	string	Versi API yang akan digunakan. Ini harus diatur ke '5.0' untuk menggunakan versi api ini.
filter	query	True	string	Nama cabang yang akan dikunci/dibuka kuncinya
projectId	query		string	ID atau nama proyek tim. Opsional jika menentukan ID untuk repositori.

Isi Permintaan

Nama	Jenis	Deskripsi
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string

Respons

Nama	Jenis	Deskripsi
200 OK	GitRef	operasi berhasil

Keamanan

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

Nama	Deskripsi
vso.code_write	Memberikan kemampuan untuk membaca, memperbarui, dan menghapus kode sumber, mengakses metadata tentang penerapan, set perubahan, cabang, dan artefak kontrol versi lainnya. Juga memberikan kemampuan untuk membuat dan mengelola permintaan pull dan ulasan kode dan untuk menerima pemberitahuan tentang peristiwa kontrol versi melalui hook layanan.

Contoh

Lock/unlock branch

Sample Request

HTTP

PATCH https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/refs?filter=heads/master&api-version=5.0

{
  "isLocked": true
}

Sample Response

Status code:: 200

{
  "name": "refs/heads/master",
  "objectId": "ffe9cba521f00d7f60e322845072238635edb451",
  "isLockedBy": {
    "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"
  },
  "isLocked": true,
  "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"
}

Definisi

Nama	Deskripsi
GitRef
GitRefUpdate
GitStatus	Kelas ini berisi metadata layanan/ekstensi yang memposting status.
GitStatusContext	Konteks status yang secara unik mengidentifikasi status.
GitStatusState	Status status.
IdentityRef
ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.

GitRef

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
creator	IdentityRef
isLocked	boolean
isLockedBy	IdentityRef
name	string
objectId	string
peeledObjectId	string
statuses	GitStatus[]	Kelas ini berisi metadata layanan/ekstensi yang memposting status.
url	string

GitRefUpdate

Nama	Jenis	Deskripsi
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string

GitStatus

Kelas ini berisi metadata layanan/ekstensi yang memposting status.

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Tautan referensi.
context	GitStatusContext	Konteks status.
createdBy	IdentityRef	Identitas yang membuat status.
creationDate	string	Tanggal pembuatan dan waktu status.
description	string	Deskripsi status. Biasanya menjelaskan status status saat ini.
id	integer	Pengidentifikasi status.
state	GitStatusState	Status status.
targetUrl	string	URL dengan detail status.
updatedDate	string	Tanggal dan waktu pembaruan terakhir status.

GitStatusContext

Konteks status yang secara unik mengidentifikasi status.

Nama	Jenis	Deskripsi
genre	string	Genre status. Biasanya nama layanan/alat yang menghasilkan status, bisa kosong.
name	string	Pengidentifikasi nama status, tidak boleh null atau kosong.

GitStatusState

Status status.

Nama	Jenis	Deskripsi
error	string	Status dengan kesalahan.
failed	string	Status gagal.
notApplicable	string	Status tidak berlaku untuk objek target.
notSet	string	Status status tidak diatur. Status default.
pending	string	Status tertunda.
succeeded	string	Status berhasil.

IdentityRef

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Bidang ini berisi nol atau lebih tautan menarik tentang subjek grafik. Tautan ini dapat dipanggil untuk mendapatkan hubungan tambahan atau informasi lebih rinci tentang subjek grafik ini.
descriptor	string	Deskriptor adalah cara utama untuk mereferensikan subjek grafik saat sistem berjalan. Bidang ini akan mengidentifikasi subjek grafik yang sama secara unik di seluruh Akun dan Organisasi.
directoryAlias	string
displayName	string	Ini adalah nama tampilan subjek grafik yang tidak unik. Untuk mengubah bidang ini, Anda harus mengubah nilainya di penyedia sumber.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Url ini adalah rute lengkap ke sumber daya sumber subjek grafik ini.

ReferenceLinks

Kelas untuk mewakili kumpulan tautan referensi REST.

Nama	Jenis	Deskripsi
links	object	Tampilan baca-saja dari tautan. Karena tautan Referensi dibaca saja, kami hanya ingin mengeksposnya sebagai baca-saja.

Bagikan melalui