Pull Request Statuses - Create

Reference

Služba:: Git

Verze rozhraní API:: 7.1

Vytvořte stav žádosti o přijetí změn.

Jediné požadované pole pro stav je Context.Name, které jednoznačně identifikuje stav. Všimněte si, že v textu požadavku můžete zadat id iterace, která zveřejní stav iterace.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
pullRequestId	path	True	integer (int32)	ID žádosti o přijetí změn.
repositoryId	path	True	string	ID úložiště cílové větve žádosti o přijetí změn.
project	path		string	ID projektu nebo název projektu
api-version	query	True	string	Verze rozhraní API, která se má použít. Pokud chcete použít tuto verzi rozhraní API, měla by být nastavená na hodnotu 7.1.

Text požadavku

Name	Typ	Description
_links	ReferenceLinks	Odkazy.
context	GitStatusContext	Kontext stavu
createdBy	IdentityRef	Identita, která vytvořila stav
creationDate	string (date-time)	Datum a čas vytvoření stavu
description	string	Popis stavu Obvykle popisuje aktuální stav stavu.
id	integer (int32)	Identifikátor stavu
iterationId	integer (int32)	ID iterace pro přidružení stavu. Minimální hodnota je 1.
properties	PropertiesCollection	Vlastní vlastnosti stavu.
state	GitStatusState	Stav.
targetUrl	string	Adresa URL s podrobnostmi o stavu
updatedDate	string (date-time)	Datum a čas poslední aktualizace stavu

Odpovědi

Name	Typ	Description
200 OK	GitPullRequestStatus	úspěšná operace

Zabezpečení

oauth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL tokenu: 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

Rozsahy

Name	Description
vso.code_write	Uděluje možnost číst, aktualizovat a odstraňovat zdrojový kód, přistupovat k metadatům o potvrzeních, sadách změn, větvích a dalších artefaktech správy verzí. Umožňuje také vytvářet a spravovat žádosti o přijetí změn a kontroly kódu a přijímat oznámení o událostech správy verzí prostřednictvím volání služeb.
vso.code_status	Uděluje možnost čtení a zápisu potvrzení a žádosti o přijetí změn.

Příklady

On iteration

On pull request

With properties

On iteration

Ukázkový požadavek

HTTP

POST https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses?api-version=7.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"
}

Ukázková odpověď

Stavový kód:: 200

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

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:: 200

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

Ukázkový požadavek

HTTP

POST https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses?api-version=7.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"
}

Ukázková odpověď

Stavový kód:: 200

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

Definice

Name	Description
GitPullRequestStatus	Tato třída obsahuje metadata služby nebo rozšíření, která publikují stav žádosti o přijetí změn. Stav může být přidružený k žádosti o přijetí změn nebo iteraci.
GitStatusContext	Kontext stavu, který jednoznačně identifikuje stav.
GitStatusState	Stav.
IdentityRef
PropertiesCollection	Třída představuje tašku vlastností jako kolekci párů klíč-hodnota. Hodnoty všech primitivních typů (libovolný typ s `TypeCode != TypeCode.Object`) s výjimkou `DBNull` jsou přijímány. Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají jejich typ, další primitivy jsou přeladěny jako String. Bajt[] byl očekáván jako řetězec kódovaný jako base64.
ReferenceLinks	Třída představující kolekci odkazů REST.

GitPullRequestStatus

Objekt

Tato třída obsahuje metadata služby nebo rozšíření, která publikují stav žádosti o přijetí změn. Stav může být přidružený k žádosti o přijetí změn nebo iteraci.

Name	Typ	Description
_links	ReferenceLinks	Odkazy.
context	GitStatusContext	Kontext stavu
createdBy	IdentityRef	Identita, která vytvořila stav
creationDate	string (date-time)	Datum a čas vytvoření stavu
description	string	Popis stavu Obvykle popisuje aktuální stav stavu.
id	integer (int32)	Identifikátor stavu
iterationId	integer (int32)	ID iterace pro přidružení stavu. Minimální hodnota je 1.
properties	PropertiesCollection	Vlastní vlastnosti stavu.
state	GitStatusState	Stav.
targetUrl	string	Adresa URL s podrobnostmi o stavu
updatedDate	string (date-time)	Datum a čas poslední aktualizace stavu

GitStatusContext

Objekt

Kontext stavu, který jednoznačně identifikuje stav.

Name	Typ	Description
genre	string	Žánr stavu. Obvykle může být název služby nebo nástroje, který generuje stav, prázdný.
name	string	Identifikátor názvu stavu nesmí být null ani prázdný.

GitStatusState

Výčet

Stav.

Hodnota	Description
error	Stav s chybou
failed	Stav se nezdařil.
notApplicable	Stav se nevztahuje na cílový objekt.
notSet	Stav není nastaven. Výchozí stav.
pending	Stav čeká na vyřízení.
succeeded	Stav byl úspěšný.

IdentityRef

Objekt

Name	Typ	Description
_links	ReferenceLinks	Toto pole obsahuje nula nebo zajímavější odkazy na téma grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto tématu grafu.
descriptor	string	Popisovač je primární způsob, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejné téma grafu v rámci účtů i organizací.
directoryAlias	string	Zastaralé – Je možné načíst dotazováním uživatele Graphu, na který odkazuje položka "self" slovníku IdentityRef "_links".
displayName	string	Toto je ne jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém zprostředkovateli.
id	string
imageUrl	string	Zastaralé – k dispozici v položce avatar ve slovníku IdentityRef "_links"
inactive	boolean	Zastaralé – Lze načíst dotazem na stav členství v grafu odkazovaném v položce "membershipState" slovníku GraphUser "_links"
isAadIdentity	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Popisovač.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Popisovač.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Zastaralé – nepoužívá se ve většině existujících implementací ToIdentityRef
uniqueName	string	Zastaralé – místo toho použijte Domain+PrincipalName.
url	string	Tato adresa URL je úplná trasa ke zdrojovému prostředku tohoto předmětu grafu.

PropertiesCollection

Objekt

Třída představuje tašku vlastností jako kolekci párů klíč-hodnota. Hodnoty všech primitivních typů (libovolný typ s TypeCode != TypeCode.Object) s výjimkou DBNull jsou přijímány. Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají jejich typ, další primitivy jsou přeladěny jako String. Bajt[] byl očekáván jako řetězec kódovaný jako base64.

Name	Typ	Description
count	integer (int32)	Počet vlastností v kolekci.
item	object
keys	string[]	Sada klíčů v kolekci.
values	string[]	Sada hodnot v kolekci.

ReferenceLinks

Objekt

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Jen pro čtení odkazů. Vzhledem k tomu, že odkazy odkazy jsou jen pro čtení, chceme je zveřejnit jen pro čtení.

Sdílet prostřednictvím

Pull Request Statuses - Create

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

oauth2

Rozsahy

Příklady

On iteration

Ukázkový požadavek

Ukázková odpověď

On pull request

Ukázkový požadavek

Ukázková odpověď

With properties

Ukázkový požadavek

Ukázková odpověď

Definice

GitPullRequestStatus

GitStatusContext

GitStatusState

IdentityRef

PropertiesCollection

ReferenceLinks

Další materiály