Pull Request Statuses - Create

Reference

Service:: Git

API Version:: 7.1-preview.1

Vytvoření stavu žádosti o přijetí změn

Jediným povinným polem pro stav je Context.Name jedinečné identifikaci stavu. Všimněte si, že v textu požadavku můžete zadat iterationId a vystavit tak stav iterace.

POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses?api-version=7.1-preview.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. Tato verze rozhraní API by měla být nastavená na 7.1-preview.1.

Text požadavku

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

Odpovědi

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

Zabezpečení

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	Uděluje možnost číst, aktualizovat a odstraňovat zdrojový kód a přistupovat k metadatům o potvrzeních, sadách změn, větvích a dalších artefaktech správy verzí. Poskytuje také možnost vytvářet a spravovat žádosti o přijetí změn a revize 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 stavu potvrzení a žádosti o přijetí změn.

Příklady

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

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

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

{
  "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é publikuje 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 stavu.
IdentityRef
PropertiesCollection	Třída představuje kontejner vlastností jako kolekci párů klíč-hodnota. Přijímají se hodnoty všech primitivních typů (libovolný typ s `TypeCode != TypeCode.Object`výjimkou `DBNull` ). Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají svůj typ, ostatní primitiva se přeladí jako String. Byte[] byl očekáván jako řetězec kódovaný jako base64.
ReferenceLinks	Třída představující kolekci odkazů REST.

GitPullRequestStatus

Tato třída obsahuje metadata služby nebo rozšíření, které publikuje 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	Datum a čas vytvoření stavu.
description	string	Popis stavu. Obvykle popisuje aktuální stav stavu.
id	integer	Identifikátor stavu.
iterationId	integer	ID iterace, ke které se má přidružit stav. Minimální hodnota je 1.
properties	PropertiesCollection	Vlastní vlastnosti stavu
state	GitStatusState	Stav stavu.
targetUrl	string	Adresa URL s podrobnostmi o stavu
updatedDate	string	Datum a čas poslední aktualizace stavu.

GitStatusContext

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

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

GitStatusState

Stav stavu.

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

IdentityRef

Name	Typ	Description
_links	ReferenceLinks	Toto pole neobsahuje žádný nebo více zajímavých odkazů 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 předmětu grafu.
descriptor	string	Popisovač je primárním způsobem, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejný předmět grafu v rámci účtů i organizací.
directoryAlias	string	Zastaralé – Dá se načíst dotazem na uživatele Graphu odkazovaného v položce "self" slovníku IdentityRef "_links"
displayName	string	Toto je jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém poskytovateli.
id	string
imageUrl	string	Zastaralé – k dispozici v položce "avatar" ve slovníku IdentityRef "_links"
inactive	boolean	Zastaralé – Můžete ho načíst dotazem na stav členství v Graphu, na který odkazuje položka membershipState slovníku _links GraphUser.
isAadIdentity	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Zastaralé – Lze odvodit z typu předmětu popisovače (Descriptor.IsGroupType).
isDeletedInOrigin	boolean
profileUrl	string	Zastaralé – nepoužívá se ve většině dříve existujících implementací ToIdentityRef
uniqueName	string	Zastaralé – místo toho použijte Domain+PrincipalName.
url	string	Tato adresa URL představuje úplnou trasu ke zdrojovému prostředku tohoto předmětu grafu.

PropertiesCollection

Třída představuje kontejner vlastností jako kolekci párů klíč-hodnota. Přijímají se hodnoty všech primitivních typů (libovolný typ s TypeCode != TypeCode.Objectvýjimkou DBNull ). Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají svůj typ, ostatní primitiva se přeladí jako String. Byte[] byl očekáván jako řetězec kódovaný jako base64.

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

ReferenceLinks

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

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

Sdílet prostřednictvím

Pull Request Statuses - Create

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

oauth2

Scopes

Příklady

On iteration

Sample Request

Sample Response

On pull request

Sample Request

Sample Response

With properties

Sample Request

Sample Response

Definice

GitPullRequestStatus

GitStatusContext

GitStatusState

IdentityRef

PropertiesCollection

ReferenceLinks

Další materiály