Publishers - Query Publishers
查詢服務勾點發行者。
POST https://dev.azure.com/{organization}/_apis/hooks/publishersquery?api-version=7.1-preview.1URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps 組織的名稱。 |
|
api-version
|
query | True |
string |
要使用的 API 版本。 這應該設定為 '7.1-preview.1' 以使用此版本的 API。 |
要求本文
| 名稱 | 類型 | Description |
|---|---|---|
| publisherIds |
string[] |
選擇性的發行者識別碼清單，以限制結果 |
| publisherInputs |
object |
篩選發行者輸入 |
| results |
查詢的結果 |
回應
| 名稱 | 類型 | 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
範圍
| 名稱 | Description |
|---|---|
| vso.work | 授與讀取工作專案、查詢、面板、區域和反復專案路徑，以及其他工作專案追蹤相關中繼資料的能力。 同時授與執行查詢、搜尋工作專案，以及透過服務勾點接收工作專案事件的通知的能力。 |
| vso.build | 授與存取組建成品的能力，包括建置結果、定義和要求，以及能夠透過服務勾點接收有關建置事件的通知。 |
| vso.code | 授與讀取有關認可、變更集、分支和其他版本控制成品之原始程式碼和中繼資料的能力。 也授與搜尋程式碼的能力，並透過服務勾點取得版本控制事件的通知。 |
定義
| 名稱 | Description |
|---|---|
|
Event |
描述事件種類 |
|
Input |
取得或設定要驗證的資料類型。 |
|
Input |
描述訂用帳戶的輸入。 |
|
Input |
應該輸入此輸入值的模式 |
|
Input |
描述哪些值對訂用帳戶輸入有效 |
|
Input |
輸入單一值的相關資訊 |
|
Input |
指定訂用帳戶輸入之可能/允許值的相關資訊 |
|
Input |
與訂用帳戶輸入值相關的錯誤資訊。 |
| Publisher |
定義事件發行者的資料合約。 |
|
Publishers |
定義服務勾點發行者的查詢。 |
|
Reference |
表示 REST 參考連結集合的類別。 |
EventTypeDescriptor
描述事件種類
| 名稱 | 類型 | Description |
|---|---|---|
| description |
string |
事件種類的當地語系化描述 |
| id |
string |
事件種類的唯一識別碼 |
| inputDescriptors |
事件特定輸入 |
|
| name |
string |
事件種類的當地語系化易記名稱 |
| publisherId |
string |
這個事件種類的發行者的唯一識別碼 |
| supportedResourceVersions |
string[] |
事件資源承載的支援版本。 |
| url |
string |
此資源的 URL |
InputDataType
取得或設定要驗證的資料類型。
| 名稱 | 類型 | Description |
|---|---|---|
| boolean |
string |
表示 true 或 false 的值。 |
| guid |
string |
表示 Guid。 |
| none |
string |
未指定資料類型。 |
| number |
string |
表示數值。 |
| string |
string |
表示文字值。 |
| uri |
string |
表示 URI。 |
InputDescriptor
描述訂用帳戶的輸入。
| 名稱 | 類型 | Description |
|---|---|---|
| dependencyInputIds |
string[] |
此輸入值相依之所有輸入的識別碼。 |
| description |
string |
此輸入用途的描述 |
| groupName |
string |
此輸入所屬的群組當地語系化名稱，可以顯示為容器的標頭，其中包含群組中的所有輸入。 |
| hasDynamicValueInformation |
boolean |
如果為 true，則此輸入的值資訊是動態的，而且應該在相依性輸入的值變更時擷取。 |
| id |
string |
訂用帳戶輸入的識別碼 |
| inputMode |
應該輸入此輸入值的模式 |
|
| isConfidential |
boolean |
取得此輸入是否為機密，例如密碼或應用程式金鑰 |
| name |
string |
當地語系化名稱，可顯示為訂用帳戶輸入的標籤 |
| properties |
object |
服務提供者可以使用之輸入的自訂屬性 |
| type |
string |
輸入值的基礎資料類型。 指定此值時，InputMode、Validation 和 Values 是選擇性的。 |
| useInDefaultDescription |
boolean |
取得這個輸入是否包含在預設產生的動作描述中。 |
| validation |
用來驗證此輸入值的資訊 |
|
| valueHint |
string |
輸入值的提示。 它可用於 UI 作為輸入預留位置。 |
| values |
此輸入可能值的相關資訊 |
InputMode
應該輸入此輸入值的模式
| 名稱 | 類型 | Description |
|---|---|---|
| checkBox |
string |
核取方塊應該會顯示為 true/false 值 () |
| combo |
string |
應該顯示選取/下拉式控制項 |
| none |
string |
此輸入不應該顯示在 UI 中 |
| passwordBox |
string |
應該會顯示密碼輸入方塊 |
| radioButtons |
string |
應該顯示選項按鈕 |
| textArea |
string |
應該顯示多行文字區域 |
| textBox |
string |
應該會顯示輸入文字方塊 |
InputValidation
描述哪些值對訂用帳戶輸入有效
| 名稱 | 類型 | Description |
|---|---|---|
| dataType |
取得或設定要驗證的資料類型。 |
|
| isRequired |
boolean |
取得或設定這是必要欄位。 |
| maxLength |
integer |
取得或設定這個描述元的最大長度。 |
| maxValue |
string |
取得或設定這個描述元的最小值。 |
| minLength |
integer |
取得或設定這個描述元的最小長度。 |
| minValue |
string |
取得或設定這個描述元的最小值。 |
| pattern |
string |
取得或設定要驗證的模式。 |
| patternMismatchErrorMessage |
string |
取得或設定模式不符的錯誤。 |
InputValue
輸入單一值的相關資訊
| 名稱 | 類型 | Description |
|---|---|---|
| data |
object |
關於此輸入的任何其他資料 |
| displayValue |
string |
要顯示此值的文字 |
| value |
string |
要儲存此輸入的值 |
InputValues
指定訂用帳戶輸入之可能/允許值的相關資訊
| 名稱 | 類型 | Description |
|---|---|---|
| defaultValue |
string |
要用於此輸入的預設值 |
| error |
計算動態值時發生錯誤。 |
|
| inputId |
string |
輸入的識別碼 |
| isDisabled |
boolean |
應停用此輸入 |
| isLimitedToPossibleValues |
boolean |
如果值限制為 PossibleValues 中的其中一個值， (True) 或 PossibleValues 中的值只是建議 (False) |
| isReadOnly |
boolean |
應將此輸入設為唯讀 |
| possibleValues |
此輸入可接受的可能值 |
InputValuesError
與訂用帳戶輸入值相關的錯誤資訊。
| 名稱 | 類型 | Description |
|---|---|---|
| message |
string |
錯誤訊息。 |
Publisher
定義事件發行者的資料合約。
| 名稱 | 類型 | Description |
|---|---|---|
| _links |
參考連結 |
|
| description |
string |
取得此發行者的當地語系化描述。 |
| id |
string |
取得這個發行者的識別碼。 |
| inputDescriptors |
發行者特定的輸入 |
|
| name |
string |
取得這個發行者的當地語系化名稱。 |
| serviceInstanceType |
string |
第一方發行者的服務實例類型。 |
| supportedEvents |
取得此發行者的支援事件種類。 |
|
| url |
string |
此資源的 URL |
PublishersQuery
定義服務勾點發行者的查詢。
| 名稱 | 類型 | Description |
|---|---|---|
| publisherIds |
string[] |
選擇性的發行者識別碼清單，以限制結果 |
| publisherInputs |
object |
篩選發行者輸入 |
| results |
查詢的結果 |
ReferenceLinks
表示 REST 參考連結集合的類別。
| 名稱 | 類型 | Description |
|---|---|---|
| links |
object |
連結的唯讀檢視。 因為參考連結是唯讀的，所以我們只想要將它們公開為唯讀。 |