Udostępnij za pośrednictwem


Pull Request Statuses - Create

Utwórz stan żądania ściągnięcia.

Jedynym polem wymaganym dla stanu jest to Context.Name , że jednoznacznie identyfikuje stan. Pamiętaj, że w treści żądania można określić identyfikator iteracji, aby opublikować stan w iteracji.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
organization
path True

string

Nazwa organizacji usługi Azure DevOps.

pullRequestId
path True

integer

int32

Identyfikator żądania ściągnięcia.

repositoryId
path True

string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

project
path

string

Identyfikator projektu lub nazwa projektu

api-version
query True

string

Wersja interfejsu API do użycia. Ta wartość powinna być ustawiona na wartość "7.1-preview.1", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa Typ Opis
_links

ReferenceLinks

Linki referencyjne.

context

GitStatusContext

Kontekst stanu.

createdBy

IdentityRef

Tożsamość, która utworzyła stan.

creationDate

string

Data i godzina utworzenia stanu.

description

string

Opis stanu. Zazwyczaj opisuje bieżący stan stanu.

id

integer

Identyfikator stanu.

iterationId

integer

Identyfikator iteracji do skojarzenia stanu z. Wartość minimalna to 1.

properties

PropertiesCollection

Właściwości niestandardowe stanu.

state

GitStatusState

Stan stanu.

targetUrl

string

Adres URL ze szczegółami stanu.

updatedDate

string

Data i godzina ostatniej aktualizacji stanu.

Odpowiedzi

Nazwa Typ Opis
200 OK

GitPullRequestStatus

operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa Opis
vso.code_write Umożliwia odczytywanie, aktualizowanie i usuwanie kodu źródłowego, uzyskiwanie dostępu do metadanych dotyczących zatwierdzeń, zestawów zmian, gałęzi i innych artefaktów kontroli wersji. Umożliwia również tworzenie żądań ściągnięcia i przeglądów kodu oraz zarządzanie nimi oraz odbieranie powiadomień o zdarzeniach kontroli wersji za pośrednictwem punktów zaczepienia usługi.
vso.code_status Umożliwia odczytywanie i zapisywanie stanu zatwierdzenia i żądania ściągnięcia.

Przykłady

On iteration
On pull request
With properties

On iteration

Sample Request

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

{
  "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

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

{
  "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

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

{
  "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"
    }
  }
}

Definicje

Nazwa Opis
GitPullRequestStatus

Ta klasa zawiera metadane stanu żądania ściągnięcia delegowania usługi/rozszerzenia. Stan może być skojarzony z żądaniem ściągnięcia lub iteracją.

GitStatusContext

Kontekst stanu, który jednoznacznie identyfikuje stan.

GitStatusState

Stan stanu.

IdentityRef
PropertiesCollection

Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Wartości wszystkich typów pierwotnych (dowolnego typu z wartością TypeCode != TypeCode.Object) z wyjątkiem DBNull są akceptowane. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są dostrojone jako ciąg. Bajt[] oczekiwany jako ciąg zakodowany w formacie base64.

ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.

GitPullRequestStatus

Ta klasa zawiera metadane stanu żądania ściągnięcia delegowania usługi/rozszerzenia. Stan może być skojarzony z żądaniem ściągnięcia lub iteracją.

Nazwa Typ Opis
_links

ReferenceLinks

Linki referencyjne.

context

GitStatusContext

Kontekst stanu.

createdBy

IdentityRef

Tożsamość, która utworzyła stan.

creationDate

string

Data i godzina utworzenia stanu.

description

string

Opis stanu. Zazwyczaj opisuje bieżący stan stanu.

id

integer

Identyfikator stanu.

iterationId

integer

Identyfikator iteracji do skojarzenia stanu z. Wartość minimalna to 1.

properties

PropertiesCollection

Właściwości niestandardowe stanu.

state

GitStatusState

Stan stanu.

targetUrl

string

Adres URL ze szczegółami stanu.

updatedDate

string

Data i godzina ostatniej aktualizacji stanu.

GitStatusContext

Kontekst stanu, który jednoznacznie identyfikuje stan.

Nazwa Typ Opis
genre

string

Gatunek stanu. Zazwyczaj nazwa usługi/narzędzia generującego stan może być pusta.

name

string

Identyfikator nazwy stanu nie może być pusty ani mieć wartości null.

GitStatusState

Stan stanu.

Nazwa Typ Opis
error

string

Stan z błędem.

failed

string

Stan nie powiódł się.

notApplicable

string

Stan nie ma zastosowania do obiektu docelowego.

notSet

string

Stan nie jest ustawiony. Stan domyślny.

pending

string

Stan oczekiwania.

succeeded

string

Stan zakończył się pomyślnie.

IdentityRef

Nazwa Typ Opis
_links

ReferenceLinks

To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu.

descriptor

string

Deskryptor jest podstawowym sposobem odwoływanie się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji.

directoryAlias

string

Przestarzałe — można je pobrać, wykonując zapytanie względem użytkownika programu Graph, do których odwołuje się wpis "self" słownika IdentityRef "_links"

displayName

string

Jest to nieu unikatowa nazwa wyświetlana podmiotu grafu. Aby zmienić to pole, należy zmienić jego wartość u dostawcy źródłowego.

id

string

imageUrl

string

Przestarzałe — dostępne we wpisie "avatar" słownika IdentityRef "_links"

inactive

boolean

Przestarzałe — można pobrać, wykonując zapytanie dotyczące stanu członkostwa programu Graph, do których odwołuje się wpis "membershipState" słownika GraphUser "_links"

isAadIdentity

boolean

Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)

isContainer

boolean

Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsGroupType)

isDeletedInOrigin

boolean

profileUrl

string

Przestarzałe — nie jest używane w większości istniejących implementacji elementu ToIdentityRef

uniqueName

string

Przestarzałe — zamiast tego użyj nazwy Domain+PrincipalName

url

string

Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

PropertiesCollection

Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Wartości wszystkich typów pierwotnych (dowolnego typu z wartością TypeCode != TypeCode.Object) z wyjątkiem DBNull są akceptowane. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są dostrojone jako ciąg. Bajt[] oczekiwany jako ciąg zakodowany w formacie base64.

Nazwa Typ Opis
count

integer

Liczba właściwości w kolekcji.

item

object

keys

string[]

Zestaw kluczy w kolekcji.

values

string[]

Zestaw wartości w kolekcji.

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa Typ Opis
links

object

Widok linków w trybie tylko do odczytu. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu.