Pull Request Statuses - Get

Layanan:
Git
Versi API:
4.1-preview.1

Dapatkan status permintaan pull tertentu berdasarkan ID. ID status unik dalam permintaan pull di semua iterasi.

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses/{statusId}?api-version=4.1-preview.1

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
organization
 path True

string

Nama organisasi Azure DevOps.
pullRequestId
 path True

integer (int32)

ID permintaan pull.
repositoryId
 path True

string

ID repositori dari cabang target permintaan pull.
statusId
 path True

integer (int32)

ID status permintaan pull.
project
 path

string

ID proyek atau nama proyek
api-version
 query True

string

Versi API yang akan digunakan. Ini harus diatur ke '4.1-preview.1' untuk menggunakan versi api ini.

Respons

Nama Jenis Deskripsi
200 OK

GitPullRequestStatus

operasi berhasil

Keamanan

oauth2

Jenis: oauth2
Alur: accessCode
URL Otorisasi: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL token: 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

Cakupan

Nama Deskripsi
vso.code Memberikan kemampuan untuk membaca kode sumber dan metadata tentang penerapan, set perubahan, cabang, dan artefak kontrol versi lainnya. Juga memberikan kemampuan untuk mendapatkan pemberitahuan tentang peristiwa kontrol versi melalui kait layanan.
vso.code_status Memberikan kemampuan untuk membaca dan menulis status penerapan dan permintaan pull.

Contoh

Permintaan sampel

GET https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses/{statusId}?api-version=4.1-preview.1

Respon sampel

Kode status:
200 
{
  "id": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-1",
    "genre": "vsts-samples"
  },
  "creationDate": "2017-09-19T14:50:27.4949745Z",
  "updatedDate": "2017-09-19T14:50:27.4949745Z",
  "createdBy": {
    "id": "6f168adb-59d4-4fc0-be3b-fb21b939b2a6",
    "displayName": "Normal Paulk",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "url": "https://dev.azure.com/fabrikam/_apis/Identities/6f168adb-59d4-4fc0-be3b-fb21b939b2a6",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=6f168adb-59d4-4fc0-be3b-fb21b939b2a6"
  },
  "targetUrl": "http://fabrikam-fiber-inc.com/CI/builds/1",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/b92c8408-a0c9-4292-88af-bc005a1b8272/pullRequests/5/statuses/1"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/b92c8408-a0c9-4292-88af-bc005a1b8272"
    }
  }
}

Definisi

Nama Deskripsi
GitPullRequestStatus

Kelas ini berisi metadata status permintaan pull posting layanan/ekstensi. Status dapat dikaitkan dengan permintaan pull atau perulangan.
GitStatusContext

Konteks status yang secara unik mengidentifikasi status.
GitStatusState

Status status.
IdentityRef
PropertiesCollection

Kelas mewakili tas properti sebagai kumpulan pasangan kunci-nilai. Nilai semua jenis primitif (jenis apa pun dengan ) TypeCode != TypeCode.Objectkecuali DBNull diterima. Nilai jenis Byte[], Int32, Double, DateType dan String mempertahankan jenisnya, primitif lainnya disesuaikan sebagai String. Byte[] diharapkan sebagai string yang dikodekan base64.
ReferenceLinks

Kelas untuk mewakili kumpulan tautan referensi REST.

GitPullRequestStatus

Objek

Kelas ini berisi metadata status permintaan pull posting layanan/ekstensi. Status dapat dikaitkan dengan permintaan pull atau perulangan.

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.
iterationId

integer

ID perulangan untuk mengaitkan status. Nilai minimalnya adalah 1.
properties

PropertiesCollection

Properti kustom status.
state

GitStatusState

Status status.
targetUrl

string

URL dengan detail status.
updatedDate

string

Tanggal dan waktu pembaruan terakhir status.

GitStatusContext

Objek

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

Enumerasi

Status status.

Nilai Deskripsi
notSet

Status status tidak diatur. Status default.
pending

Status tertunda.
succeeded

Status berhasil.
failed

Status gagal.
error

Status dengan kesalahan.
notApplicable

Status tidak berlaku untuk objek target.

IdentityRef

Objek
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

profileUrl

string

uniqueName

string

url

string

Url ini adalah rute lengkap ke sumber daya sumber subjek grafik ini.

PropertiesCollection

Objek

Kelas mewakili tas properti sebagai kumpulan pasangan kunci-nilai. Nilai semua jenis primitif (jenis apa pun dengan ) TypeCode != TypeCode.Objectkecuali DBNull diterima. Nilai jenis Byte[], Int32, Double, DateType dan String mempertahankan jenisnya, primitif lainnya disesuaikan sebagai String. Byte[] diharapkan sebagai string yang dikodekan base64.

Nama Jenis Deskripsi
count

integer

Jumlah properti dalam koleksi.
item

object

keys

string[]

Sekumpulan kunci dalam koleksi.
values

string[]

Kumpulan nilai dalam koleksi.
Objek

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.