Approvals - Query

Service:

Approvals And Checks

API Version:

7.1-preview.1

승인을 나열합니다. 파이프라인, 사용자 또는 리소스에 대해 보류 중인 승인 집합을 가져오는 데 사용할 수 있습니다.

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?api-version=7.1-preview.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?approvalIds={approvalIds}&$expand={$expand}&userIds={userIds}&state={state}&top={top}&api-version=7.1-preview.1

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
organization	path	True	string	Azure DevOps 조직의 이름입니다.
project	path	True	string	프로젝트 ID 또는 프로젝트 이름
api-version	query	True	string	사용할 API의 버전입니다. 이 버전의 API를 사용하려면 '7.1-preview.1'로 설정해야 합니다.
$expand	query		ApprovalDetailsExpandParameter	반환된 개체에 이러한 추가 세부 정보를 포함합니다.
approvalIds	query		string array (uuid)	가져올 승인 ID 목록입니다.
state	query		ApprovalStatus	승인 상태. 제공되지 않은 경우 상태 승인을 반환합니다.
top	query		integer int32	가져올 최대 승인 수입니다.
userIds	query		string array (string)	할당된 사용자 ID 승인 목록입니다. 사용자 ID 또는 사용자 설명자를 허용합니다.

응답

Name	형식	Description
200 OK	Approval[]	성공적인 작업

보안

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.build	빌드 결과, 정의 및 요청을 포함하여 빌드 아티팩트 액세스 기능과 서비스 후크를 통해 빌드 이벤트에 대한 알림을 받을 수 있는 기능을 부여합니다.

예제

Sample Request

HTTP

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?approvalIds=ee14f612-6838-43c0-b445-db238ef14153,06239b11-a904-43a1-be6a-0d44026bd121&api-version=7.1-preview.1

Sample Response

Status code:

200

request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context

Response Body

{
  "count": 2,
  "value": [
    {
      "id": "ee14f612-6838-43c0-b445-db238ef14153",
      "steps": [],
      "status": "pending",
      "createdOn": "2020-11-19T08:14:49.58Z",
      "lastModifiedOn": "2020-11-19T08:14:49.5793622Z",
      "executionOrder": "anyOrder",
      "minRequiredApprovers": 1,
      "blockedApprovers": [],
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/approvals/ee14f612-6838-43c0-b445-db238ef14153"
        }
      }
    },
    {
      "id": "06239b11-a904-43a1-be6a-0d44026bd121",
      "steps": [],
      "status": "pending",
      "createdOn": "2020-11-19T09:39:35.28Z",
      "lastModifiedOn": "2020-11-19T09:39:35.2806001Z",
      "executionOrder": "anyOrder",
      "minRequiredApprovers": 1,
      "blockedApprovers": [],
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/approvals/06239b11-a904-43a1-be6a-0d44026bd121"
        }
      }
    }
  ]
}

정의

Name	Description
Approval
ApprovalDetailsExpandParameter	반환된 개체에 이러한 추가 세부 정보를 포함합니다.
ApprovalExecutionOrder	승인자가 실행 가능한 순서입니다.
ApprovalPermissions	승인 개체에 대한 현재 사용자 권한입니다.
ApprovalStatus	승인의 전반적인 상태.
ApprovalStep	단일 승인 단계에 대한 데이터입니다.
ApprovalStepHistory	단일 승인 단계 기록에 대한 데이터입니다.
IdentityRef
ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.

Approval

Name	형식	Description
_links	ReferenceLinks	승인 개체에 액세스할 링크를 가져옵니다.
blockedApprovers	IdentityRef[]	승인할 수 없는 ID입니다.
createdOn	string	승인이 만들어진 날짜입니다.
executionOrder	ApprovalExecutionOrder	승인자가 실행 가능한 순서입니다.
id	string	승인의 고유 식별자입니다.
instructions	string	승인자에 대한 지침입니다.
lastModifiedOn	string	승인이 마지막으로 수정된 날짜입니다.
minRequiredApprovers	integer	승인된 것으로 간주될 전체 승인을 승인해야 하는 최소 승인자 수입니다.
permissions	ApprovalPermissions	승인 개체에 대한 현재 사용자 권한입니다.
status	ApprovalStatus	승인의 전반적인 상태.
steps	ApprovalStep[]	승인과 관련된 단계 목록입니다.

ApprovalDetailsExpandParameter

반환된 개체에 이러한 추가 세부 정보를 포함합니다.

Name	형식	Description
none	string	추가 속성이 없습니다.
permissions	string	승인 개체에 대한 현재 사용자 권한을 포함합니다.
steps	string	승인과 관련된 승인 단계를 포함합니다.

ApprovalExecutionOrder

승인자가 실행 가능한 순서입니다.

Name	형식	Description
anyOrder	string	승인자가 어떤 순서로든 승인할 수 있음을 나타냅니다.
inSequence	string	승인자는 순차적 순서(할당된 순서)로만 승인할 수 있음을 나타냅니다.

ApprovalPermissions

승인 개체에 대한 현재 사용자 권한입니다.

Name	형식	Description
none	string
queueBuild	string
reassign	string
resourceAdmin	string
update	string
view	string

ApprovalStatus

승인의 전반적인 상태.

Name	형식	Description
all	string
approved	string	승인이 승인됨임을 나타냅니다.
canceled	string	승인이 취소됨을 나타냅니다.
completed	string
failed	string
pending	string	승인이 보류 중임을 나타냅니다.
rejected	string	승인이 거부됨을 나타냅니다.
skipped	string	승인을 건너뛰었다는 것을 나타냅니다.
timedOut	string	승인 시간이 초과되었음을 나타냅니다.
undefined	string
uninitiated	string	승인이 미숙하다는 것을 나타냅니다. 지정된 승인자가 아직 실행 가능하지 않은 경우 시퀀스 실행 순서로 의 경우에 사용됩니다.

ApprovalStep

단일 승인 단계에 대한 데이터입니다.

Name	형식	Description
actualApprover	IdentityRef	승인한 ID입니다.
assignedApprover	IdentityRef	승인해야 하는 ID입니다.
comment	string	이 단계와 관련된 주석입니다.
history	ApprovalStepHistory[]	승인 단계의 기록
initiatedOn	string	이 단계가 시작된 타임스탬프입니다.
lastModifiedBy	IdentityRef	이 단계가 마지막으로 수정된 ID입니다.
lastModifiedOn	string	이 단계가 마지막으로 수정된 타임스탬프입니다.
order	integer	승인자가 승인할 수 있는 순서입니다.
permissions	ApprovalPermissions	단계에 대한 현재 사용자 권한입니다.
status	ApprovalStatus	이 단계의 현재 상태.

ApprovalStepHistory

단일 승인 단계 기록에 대한 데이터입니다.

Name	형식	Description
assignedTo	IdentityRef	이 승인이 할당된 ID
comment	string	이 단계 기록과 관련된 주석입니다.
createdBy	IdentityRef	이 단계 기록을 만든 ID입니다.
createdOn	string	이 단계 기록이 만들어진 타임스탬프입니다.

IdentityRef

Name	형식	Description
_links	ReferenceLinks	이 필드에는 그래프 제목에 대한 0개 이상의 흥미로운 링크가 포함되어 있습니다. 이러한 링크를 호출하여 이 그래프 제목에 대한 추가 관계 또는 자세한 정보를 얻을 수 있습니다.
descriptor	string	설명자는 시스템이 실행되는 동안 그래프 제목을 참조하는 기본 방법입니다. 이 필드는 계정과 조직 모두에서 동일한 그래프 제목을 고유하게 식별합니다.
directoryAlias	string	사용되지 않음 - IdentityRef "_links" 사전의 "자체" 항목에서 참조된 Graph 사용자를 쿼리하여 검색할 수 있습니다.
displayName	string	그래프 주체의 고유하지 않은 표시 이름입니다. 이 필드를 변경하려면 원본 공급자에서 해당 값을 변경해야 합니다.
id	string
imageUrl	string	사용되지 않음 - IdentityRef "_links" 사전의 "아바타" 항목에서 사용할 수 있습니다.
inactive	boolean	사용되지 않음 - GraphUser "_links" 사전의 "membershipState" 항목에서 참조되는 Graph 멤버 자격 상태를 쿼리하여 검색할 수 있습니다.
isAadIdentity	boolean	사용되지 않음 - 설명자의 주체 형식(Descriptor.IsAadUserType/Descriptor.IsAadGroupType)에서 유추할 수 있습니다.
isContainer	boolean	사용되지 않음 - 설명자의 주체 형식에서 유추할 수 있음(Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	사용되지 않음 - ToIdentityRef의 대부분의 기존 구현에서 사용되지 않음
uniqueName	string	사용되지 않음 - 대신 Domain+PrincipalName 사용
url	string	이 URL은 이 그래프 주체의 원본 리소스에 대한 전체 경로입니다.

ReferenceLinks

REST 참조 링크의 컬렉션을 나타내는 클래스입니다.

Name	형식	Description
links	object	링크의 읽기 전용 보기입니다. 참조 링크는 읽기 전용이므로 읽기 전용으로만 노출하려고 합니다.