Publishers - Get
특정 서비스 후크 게시자를 가져옵니다.
GET https://dev.azure.com/{organization}/_apis/hooks/publishers/{publisherId}?api-version=7.1-preview.1URI 매개 변수
| Name | In(다음 안에) | 필수 | 형식 | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps 조직의 이름입니다. |
|
publisher
|
path | True |
string |
게시자의 ID입니다. |
|
api-version
|
query | True |
string |
사용할 API의 버전입니다. 이 버전의 api를 사용하려면 '7.1-preview.1'로 설정해야 합니다. |
응답
| Name | 형식 | Description |
|---|---|---|
| 200 OK |
성공한 작업 |
보안
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 | 커밋, 변경 집합, 분기 및 기타 버전 제어 아티팩트에 대한 소스 코드 및 메타데이터를 읽을 수 있는 기능을 부여합니다. 또한 서비스 후크를 통해 코드를 검색하고 버전 제어 이벤트에 대한 알림을 받을 수 있는 기능도 부여합니다. |
정의
| Name | Description |
|---|---|
|
Event |
이벤트 유형을 설명합니다. |
|
Input |
유효성을 검사할 데이터 형식을 가져오거나 설정합니다. |
|
Input |
구독에 대한 입력을 설명합니다. |
|
Input |
이 입력의 값을 입력해야 하는 모드 |
|
Input |
구독 입력에 유효한 값을 설명합니다. |
|
Input |
입력의 단일 값에 대한 정보 |
|
Input |
지정된 구독 입력에 대해 가능한/허용되는 값에 대한 정보 |
|
Input |
구독 입력 값과 관련된 오류 정보입니다. |
| Publisher |
이벤트 게시자의 데이터 계약을 정의합니다. |
|
Reference |
REST 참조 링크의 컬렉션을 나타내는 클래스입니다. |
EventTypeDescriptor
이벤트 유형을 설명합니다.
| Name | 형식 | Description |
|---|---|---|
| description |
string |
이벤트 유형에 대한 지역화된 설명 |
| id |
string |
이벤트 유형에 대한 고유 ID |
| inputDescriptors |
이벤트별 입력 |
|
| name |
string |
이벤트 유형에 대한 지역화된 식별 이름 |
| publisherId |
string |
이 이벤트 유형의 게시자에 대한 고유 ID |
| supportedResourceVersions |
string[] |
이벤트의 리소스 페이로드에 대해 지원되는 버전입니다. |
| url |
string |
이 리소스의 URL |
InputDataType
유효성을 검사할 데이터 형식을 가져오거나 설정합니다.
| Name | 형식 | Description |
|---|---|---|
| boolean |
string |
true 또는 false 값을 나타냅니다. |
| guid |
string |
Guid를 나타냅니다. |
| none |
string |
데이터 형식이 지정되지 않았습니다. |
| number |
string |
숫자 값을 나타냅니다. |
| string |
string |
텍스트 값을 나타냅니다. |
| uri |
string |
URI를 나타냅니다. |
InputDescriptor
구독에 대한 입력을 설명합니다.
| Name | 형식 | Description |
|---|---|---|
| dependencyInputIds |
string[] |
이 입력의 값이 종속된 모든 입력의 ID입니다. |
| description |
string |
이 입력이 사용되는 용도에 대한 설명 |
| groupName |
string |
이 입력이 속한 그룹 지역화된 이름이며 그룹의 모든 입력을 포함할 컨테이너의 헤더로 표시될 수 있습니다. |
| hasDynamicValueInformation |
boolean |
true이면 이 입력의 값 정보가 동적이며 종속성 입력 값이 변경될 때 가져와야 합니다. |
| id |
string |
구독 입력에 대한 식별자 |
| inputMode |
이 입력의 값을 입력해야 하는 모드 |
|
| isConfidential |
boolean |
암호 또는 애플리케이션 키와 같이 이 입력이 기밀인지 여부를 가져옵니다. |
| name |
string |
구독 입력에 대한 레이블로 표시될 수 있는 지역화된 이름 |
| properties |
object |
서비스 공급자가 사용할 수 있는 입력에 대한 사용자 지정 속성 |
| type |
string |
입력 값의 기본 데이터 형식입니다. 이 값을 지정하면 InputMode, 유효성 검사 및 값이 선택 사항입니다. |
| useInDefaultDescription |
boolean |
이 입력이 기본 생성 작업 설명에 포함되는지 여부를 가져옵니다. |
| validation |
이 입력 값의 유효성을 검사하는 데 사용할 정보 |
|
| valueHint |
string |
입력 값에 대한 힌트입니다. UI에서 입력 자리 표시자로 사용할 수 있습니다. |
| values |
이 입력에 사용할 수 있는 값에 대한 정보 |
InputMode
이 입력의 값을 입력해야 하는 모드
| Name | 형식 | Description |
|---|---|---|
| checkBox |
string |
확인란이 표시되어야 합니다(true/false 값의 경우). |
| combo |
string |
select/combo 컨트롤이 표시되어야 합니다. |
| none |
string |
이 입력은 UI에 표시되지 않아야 합니다. |
| passwordBox |
string |
암호 입력 상자가 표시되어야 합니다. |
| radioButtons |
string |
라디오 단추가 표시되어야 합니다. |
| textArea |
string |
여러 줄 텍스트 영역을 표시해야 합니다. |
| textBox |
string |
입력 텍스트 상자가 표시되어야 합니다. |
InputValidation
구독 입력에 유효한 값을 설명합니다.
| Name | 형식 | Description |
|---|---|---|
| dataType |
유효성을 검사할 데이터 형식을 가져오거나 설정합니다. |
|
| isRequired |
boolean |
필수 필드인 경우 를 가져오거나 설정합니다. |
| maxLength |
integer |
이 설명자의 최대 길이를 가져오거나 설정합니다. |
| maxValue |
string |
이 설명자의 최소값을 가져오거나 설정합니다. |
| minLength |
integer |
이 설명자의 최소 길이를 가져오거나 설정합니다. |
| minValue |
string |
이 설명자의 최소값을 가져오거나 설정합니다. |
| pattern |
string |
유효성을 검사할 패턴을 가져오거나 설정합니다. |
| patternMismatchErrorMessage |
string |
패턴 불일치에 대한 오류를 가져오거나 설정합니다. |
InputValue
입력의 단일 값에 대한 정보
| Name | 형식 | Description |
|---|---|---|
| data |
object |
이 입력에 대한 다른 모든 데이터 |
| displayValue |
string |
이 값을 표시하기 위해 표시할 텍스트입니다. |
| value |
string |
이 입력에 저장할 값입니다. |
InputValues
지정된 구독 입력에 대해 가능한/허용되는 값에 대한 정보
| Name | 형식 | Description |
|---|---|---|
| defaultValue |
string |
이 입력에 사용할 기본값 |
| error |
동적 값을 계산하는 동안 오류가 발생했습니다. |
|
| inputId |
string |
입력의 ID |
| isDisabled |
boolean |
이 입력을 사용하지 않도록 설정해야 함 |
| isLimitedToPossibleValues |
boolean |
값이 PossibleValues(True)의 값 중 하나로 제한되거나 PossibleValues의 값이 제안 사항인 경우(False) |
| isReadOnly |
boolean |
이 입력을 읽기 전용으로 만들어야 하는 경우 |
| possibleValues |
이 입력에 사용할 수 있는 가능한 값 |
InputValuesError
구독 입력 값과 관련된 오류 정보입니다.
| Name | 형식 | Description |
|---|---|---|
| message |
string |
오류 메시지입니다. |
Publisher
이벤트 게시자의 데이터 계약을 정의합니다.
| Name | 형식 | Description |
|---|---|---|
| _links |
참조 링크 |
|
| description |
string |
이 게시자의 지역화된 설명을 가져옵니다. |
| id |
string |
이 게시자의 식별자를 가져옵니다. |
| inputDescriptors |
게시자별 입력 |
|
| name |
string |
이 게시자의 지역화된 이름을 가져옵니다. |
| serviceInstanceType |
string |
서비스 instance 자사 게시자의 형식입니다. |
| supportedEvents |
이 게시자의 지원되는 이벤트 유형을 가져옵니다. |
|
| url |
string |
이 리소스의 URL |
ReferenceLinks
REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
| Name | 형식 | Description |
|---|---|---|
| links |
object |
링크의 읽기 전용 보기입니다. 참조 링크는 읽기 전용이므로 읽기 전용으로만 노출하려고 합니다. |