Publishers - Query Input Values

Service:

Service Hooks

API Version:

5.1

POST https://dev.azure.com/{organization}/_apis/hooks/publishers/{publisherId}/inputValuesQuery?api-version=5.1

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
publisherId	path	True	string
api-version	query	True	string	Version of the API to use. This should be set to '5.1' to use this version of the api.

Request Body

Name	Type	Description
currentValues	object
inputValues	InputValues[]	The input values to return on input, and the result from the consumer on output.
resource	object	Subscription containing information about the publisher/consumer and the current input values

Responses

Name	Type	Description
200 OK	InputValuesQuery	successful operation

Security

accessToken

Personal access token. Use any value for the user name and the token as the password.

Type: basic

Definitions

Name	Description
InputValue	Information about a single value for an input
InputValues	Information about the possible/allowed values for a given subscription input
InputValuesError	Error information related to a subscription input value.
InputValuesQuery

InputValue

Information about a single value for an input

Name	Type	Description
data	object	Any other data about this input
displayValue	string	The text to show for the display of this value
value	string	The value to store for this input

InputValues

Information about the possible/allowed values for a given subscription input

Name	Type	Description
defaultValue	string	The default value to use for this input
error	InputValuesError	Errors encountered while computing dynamic values.
inputId	string	The id of the input
isDisabled	boolean	Should this input be disabled
isLimitedToPossibleValues	boolean	Should the value be restricted to one of the values in the PossibleValues (True) or are the values in PossibleValues just a suggestion (False)
isReadOnly	boolean	Should this input be made read-only
possibleValues	InputValue[]	Possible values that this input can take

InputValuesError

Error information related to a subscription input value.

Name	Type	Description
message	string	The error message.

InputValuesQuery

Name	Type	Description
currentValues	object
inputValues	InputValues[]	The input values to return on input, and the result from the consumer on output.
resource	object	Subscription containing information about the publisher/consumer and the current input values