İngilizce dilinde oku

Aracılığıyla paylaş

Pull Request Statuses - Create

  • Başvuru
Service:
Git
API Version:
7.1-preview.1

Çekme isteği durumu oluşturun.

Durum için gereken tek alan, durumu benzersiz olarak tanımlamasıdır Context.Name . Durumu yinelemeye göndermek için istek gövdesinde iterationId belirtebileceğinizi unutmayın.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
organization
 path True

string

Azure DevOps kuruluşunun adı.
pullRequestId
 path True

integer

int32

Çekme isteğinin kimliği.
repositoryId
 path True

string

Çekme isteğinin hedef dalının depo kimliği.
project
 path

string

Proje Kimliği veya proje adı
api-version
 query True

string

Kullanılacak API sürümü. Api'nin bu sürümünü kullanmak için bu değer '7.1-preview.1' olarak ayarlanmalıdır.

İstek Gövdesi

Name Tür Description
_links

ReferenceLinks

Başvuru bağlantıları.
context

GitStatusContext

Durumun bağlamı.
createdBy

IdentityRef

Durumu oluşturan kimlik.
creationDate

string

Durumun oluşturulma tarihi ve saati.
description

string

Durum açıklaması. Genellikle durumun geçerli durumunu açıklar.
id

integer

Durum tanımlayıcısı.
iterationId

integer

Durumu ilişkilendirilecek yinelemenin kimliği. En düşük değer 1'dir.
properties

PropertiesCollection

Durumun özel özellikleri.
state

GitStatusState

Durumun durumu.
targetUrl

string

Durum ayrıntılarını içeren URL.
updatedDate

string

Durumun son güncelleştirme tarihi ve saati.

Yanıtlar

Name Tür Description
200 OK

GitPullRequestStatus

başarılı işlem

Güvenlik

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_write Kaynak kodu okuma, güncelleştirme ve silme, işlemeler, değişiklik kümeleri, dallar ve diğer sürüm denetimi yapıtları hakkındaki meta verilere erişme olanağı verir. Ayrıca çekme istekleri ve kod incelemeleri oluşturup yönetme ve hizmet kancaları aracılığıyla sürüm denetimi olayları hakkında bildirim alma olanağı sağlar.
vso.code_status İşleme ve çekme isteği durumunu okuma ve yazma yeteneği verir.

Örnekler

On iteration
On pull request
With properties

On iteration

Sample Request

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

{
  "iterationId": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-2",
    "genre": "vsts-samples"
  },
  "targetUrl": "http://fabrikam-fiber-inc.com/CI/builds/1"
}

Sample Response

Status code:
200
JSON 
{
  "iterationId": 1,
  "id": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-2",
    "genre": "vsts-samples"
  },
  "creationDate": "2017-09-19T14:50:26.4429056Z",
  "updatedDate": "2017-09-19T14:50:26.4429056Z",
  "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/2/statuses/1"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/b92c8408-a0c9-4292-88af-bc005a1b8272"
    }
  }
}

On pull request

Sample Request

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

{
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-4",
    "genre": "vsts-samples"
  },
  "targetUrl": "http://fabrikam-fiber-inc.com/CI/builds/1"
}

Sample Response

Status code:
200
JSON 
{
  "id": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-4",
    "genre": "vsts-samples"
  },
  "creationDate": "2017-09-19T14:50:25.1680228Z",
  "updatedDate": "2017-09-19T14:50:25.1680228Z",
  "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/1/statuses/1"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/b92c8408-a0c9-4292-88af-bc005a1b8272"
    }
  }
}

With properties

Sample Request

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

{
  "properties": {
    "sampleId": 7,
    "customInfo": "Custom status information",
    "startedDateTime": {
      "$type": "System.DateTime",
      "$value": "2017-09-19T14:50:26.7410146Z"
    },
    "weight": {
      "$type": "System.Double",
      "$value": 1.75
    },
    "bytes": {
      "$type": "System.Byte[]",
      "$value": "dGhpcyBpcyBzYW1wbGUgYmFzZTY0IGVuY29kZWQgc3RyaW5n"
    },
    "globalId": {
      "$type": "System.Guid",
      "$value": "1e788cb9-9d3d-4dc6-ac05-822092d17f90"
    }
  },
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-1",
    "genre": "vsts-samples"
  },
  "targetUrl": "http://fabrikam-fiber-inc.com/CI/builds/1"
}

Sample Response

Status code:
200
JSON 
{
  "properties": {
    "bytes": {
      "$type": "System.Byte[]",
      "$value": "dGhpcyBpcyBzYW1wbGUgYmFzZTY0IGVuY29kZWQgc3RyaW5n"
    },
    "customInfo": {
      "$type": "System.String",
      "$value": "Custom status information"
    },
    "globalId": {
      "$type": "System.String",
      "$value": "1e788cb99d3d4dc6ac05822092d17f90"
    },
    "sampleId": {
      "$type": "System.Int32",
      "$value": 7
    },
    "startedDateTime": {
      "$type": "System.DateTime",
      "$value": "2017-09-19T14:50:26.74Z"
    },
    "weight": {
      "$type": "System.Double",
      "$value": 1.75
    }
  },
  "id": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-1",
    "genre": "vsts-samples"
  },
  "creationDate": "2017-09-19T14:50:26.7780242Z",
  "updatedDate": "2017-09-19T14:50:26.7780242Z",
  "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/3/statuses/1"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/b92c8408-a0c9-4292-88af-bc005a1b8272"
    }
  }
}

Tanımlar

Name Description
GitPullRequestStatus

Bu sınıf, bir hizmet/uzantı gönderme çekme isteği durumunun meta verilerini içerir. Durum bir çekme isteği veya yineleme ile ilişkilendirilebilir.
GitStatusContext

Durumu benzersiz olarak tanımlayan durum bağlamı.
GitStatusState

Durumun durumu.
IdentityRef
PropertiesCollection

sınıfı, anahtar-değer çiftleri koleksiyonu olarak bir özellik çantasını temsil eder. Dışındaki DBNull tüm ilkel türlerin (ile herhangi bir TypeCode != TypeCode.Objecttür) değerleri kabul edilir. Byte[], Int32, Double, DateType ve String türündeki değerler türlerini korur, diğer temel öğeler Dize olarak retuned edilir. Byte[] base64 kodlanmış dize olarak bekleniyor.
ReferenceLinks

REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.

GitPullRequestStatus

Bu sınıf, bir hizmet/uzantı gönderme çekme isteği durumunun meta verilerini içerir. Durum bir çekme isteği veya yineleme ile ilişkilendirilebilir.

Name Tür Description
_links

ReferenceLinks

Başvuru bağlantıları.
context

GitStatusContext

Durumun bağlamı.
createdBy

IdentityRef

Durumu oluşturan kimlik.
creationDate

string

Durumun oluşturulma tarihi ve saati.
description

string

Durum açıklaması. Genellikle durumun geçerli durumunu açıklar.
id

integer

Durum tanımlayıcısı.
iterationId

integer

Durumu ilişkilendirilecek yinelemenin kimliği. En düşük değer 1'dir.
properties

PropertiesCollection

Durumun özel özellikleri.
state

GitStatusState

Durumun durumu.
targetUrl

string

Durum ayrıntılarını içeren URL.
updatedDate

string

Durumun son güncelleştirme tarihi ve saati.

GitStatusContext

Durumu benzersiz olarak tanımlayan durum bağlamı.

Name Tür Description
genre

string

Durumun türü. Genellikle durumu oluşturan hizmetin/aracın adı boş olabilir.
name

string

Durumun ad tanımlayıcısı null veya boş olamaz.

GitStatusState

Durumun durumu.

Name Tür Description
error

string

Hata içeren durum.
failed

string

Durum başarısız oldu.
notApplicable

string

Durum hedef nesne için geçerli değil.
notSet

string

Durum durumu ayarlanmadı. Varsayılan durum.
pending

string

Durum bekleniyor.
succeeded

string

Durum başarılı oldu.

IdentityRef

Name Tür Description
_links

ReferenceLinks

Bu alan, grafik konusu hakkında sıfır veya daha fazla ilgi çekici bağlantı içerir. Bu bağlantılar, bu grafik konusu hakkında daha fazla ilişki veya daha ayrıntılı bilgi edinmek için çağrılabilir.
descriptor

string

Tanımlayıcı, sistem çalışırken graf konusuna başvurmanın birincil yoludur. Bu alan, hem Hesaplar hem de Kuruluşlar genelinde aynı graf konusunu benzersiz olarak tanımlar.
directoryAlias

string

Kullanım dışı - IdentityRef "_links" sözlüğündeki "self" girişinde başvuruda bulunılan Graph kullanıcısı sorgulanarak alınabilir
displayName

string

Bu, grafik konusunun benzersiz olmayan görünen adıdır. Bu alanı değiştirmek için kaynak sağlayıcıdaki değerini değiştirmeniz gerekir.
id

string

imageUrl

string

Kullanım dışı - IdentityRef "_links" sözlüğün "avatar" girişinde kullanılabilir
inactive

boolean

Kullanım dışı - GraphUser "_links" sözlüğün "membershipState" girişinde başvurulan Graph üyelik durumu sorgulanarak alınabilir
isAadIdentity

boolean

Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer

boolean

Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Descriptor.IsGroupType)
isDeletedInOrigin

boolean

profileUrl

string

Kullanım dışı - ToIdentityRef'in önceden var olan uygulamalarının çoğunda kullanımda değil
uniqueName

string

Kullanım dışı - bunun yerine Domain+PrincipalName kullanın
url

string

Bu URL, bu grafik konusunun kaynak kaynağına giden tam yoldur.

PropertiesCollection

sınıfı, anahtar-değer çiftleri koleksiyonu olarak bir özellik çantasını temsil eder. Dışındaki DBNull tüm ilkel türlerin (ile herhangi bir TypeCode != TypeCode.Objecttür) değerleri kabul edilir. Byte[], Int32, Double, DateType ve String türündeki değerler türlerini korur, diğer temel öğeler Dize olarak retuned edilir. Byte[] base64 kodlanmış dize olarak bekleniyor.

Name Tür Description
count

integer

Koleksiyondaki özelliklerin sayısı.
item

object

keys

string[]

Koleksiyondaki anahtar kümesi.
values

string[]

Koleksiyondaki değer kümesi.

REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.

Name Tür Description
links

object

Bağlantıların salt okunur görünümü. Başvuru bağlantıları salt okunur olduğundan, bunları yalnızca salt okunur olarak göstermek istiyoruz.