RestClientRequestParams interface

Paquete:

azure-devops-extension-api

Parámetros para enviar una solicitud de WebApi

Propiedades

apiVersion	Cadena de versión de api que se va a enviar en la solicitud (por ejemplo, "1.0" o "2.0-preview.2")
body	Datos que se van a publicar. En este caso de get, esto indica los parámetros de consulta. Para otras solicitudes, este es el objeto del cuerpo de la solicitud (que se serializará en una cadena JSON a menos que isRawData esté establecido en true).
command	Comando actual para el registro de actividad. Esto invalidará la opción base de RestClient.
customHeaders	Permite al autor de la llamada especificar encabezados de solicitud personalizados.
httpResponseType	Tipo http response (Accept). Se trata de "json" (corresponde al encabezado Accept de aplicación/json), a menos que se especifique lo contrario. Otros valores posibles son "html", "text", "zip" o "binary" o sus equivalentes de encabezado de aceptación (por ejemplo, application/zip).
isRawData	Si es true, esto indica que no se debe realizar ningún procesamiento en el objeto "data" antes de enviarlo en la solicitud. Esto rara vez es necesario. Un caso es cuando se publica un objeto File HTML5.
method	Verbo HTTP (GET de forma predeterminada si no se especifica)
queryParams	Parámetros de consulta que se van a agregar a la dirección URL. En el caso de get, los parámetros de consulta se pueden proporcionar a través de "data" o "queryParams". Para otros verbos como POST, el objeto de datos especifica el cuerpo POST, por lo que queryParams es necesario para indicar los parámetros que se van a agregar a la cadena de consulta de la dirección URL (no se incluye en el cuerpo de la publicación).
returnRawResponse	Si es true, indica que la respuesta sin procesar debe devolverse en la promesa resultante de la solicitud en lugar de deserializar la respuesta (valor predeterminado).
routeTemplate	Plantilla de ruta que se usa para formar la ruta de acceso de la solicitud. Si no se especifica routeTemplate, locationId se usa para buscar la plantilla a través de una solicitud OPTIONS.
routeValues	Diccionario de valores de reemplazo de plantilla de ruta

Detalles de las propiedades

apiVersion

Cadena de versión de api que se va a enviar en la solicitud (por ejemplo, "1.0" o "2.0-preview.2")

apiVersion: string

Valor de propiedad

string

body

Datos que se van a publicar. En este caso de get, esto indica los parámetros de consulta. Para otras solicitudes, este es el objeto del cuerpo de la solicitud (que se serializará en una cadena JSON a menos que isRawData esté establecido en true).

body?: any

Valor de propiedad

any

command

Comando actual para el registro de actividad. Esto invalidará la opción base de RestClient.

command?: string

Valor de propiedad

string

customHeaders

Permite al autor de la llamada especificar encabezados de solicitud personalizados.

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

Valor de propiedad

{[headerName: string]: any}

httpResponseType

Tipo http response (Accept). Se trata de "json" (corresponde al encabezado Accept de aplicación/json), a menos que se especifique lo contrario. Otros valores posibles son "html", "text", "zip" o "binary" o sus equivalentes de encabezado de aceptación (por ejemplo, application/zip).

httpResponseType?: string

Valor de propiedad

string

isRawData

Si es true, esto indica que no se debe realizar ningún procesamiento en el objeto "data" antes de enviarlo en la solicitud. Esto rara vez es necesario. Un caso es cuando se publica un objeto File HTML5.

isRawData?: boolean

Valor de propiedad

boolean

method

Verbo HTTP (GET de forma predeterminada si no se especifica)

method?: string

Valor de propiedad

string

queryParams

Parámetros de consulta que se van a agregar a la dirección URL. En el caso de get, los parámetros de consulta se pueden proporcionar a través de "data" o "queryParams". Para otros verbos como POST, el objeto de datos especifica el cuerpo POST, por lo que queryParams es necesario para indicar los parámetros que se van a agregar a la cadena de consulta de la dirección URL (no se incluye en el cuerpo de la publicación).

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

Valor de propiedad

{[key: string]: any}

returnRawResponse

Si es true, indica que la respuesta sin procesar debe devolverse en la promesa resultante de la solicitud en lugar de deserializar la respuesta (valor predeterminado).

returnRawResponse?: boolean

Valor de propiedad

boolean

routeTemplate

Plantilla de ruta que se usa para formar la ruta de acceso de la solicitud. Si no se especifica routeTemplate, locationId se usa para buscar la plantilla a través de una solicitud OPTIONS.

routeTemplate: string

Valor de propiedad

string

routeValues

Diccionario de valores de reemplazo de plantilla de ruta

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

Valor de propiedad

{[key: string]: any}