RestClientRequestParams interface

Pacchetto:

azure-devops-extension-api

Parametri per l'invio di una richiesta WebApi

Proprietà

apiVersion	La stringa della versione dell'API da inviare nella richiesta (ad esempio "1.0" o "2.0-preview.2")
body	Dati da pubblicare. In questo caso di un GET, indica i parametri di query. Per altre richieste, si tratta dell'oggetto corpo della richiesta (che verrà serializzato in una stringa JSON a meno che isRawData non sia impostato su true).
command	Comando corrente per la registrazione delle attività. In questo modo verrà eseguito l'override dell'opzione di base di RestClient.
customHeaders	Consente al chiamante di specificare intestazioni di richiesta personalizzate.
httpResponseType	Tipo di risposta http (Accept). Si tratta di "json" (corrisponde all'intestazione application/json Accept) se non diversamente specificato. Altri valori possibili sono "html", "text", "zip" o "binary" o i loro equivalenti di intestazione accept (ad esempio application/zip).
isRawData	Se true, ciò indica che non deve essere eseguita alcuna elaborazione sull'oggetto 'data' prima che venga inviato nella richiesta. Questo è raramente necessario. Un caso è quando si pubblica un oggetto File HTML5.
method	Verbo HTTP (GET per impostazione predefinita se non specificato)
queryParams	Parametri di query da aggiungere all'URL. Nel caso di un GET, i parametri di query possono essere forniti tramite 'data' o 'queryParams'. Per altri verbi come POST, l'oggetto dati specifica il corpo del POST, quindi queryParams è necessario per indicare i parametri da aggiungere alla stringa di query dell'url (non inclusi nel corpo del post).
returnRawResponse	Se true, indica che la risposta non elaborata deve essere restituita nella promessa risultante della richiesta anziché deserializzare la risposta (impostazione predefinita).
routeTemplate	Modello di route utilizzato per formare il percorso della richiesta. Se routeTemplate NON è specificato, viene utilizzato locationId per cercare il modello tramite una richiesta OPTIONS.
routeValues	Dizionario dei valori di sostituzione del modello di percorso

Dettagli proprietà

apiVersion

La stringa della versione dell'API da inviare nella richiesta (ad esempio "1.0" o "2.0-preview.2")

apiVersion: string

Valore della proprietà

string

body

Dati da pubblicare. In questo caso di un GET, indica i parametri di query. Per altre richieste, si tratta dell'oggetto corpo della richiesta (che verrà serializzato in una stringa JSON a meno che isRawData non sia impostato su true).

body?: any

Valore della proprietà

any

command

Comando corrente per la registrazione delle attività. In questo modo verrà eseguito l'override dell'opzione di base di RestClient.

command?: string

Valore della proprietà

string

customHeaders

Consente al chiamante di specificare intestazioni di richiesta personalizzate.

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

Valore della proprietà

{[headerName: string]: any}

httpResponseType

Tipo di risposta http (Accept). Si tratta di "json" (corrisponde all'intestazione application/json Accept) se non diversamente specificato. Altri valori possibili sono "html", "text", "zip" o "binary" o i loro equivalenti di intestazione accept (ad esempio application/zip).

httpResponseType?: string

Valore della proprietà

string

isRawData

Se true, ciò indica che non deve essere eseguita alcuna elaborazione sull'oggetto 'data' prima che venga inviato nella richiesta. Questo è raramente necessario. Un caso è quando si pubblica un oggetto File HTML5.

isRawData?: boolean

Valore della proprietà

boolean

method

Verbo HTTP (GET per impostazione predefinita se non specificato)

method?: string

Valore della proprietà

string

queryParams

Parametri di query da aggiungere all'URL. Nel caso di un GET, i parametri di query possono essere forniti tramite 'data' o 'queryParams'. Per altri verbi come POST, l'oggetto dati specifica il corpo del POST, quindi queryParams è necessario per indicare i parametri da aggiungere alla stringa di query dell'url (non inclusi nel corpo del post).

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

Valore della proprietà

{[key: string]: any}

returnRawResponse

Se true, indica che la risposta non elaborata deve essere restituita nella promessa risultante della richiesta anziché deserializzare la risposta (impostazione predefinita).

returnRawResponse?: boolean

Valore della proprietà

boolean

routeTemplate

Modello di route utilizzato per formare il percorso della richiesta. Se routeTemplate NON è specificato, viene utilizzato locationId per cercare il modello tramite una richiesta OPTIONS.

routeTemplate: string

Valore della proprietà

string

routeValues

Dizionario dei valori di sostituzione del modello di percorso

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

Valore della proprietà

{[key: string]: any}