Consumers - Get

참조

서비스:: Service Hooks

API 버전:: 7.1

특정 소비자 서비스를 가져옵니다. 필요에 따라 지정된 게시자에 대한 이벤트 유형을 지원하지 않는 소비자 작업을 필터링합니다.

GET https://dev.azure.com/{organization}/_apis/hooks/consumers/{consumerId}?api-version=7.1

선택적 매개 변수:

GET https://dev.azure.com/{organization}/_apis/hooks/consumers/{consumerId}?publisherId={publisherId}&api-version=7.1

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
consumerId	path	True	string	소비자의 ID입니다.
organization	path	True	string	Azure DevOps 조직의 이름입니다.
api-version	query	True	string	사용할 API의 버전입니다. 이 버전의 API를 사용하려면 '7.1'로 설정해야 합니다.
publisherId	query		string

응답

Name	형식	Description
200 OK	Consumer	성공한 작업

보안

oauth2

형식: oauth2
Flow: accessCode
권한 부여 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
토큰 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

범위

Name	Description
vso.work	작업 항목, 쿼리, 보드, 영역 및 반복 경로 및 기타 작업 항목 추적 관련 메타데이터를 읽을 수 있는 기능을 부여합니다. 또한 쿼리를 실행하고, 작업 항목을 검색하고, 서비스 후크를 통해 작업 항목 이벤트에 대한 알림을 받을 수 있는 기능을 부여합니다.
vso.build	빌드 결과, 정의 및 요청을 포함하여 빌드 아티팩트 액세스 기능과 서비스 후크를 통해 빌드 이벤트에 대한 알림을 받을 수 있는 기능을 부여합니다.
vso.code	커밋, 변경 집합, 분기 및 기타 버전 제어 아티팩트에 대한 소스 코드 및 메타데이터를 읽을 수 있는 기능을 부여합니다. 또한 코드를 검색하고 서비스 후크를 통해 버전 제어 이벤트에 대한 알림을 받을 수 있는 기능을 부여합니다.

예제

샘플 요청

HTTP

GET https://dev.azure.com/fabrikam/_apis/hooks/consumers/zendesk?api-version=7.1

샘플 응답

상태 코드:: 200

{
  "id": "zendesk",
  "url": "https://dev.azure.com/fabrikam/_apis/hooks/consumers/zendesk",
  "name": "Zendesk",
  "description": "Zendesk is a SaaS suite that offers help desk ticketing, issue tracking, and customer service support.",
  "imageUrl": "",
  "informationUrl": "http://go.microsoft.com/fwlink/?LinkID=396756",
  "authenticationType": "external",
  "inputDescriptors": [
    {
      "id": "accountName",
      "name": "Account name",
      "description": "Zendesk account name like https://<account name>.zendesk.com",
      "inputMode": "textBox",
      "isConfidential": false,
      "useInDefaultDescription": true,
      "validation": {
        "dataType": "string",
        "isRequired": true,
        "pattern": "^([A-Za-z0-9][A-Za-z0-9\\-]{0,61}[A-Za-z0-9]|[A-Za-z0-9]{1,63})$",
        "maxLength": 63
      }
    },
    {
      "id": "username",
      "name": "User name",
      "description": "The Zendesk user name of a user who will update tickets",
      "inputMode": "textBox",
      "isConfidential": false,
      "useInDefaultDescription": false,
      "validation": {
        "dataType": "string",
        "isRequired": true,
        "pattern": "^.+\\@.+\\..+$",
        "maxLength": 254
      }
    },
    {
      "id": "apiToken",
      "name": "API token",
      "description": "The Zendesk API token (can be found in Zendesk app in Admin > Channels > API)",
      "inputMode": "passwordBox",
      "isConfidential": true,
      "useInDefaultDescription": false,
      "validation": {
        "dataType": "string",
        "isRequired": true,
        "maxLength": 100
      }
    }
  ],
  "actions": [
    {
      "id": "createPrivateComment",
      "consumerId": "zendesk",
      "url": "https://dev.azure.com/fabrikam/_apis/hooks/consumers/zendesk/actions/createPrivateComment",
      "name": "Create a private comment in a ticket",
      "description": "Create a private comment in a ticket. <a href='http://go.microsoft.com/fwlink/?LinkId=396756'>Learn more.</a>",
      "supportedEventTypes": [
        "workitem.commented"
      ],
      "supportedResourceVersions": {
        "workitem.commented": [
          "1.0-preview.1"
        ]
      },
      "inputDescriptors": []
    }
  ]
}

정의

Name	Description
AuthenticationType	이 소비자의 인증 유형을 가져오거나 설정합니다.
Consumer	소비자의 데이터 계약을 정의합니다.
ConsumerAction	소비자 작업의 데이터 계약을 정의합니다.
ExternalConfigurationDescriptor	외부에서 관리되는 구독을 구성하는 방법을 설명합니다.
InputDataType	유효성을 검사할 데이터 형식을 가져오거나 설정합니다.
InputDescriptor	구독에 대한 입력을 설명합니다.
InputMode	이 입력의 값을 입력해야 하는 모드
InputValidation	구독 입력에 유효한 값을 설명합니다.
InputValue	입력의 단일 값에 대한 정보
InputValues	지정된 구독 입력에 대해 가능한/허용되는 값에 대한 정보
InputValuesError	구독 입력 값과 관련된 오류 정보입니다.
ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.

AuthenticationType

열거형

이 소비자의 인증 유형을 가져오거나 설정합니다.

값	Description
external	외부에서 구성된 인증입니다.
none	인증이 필요하지 않습니다.
oAuth	OAuth 인증.

Consumer

Object

소비자의 데이터 계약을 정의합니다.

Name	형식	Description
_links	ReferenceLinks	참조 링크
actions	ConsumerAction[]	이 소비자의 동작을 가져옵니다.
authenticationType	AuthenticationType	이 소비자의 인증 유형을 가져오거나 설정합니다.
description	string	이 소비자의 지역화된 설명을 가져오거나 설정합니다.
externalConfiguration	ExternalConfigurationDescriptor	이 소비자에 대한 구독이 외부에서 구성된 경우에만 null이 아닌 경우
id	string	이 소비자의 식별자를 가져오거나 설정합니다.
imageUrl	string	이 소비자의 이미지 URL(있는 경우)을 가져오거나 설정합니다.
informationUrl	string	이 소비자의 정보 URL(있는 경우)을 가져오거나 설정합니다.
inputDescriptors	InputDescriptor[]	이 소비자의 입력 설명자를 가져오거나 설정합니다.
name	string	이 소비자의 지역화된 이름을 가져오거나 설정합니다.
url	string	이 리소스의 URL

ConsumerAction

Object

소비자 작업의 데이터 계약을 정의합니다.

Name	형식	Description
_links	ReferenceLinks	참조 링크
allowResourceVersionOverride	boolean	구독을 만들거나 편집할 때 리소스 버전을 재정의할 수 있는지 여부를 나타내는 플래그를 가져오거나 설정합니다.
consumerId	string	이 작업이 속한 소비자의 식별자를 가져오거나 설정합니다.
description	string	이 작업의 지역화된 설명을 가져오거나 설정합니다.
id	string	이 작업의 식별자를 가져오거나 설정합니다.
inputDescriptors	InputDescriptor[]	이 작업의 입력 설명자를 가져오거나 설정합니다.
name	string	이 작업의 지역화된 이름을 가져오거나 설정합니다.
supportedEventTypes	string[]	이 작업의 지원되는 이벤트 식별자를 가져오거나 설정합니다.
supportedResourceVersions	object	이 작업의 지원되는 리소스 버전을 가져오거나 설정합니다.
url	string	이 리소스의 URL

ExternalConfigurationDescriptor

Object

외부에서 관리되는 구독을 구성하는 방법을 설명합니다.

Name	형식	Description
createSubscriptionUrl	string	이 유형의 구독을 만들 사이트의 URL입니다.
editSubscriptionPropertyName	string	구독을 편집할 URL이 포함된 입력 속성의 이름입니다.
hostedOnly	boolean	외부 구성이 호스트에만 적용되는 경우 True입니다.

InputDataType

열거형

유효성을 검사할 데이터 형식을 가져오거나 설정합니다.

값	Description
boolean	true 또는 false 값을 나타냅니다.
guid	Guid를 나타냅니다.
none	데이터 형식이 지정되지 않았습니다.
number	숫자 값을 나타냅니다.
string	텍스트 값을 나타냅니다.
uri	URI를 나타냅니다.

InputDescriptor

Object

구독에 대한 입력을 설명합니다.

Name	형식	Description
dependencyInputIds	string[]	이 입력의 값이 종속된 모든 입력의 ID입니다.
description	string	이 입력이 사용되는 대상에 대한 설명
groupName	string	이 입력이 속한 그룹 지역화된 이름이며 그룹의 모든 입력을 포함하는 컨테이너의 헤더로 표시될 수 있습니다.
hasDynamicValueInformation	boolean	true이면 이 입력에 대한 값 정보가 동적이며 종속성 입력 값이 변경될 때 가져와야 합니다.
id	string	구독 입력에 대한 식별자
inputMode	InputMode	이 입력의 값을 입력해야 하는 모드
isConfidential	boolean	암호 또는 애플리케이션 키와 같이 이 입력이 기밀인지 여부를 가져옵니다.
name	string	구독 입력에 대한 레이블로 표시할 수 있는 지역화된 이름
properties	object	서비스 공급자가 사용할 수 있는 입력에 대한 사용자 지정 속성
type	string	입력 값의 기본 데이터 형식입니다. 이 값을 지정하면 InputMode, 유효성 검사 및 값은 선택 사항입니다.
useInDefaultDescription	boolean	이 입력이 기본 생성된 작업 설명에 포함되는지 여부를 가져옵니다.
validation	InputValidation	이 입력 값의 유효성을 검사하는 데 사용할 정보
valueHint	string	입력 값에 대한 힌트입니다. UI에서 입력 자리 표시자로 사용할 수 있습니다.
values	InputValues	이 입력에 사용할 수 있는 값에 대한 정보

InputMode

열거형

이 입력의 값을 입력해야 하는 모드

값	Description
checkBox	확인란이 표시되어야 합니다(true/false 값의 경우).
combo	select/combo 컨트롤이 표시되어야 합니다.
none	이 입력은 UI에 표시되지 않아야 합니다.
passwordBox	암호 입력 상자가 표시되어야 합니다.
radioButtons	라디오 단추가 표시되어야 합니다.
textArea	여러 줄 텍스트 영역을 표시해야 합니다.
textBox	입력 텍스트 상자가 표시되어야 합니다.

InputValidation

Object

구독 입력에 유효한 값을 설명합니다.

Name	형식	Description
dataType	InputDataType	유효성을 검사할 데이터 형식을 가져오거나 설정합니다.
isRequired	boolean	필수 필드인지 여부를 가져오거나 설정합니다.
maxLength	integer (int32)	이 설명자의 최대 길이를 가져오거나 설정합니다.
maxValue	string (decimal)	이 설명자의 최소값을 가져오거나 설정합니다.
minLength	integer (int32)	이 설명자의 최소 길이를 가져오거나 설정합니다.
minValue	string (decimal)	이 설명자의 최소값을 가져오거나 설정합니다.
pattern	string	유효성을 검사할 패턴을 가져오거나 설정합니다.
patternMismatchErrorMessage	string	패턴 불일치에 대한 오류를 가져오거나 설정합니다.

InputValue

Object

입력의 단일 값에 대한 정보

Name	형식	Description
data	object	이 입력에 대한 다른 모든 데이터
displayValue	string	이 값의 표시를 위해 표시할 텍스트입니다.
value	string	이 입력에 저장할 값입니다.

InputValues

Object

지정된 구독 입력에 대해 가능한/허용되는 값에 대한 정보

Name	형식	Description
defaultValue	string	이 입력에 사용할 기본값
error	InputValuesError	동적 값을 계산하는 동안 오류가 발생했습니다.
inputId	string	입력의 ID입니다.
isDisabled	boolean	이 입력을 사용하지 않도록 설정해야 함
isLimitedToPossibleValues	boolean	값이 PossibleValues(True)의 값 중 하나로 제한되거나 PossibleValues의 값이 제안(False)일 경우
isReadOnly	boolean	이 입력을 읽기 전용으로 만들 경우
possibleValues	InputValue[]	이 입력에 사용할 수 있는 가능한 값

InputValuesError

Object

구독 입력 값과 관련된 오류 정보입니다.

Name	형식	Description
message	string	오류 메시지입니다.

ReferenceLinks

Object

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

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

다음을 통해 공유

Consumers - Get

URI 매개 변수

응답

보안

oauth2

범위

예제

샘플 요청

샘플 응답

정의

AuthenticationType

Consumer

ConsumerAction

ExternalConfigurationDescriptor

InputDataType

InputDescriptor

InputMode

InputValidation

InputValue

InputValues

InputValuesError

ReferenceLinks

추가 리소스