RestClientRequestParams interface

Pacote:

azure-devops-extension-api

Parâmetros para enviar uma solicitação WebApi

Propriedades

apiVersion	A cadeia de caracteres de versão da API a ser enviada na solicitação (por exemplo, "1.0" ou "2.0-preview.2")
body	Dados a serem postados. Nesse caso de um GET, isso indica parâmetros de consulta. Para outras solicitações, esse é o objeto do corpo da solicitação (que será serializado em uma cadeia de caracteres JSON, a menos que isRawData esteja definido como true).
command	Comando atual para registro em log de atividades. Isso substituirá a opção base do RestClient.
customHeaders	Permite que o chamador especifique cabeçalhos de solicitação personalizados.
httpResponseType	O tipo de resposta http (Aceitar). Isso é "json" (corresponde ao cabeçalho de aceitação do aplicativo/json), a menos que especificado de outra forma. Outros valores possíveis são "html", "text", "zip" ou "binary" ou seus equivalentes de cabeçalho de aceitação (por exemplo, aplicativo/zip).
isRawData	Se for true, isso indica que nenhum processamento deve ser feito no objeto 'data' antes de ser enviado na solicitação. Isso raramente é necessário. Um caso é ao postar um objeto arquivo HTML5.
method	Verbo HTTP (GET por padrão, se não for especificado)
queryParams	Parâmetros de consulta a serem adicionados à URL. No caso de um GET, os parâmetros de consulta podem ser fornecidos por meio de "dados" ou "queryParams". Para outros verbos, como POST, o objeto de dados especifica o corpo POST, portanto, queryParams é necessário para indicar parâmetros a serem adicionados à cadeia de caracteres de consulta da url (não incluído no corpo da postagem).
returnRawResponse	Se verdadeiro, indica que a resposta bruta deve ser retornada na promessa resultante da solicitação em vez de desserializar a resposta (o padrão).
routeTemplate	Modelo de rota usado para formar o caminho da solicitação. Se routeTemplate NÃO for especificado, locationId será usado para pesquisar o modelo por meio de uma solicitação OPTIONS.
routeValues	Dicionário de valores de substituição de modelo de rota

Detalhes da propriedade

apiVersion

A cadeia de caracteres de versão da API a ser enviada na solicitação (por exemplo, "1.0" ou "2.0-preview.2")

apiVersion: string

Valor da propriedade

string

body

Dados a serem postados. Nesse caso de um GET, isso indica parâmetros de consulta. Para outras solicitações, esse é o objeto do corpo da solicitação (que será serializado em uma cadeia de caracteres JSON, a menos que isRawData esteja definido como true).

body?: any

Valor da propriedade

any

command

Comando atual para registro em log de atividades. Isso substituirá a opção base do RestClient.

command?: string

Valor da propriedade

string

customHeaders

Permite que o chamador especifique cabeçalhos de solicitação personalizados.

customHeaders?: {[headerName: string]: any}

Valor da propriedade

{[headerName: string]: any}

httpResponseType

O tipo de resposta http (Aceitar). Isso é "json" (corresponde ao cabeçalho de aceitação do aplicativo/json), a menos que especificado de outra forma. Outros valores possíveis são "html", "text", "zip" ou "binary" ou seus equivalentes de cabeçalho de aceitação (por exemplo, aplicativo/zip).

httpResponseType?: string

Valor da propriedade

string

isRawData

Se for true, isso indica que nenhum processamento deve ser feito no objeto 'data' antes de ser enviado na solicitação. Isso raramente é necessário. Um caso é ao postar um objeto arquivo HTML5.

isRawData?: boolean

Valor da propriedade

boolean

method

Verbo HTTP (GET por padrão, se não for especificado)

method?: string

Valor da propriedade

string

queryParams

Parâmetros de consulta a serem adicionados à URL. No caso de um GET, os parâmetros de consulta podem ser fornecidos por meio de "dados" ou "queryParams". Para outros verbos, como POST, o objeto de dados especifica o corpo POST, portanto, queryParams é necessário para indicar parâmetros a serem adicionados à cadeia de caracteres de consulta da url (não incluído no corpo da postagem).

queryParams?: {[key: string]: any}

Valor da propriedade

{[key: string]: any}

returnRawResponse

Se verdadeiro, indica que a resposta bruta deve ser retornada na promessa resultante da solicitação em vez de desserializar a resposta (o padrão).

returnRawResponse?: boolean

Valor da propriedade

boolean

routeTemplate

Modelo de rota usado para formar o caminho da solicitação. Se routeTemplate NÃO for especificado, locationId será usado para pesquisar o modelo por meio de uma solicitação OPTIONS.

routeTemplate: string

Valor da propriedade

string

routeValues

Dicionário de valores de substituição de modelo de rota

routeValues?: {[key: string]: any}

Valor da propriedade

{[key: string]: any}