RestClientRequestParams interface

Paket:

azure-devops-extension-api

Parameter für das Senden einer WebApi-Anfrage

Eigenschaften

apiVersion	Die API-Versionszeichenfolge, die in der Anforderung gesendet werden soll (z. B. "1.0" oder "2.0-preview.2")
body	Zu buchende Daten. In diesem Fall eines GET gibt dies Abfrageparameter an. Bei anderen Anforderungen ist dies das Anforderungstextobjekt (das in eine JSON-Zeichenfolge serialisiert wird, es sei denn, isRawData ist auf true festgelegt).
command	Aktueller Befehl für die Aktivitätsprotokollierung. Dadurch wird die Basisoption von RestClient überschrieben.
customHeaders	Ermöglicht dem Aufrufer, benutzerdefinierte Anforderungsheader anzugeben.
httpResponseType	Der HTTP-Antworttyp (Accept). Dies ist "json" (entspricht dem application/json Accept-Header), sofern nicht anders angegeben. Andere mögliche Werte sind "html", "text", "zip" oder "binary" oder deren Äquivalente zum Accept-Header (z. B. application/zip).
isRawData	Wenn true, bedeutet dies, dass keine Verarbeitung für das "data"-Objekt durchgeführt werden sollte, bevor es in der Anfrage gesendet wird. Dies wird nur selten benötigt. Ein Fall ist das Posten eines HTML5-Dateiobjekts.
method	HTTP-Verb (standardmäßig GET, wenn nicht angegeben)
queryParams	Abfrageparameter, die der URL hinzugefügt werden sollen. Im Falle eines GET können Abfrageparameter über 'data' oder 'queryParams' angegeben werden. Bei anderen Verben wie POST gibt das Datenobjekt den POST-Text an, sodass queryParams erforderlich ist, um Parameter anzugeben, die der Abfragezeichenfolge der URL hinzugefügt werden sollen (nicht im POST-Text enthalten).
returnRawResponse	Wenn true, gibt dies an, dass die unformatierte Antwort in der resultierenden Zusage der Anforderung zurückgegeben werden soll, anstatt die Antwort zu deserialisieren (Standard).
routeTemplate	Routenvorlage, die zum Erstellen des Anforderungspfads verwendet wird. Wenn routeTemplate NICHT angegeben ist, wird locationId verwendet, um die Vorlage über eine OPTIONS-Anforderung nachzuschlagen.
routeValues	Wörterbuch der Ersetzungswerte für Routenvorlagen

Details zur Eigenschaft

apiVersion

Die API-Versionszeichenfolge, die in der Anforderung gesendet werden soll (z. B. "1.0" oder "2.0-preview.2")

apiVersion: string

Eigenschaftswert

string

body

Zu buchende Daten. In diesem Fall eines GET gibt dies Abfrageparameter an. Bei anderen Anforderungen ist dies das Anforderungstextobjekt (das in eine JSON-Zeichenfolge serialisiert wird, es sei denn, isRawData ist auf true festgelegt).

body?: any

Eigenschaftswert

any

command

Aktueller Befehl für die Aktivitätsprotokollierung. Dadurch wird die Basisoption von RestClient überschrieben.

command?: string

Eigenschaftswert

string

customHeaders

Ermöglicht dem Aufrufer, benutzerdefinierte Anforderungsheader anzugeben.

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

Eigenschaftswert

{[headerName: string]: any}

httpResponseType

Der HTTP-Antworttyp (Accept). Dies ist "json" (entspricht dem application/json Accept-Header), sofern nicht anders angegeben. Andere mögliche Werte sind "html", "text", "zip" oder "binary" oder deren Äquivalente zum Accept-Header (z. B. application/zip).

httpResponseType?: string

Eigenschaftswert

string

isRawData

Wenn true, bedeutet dies, dass keine Verarbeitung für das "data"-Objekt durchgeführt werden sollte, bevor es in der Anfrage gesendet wird. Dies wird nur selten benötigt. Ein Fall ist das Posten eines HTML5-Dateiobjekts.

isRawData?: boolean

Eigenschaftswert

boolean

method

HTTP-Verb (standardmäßig GET, wenn nicht angegeben)

method?: string

Eigenschaftswert

string

queryParams

Abfrageparameter, die der URL hinzugefügt werden sollen. Im Falle eines GET können Abfrageparameter über 'data' oder 'queryParams' angegeben werden. Bei anderen Verben wie POST gibt das Datenobjekt den POST-Text an, sodass queryParams erforderlich ist, um Parameter anzugeben, die der Abfragezeichenfolge der URL hinzugefügt werden sollen (nicht im POST-Text enthalten).

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

Eigenschaftswert

{[key: string]: any}

returnRawResponse

Wenn true, gibt dies an, dass die unformatierte Antwort in der resultierenden Zusage der Anforderung zurückgegeben werden soll, anstatt die Antwort zu deserialisieren (Standard).

returnRawResponse?: boolean

Eigenschaftswert

boolean

routeTemplate

Routenvorlage, die zum Erstellen des Anforderungspfads verwendet wird. Wenn routeTemplate NICHT angegeben ist, wird locationId verwendet, um die Vorlage über eine OPTIONS-Anforderung nachzuschlagen.

routeTemplate: string

Eigenschaftswert

string

routeValues

Wörterbuch der Ersetzungswerte für Routenvorlagen

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

Eigenschaftswert

{[key: string]: any}