Approvals - List

Odwołanie

Service:: Release

API Version:: 5.0

Pobieranie listy zatwierdzeń

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/approvals?api-version=5.0

With optional parameters:

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/approvals?assignedToFilter={assignedToFilter}&statusFilter={statusFilter}&releaseIdsFilter={releaseIdsFilter}&typeFilter={typeFilter}&top={top}&continuationToken={continuationToken}&queryOrder={queryOrder}&includeMyGroupApprovals={includeMyGroupApprovals}&api-version=5.0

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path	True	string	Identyfikator projektu lub nazwa projektu
api-version	query	True	string	Wersja interfejsu API do użycia. Powinno to być ustawione na wartość "5.0", aby używać tej wersji interfejsu API.
assignedToFilter	query		string	Zatwierdzenia przypisane do tego użytkownika.
continuationToken	query		integer int32	Pobiera zatwierdzenia po podanym tokenie kontynuacji.
includeMyGroupApprovals	query		boolean	"true" w celu uwzględnienia zatwierdzeń grupy. Wartość domyślna to "false".
queryOrder	query		ReleaseQueryOrder	Pobiera wyniki w zdefiniowanej kolejności utworzonych zatwierdzeń. Wartość domyślna to "malejąco".
releaseIdsFilter	query		string array (int32)	Zatwierdzenia identyfikatorów wersji wymienionych w filtrze. Wiele wersji można wymienić, oddzielając je od "," np. releaseIdsFilter=1,2,3,4.
statusFilter	query		ApprovalStatus	Zatwierdzenia z tym stanem. Wartość domyślna to "oczekiwanie".
top	query		integer int32	Liczba zatwierdzeń do pobrania. Wartość domyślna to 50.
typeFilter	query		ApprovalType	Zatwierdzenie za pomocą tego typu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ReleaseApproval[]	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.release	Umożliwia odczytywanie artefaktów wydania, w tym wydań, definicji wydania i środowiska wydania.

Przykłady

Pending for a specific release

Pending for a specific user

Pending for all users

Pending for a specific release

Sample Request

HTTP

GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/approvals?releaseIdsFilter=14&continuationToken=0&api-version=5.0

Sample Response

Status code:: 200

{
  "count": 1,
  "value": [
    {
      "id": 134,
      "revision": 1,
      "approver": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "approvalType": "preDeploy",
      "createdOn": "2017-06-01T09:42:16.053Z",
      "modifiedOn": "2017-06-01T09:42:16.053Z",
      "status": "pending",
      "comments": "",
      "isAutomated": false,
      "isNotificationOn": true,
      "trialNumber": 1,
      "attempt": 1,
      "rank": 1,
      "release": {
        "id": 14,
        "name": "Release-14",
        "url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/releases/14",
        "_links": {}
      },
      "releaseDefinition": {
        "id": 1,
        "name": "MyShuttle.CD",
        "url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
        "_links": {}
      },
      "releaseEnvironment": {
        "id": 53,
        "name": "Dev",
        "_links": {}
      },
      "url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/approvals/134"
    }
  ]
}

Pending for a specific user

Sample Request

HTTP

GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/approvals?assignedToFilter=Chuck Reinhart&continuationToken=0&api-version=5.0

Sample Response

Status code:: 200

{
  "count": 2,
  "value": [
    {
      "id": 2,
      "revision": 1,
      "approver": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "approvalType": "preDeploy",
      "createdOn": "2017-05-31T16:40:14.47Z",
      "modifiedOn": "2017-05-31T16:40:14.47Z",
      "status": "pending",
      "comments": "",
      "isAutomated": false,
      "isNotificationOn": true,
      "trialNumber": 1,
      "attempt": 1,
      "rank": 1,
      "release": {
        "id": 2,
        "name": "Release-2",
        "url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/releases/2",
        "_links": {}
      },
      "releaseDefinition": {
        "id": 1,
        "name": "MyShuttle.CD",
        "url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
        "_links": {}
      },
      "releaseEnvironment": {
        "id": 5,
        "name": "Dev",
        "_links": {}
      },
      "url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/approvals/2"
    },
    {
      "id": 1,
      "revision": 1,
      "approver": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "approvalType": "preDeploy",
      "createdOn": "2017-05-31T16:40:04.577Z",
      "modifiedOn": "2017-05-31T16:40:04.577Z",
      "status": "pending",
      "comments": "",
      "isAutomated": false,
      "isNotificationOn": true,
      "trialNumber": 1,
      "attempt": 1,
      "rank": 1,
      "release": {
        "id": 1,
        "name": "Release-1",
        "url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/releases/1",
        "_links": {}
      },
      "releaseDefinition": {
        "id": 1,
        "name": "MyShuttle.CD",
        "url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
        "_links": {}
      },
      "releaseEnvironment": {
        "id": 1,
        "name": "Dev",
        "_links": {}
      },
      "url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/approvals/1"
    }
  ]
}

Pending for all users

Sample Request

HTTP

GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/approvals?continuationToken=0&api-version=5.0

Sample Response

Status code:: 200

{
  "count": 2,
  "value": [
    {
      "id": 2,
      "revision": 1,
      "approver": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "approvalType": "preDeploy",
      "createdOn": "2017-05-31T16:40:14.47Z",
      "modifiedOn": "2017-05-31T16:40:14.47Z",
      "status": "pending",
      "comments": "",
      "isAutomated": false,
      "isNotificationOn": true,
      "trialNumber": 1,
      "attempt": 1,
      "rank": 1,
      "release": {
        "id": 2,
        "name": "Release-2",
        "url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/releases/2",
        "_links": {}
      },
      "releaseDefinition": {
        "id": 1,
        "name": "MyShuttle.CD",
        "url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
        "_links": {}
      },
      "releaseEnvironment": {
        "id": 5,
        "name": "Dev",
        "_links": {}
      },
      "url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/approvals/2"
    },
    {
      "id": 1,
      "revision": 1,
      "approver": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "approvalType": "preDeploy",
      "createdOn": "2017-05-31T16:40:04.577Z",
      "modifiedOn": "2017-05-31T16:40:04.577Z",
      "status": "pending",
      "comments": "",
      "isAutomated": false,
      "isNotificationOn": true,
      "trialNumber": 1,
      "attempt": 1,
      "rank": 1,
      "release": {
        "id": 1,
        "name": "Release-1",
        "url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/releases/1",
        "_links": {}
      },
      "releaseDefinition": {
        "id": 1,
        "name": "MyShuttle.CD",
        "url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
        "_links": {}
      },
      "releaseEnvironment": {
        "id": 1,
        "name": "Dev",
        "_links": {}
      },
      "url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/approvals/1"
    }
  ]
}

Definicje

Nazwa	Opis
ApprovalStatus	Pobiera lub ustawia stan zatwierdzenia.
ApprovalType	Pobiera lub ustawia typ zatwierdzenia.
IdentityRef
ProjectReference
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
ReleaseApproval
ReleaseApprovalHistory
ReleaseDefinitionShallowReference
ReleaseEnvironmentShallowReference
ReleaseQueryOrder	Pobiera wyniki w zdefiniowanej kolejności utworzonych zatwierdzeń. Wartość domyślna to "malejąco".
ReleaseShallowReference

ApprovalStatus

Pobiera lub ustawia stan zatwierdzenia.

Nazwa	Typ	Opis
approved	string
canceled	string
pending	string
reassigned	string
rejected	string
skipped	string
undefined	string

ApprovalType

Pobiera lub ustawia typ zatwierdzenia.

Nazwa	Typ	Opis
all	string
postDeploy	string
preDeploy	string
undefined	string

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łowania 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
displayName	string	Jest to unikatowa nazwa wyświetlana tematu grafu. Aby zmienić to pole, musisz zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

ProjectReference

Nazwa	Typ	Opis
id	string	Pobiera unikatowy identyfikator tego pola.
name	string	Pobiera nazwę projektu.

ReferenceLinks

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

Nazwa	Typ	Opis
links	object	Czytelny widok linków. Ponieważ linki referencyjne są czytelne, chcemy uwidocznić je tylko jako tylko do odczytu.

ReleaseApproval

Nazwa	Typ	Opis
approvalType	ApprovalType	Pobiera lub ustawia typ zatwierdzenia.
approvedBy	IdentityRef	Pobiera tożsamość, która zatwierdziła.
approver	IdentityRef	Pobiera lub ustawia tożsamość, która powinna zostać zatwierdzana.
attempt	integer	Pobiera lub ustawia próbę, która określa, do której próby wdrożenia należy.
comments	string	Pobiera lub ustawia komentarze do zatwierdzenia.
createdOn	string	Pobiera datę utworzenia.
history	ReleaseApprovalHistory[]	Pobiera historię określającą wszystkie zatwierdzenia skojarzone z tym zatwierdzeniem.
id	integer	Pobiera unikatowy identyfikator tego pola.
isAutomated	boolean	Pobiera lub ustawia jako zatwierdzenie jest zautomatyzowane lub nie.
isNotificationOn	boolean
modifiedOn	string	Pobiera datę, w której został zmodyfikowany.
rank	integer	Pobiera lub ustawia rangę określającą kolejność zatwierdzenia. np. Ta sama ranga oznacza zatwierdzenie równoległe.
release	ReleaseShallowReference	Pobiera wartość releaseReference, która określa odwołanie do wydania, do którego jest skojarzone to zatwierdzenie.
releaseDefinition	ReleaseDefinitionShallowReference	Pobiera releaseDefinitionReference, która określa odwołanie do definicji wydania, do której jest skojarzone to zatwierdzenie.
releaseEnvironment	ReleaseEnvironmentShallowReference	Pobiera releaseEnvironmentReference, który określa odwołanie do środowiska wydania, do którego jest skojarzone to zatwierdzenie.
revision	integer	Pobiera numer poprawki.
status	ApprovalStatus	Pobiera lub ustawia stan zatwierdzenia.
trialNumber	integer
url	string	Pobiera adres URL w celu uzyskania dostępu do zatwierdzenia.

ReleaseApprovalHistory

Nazwa	Typ	Opis
approver	IdentityRef
changedBy	IdentityRef
comments	string
createdOn	string
modifiedOn	string
revision	integer

ReleaseDefinitionShallowReference

Nazwa	Typ	Opis
_links	ReferenceLinks	Pobiera linki do powiązanych zasobów, interfejsów API i widoków definicji wydania.
id	integer	Pobiera unikatowy identyfikator definicji wydania.
name	string	Pobiera lub ustawia nazwę definicji wydania.
path	string	Pobiera lub ustawia ścieżkę definicji wydania.
projectReference	ProjectReference	Pobiera lub ustawia odwołanie do projektu.
url	string	Pobiera adres URL interfejsu API REST w celu uzyskania dostępu do definicji wydania.

ReleaseEnvironmentShallowReference

Nazwa	Typ	Opis
_links	ReferenceLinks	Pobiera linki do powiązanych zasobów, interfejsów API i widoków dla środowiska wydania.
id	integer	Pobiera unikatowy identyfikator środowiska wydania.
name	string	Pobiera lub ustawia nazwę środowiska wydania.
url	string	Pobiera adres URL interfejsu API REST w celu uzyskania dostępu do środowiska wydania.

ReleaseQueryOrder

Pobiera wyniki w zdefiniowanej kolejności utworzonych zatwierdzeń. Wartość domyślna to "malejąco".

Nazwa	Typ	Opis
ascending	string
descending	string

ReleaseShallowReference

Nazwa	Typ	Opis
_links	ReferenceLinks	Pobiera linki do powiązanych zasobów, interfejsów API i widoków dla wydania.
id	integer	Pobiera unikatowy identyfikator wydania.
name	string	Pobiera lub ustawia nazwę wydania.
url	string	Pobiera adres URL interfejsu API REST w celu uzyskania dostępu do wersji.

Udostępnij za pośrednictwem

Approvals - List

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

oauth2

Scopes

Przykłady

Pending for a specific release

Sample Request

Sample Response

Pending for a specific user

Sample Request

Sample Response

Pending for all users

Sample Request

Sample Response

Definicje

ApprovalStatus

ApprovalType

IdentityRef

ProjectReference

ReferenceLinks

ReleaseApproval

ReleaseApprovalHistory

ReleaseDefinitionShallowReference

ReleaseEnvironmentShallowReference

ReleaseQueryOrder

ReleaseShallowReference

Opinia

Dodatkowe zasoby