RestClientRequestParams interface

Paket:

azure-devops-extension-api

Parametrar för att skicka en WebApi-begäran

Egenskaper

apiVersion	API-versionssträngen som ska skickas i begäran (t.ex. "1.0" eller "2.0-preview.2")
body	Data som ska publiceras. I det här fallet med en GET anger detta frågeparametrar. För andra begäranden är detta begärandetextobjektet (som serialiseras till en JSON-sträng om inte isRawData är inställt på true).
command	Aktuellt kommando för aktivitetsloggning. Detta åsidosätter RestClient's base alternativ.
customHeaders	Gör att anroparen kan ange anpassade begärandehuvuden.
httpResponseType	Typen http-svar (Accept). Det här är "json" (motsvarar application/json Accept-huvudet) om inget annat anges. Andra möjliga värden är "html", "text", "zip" eller "binary" eller deras accepter-motsvarigheter (t.ex. application/zip).
isRawData	Om det är sant anger detta att ingen bearbetning ska göras på objektet "data" innan det skickas i begäran. Detta behövs sällan. Ett fall är när du postar ett HTML5-filobjekt.
method	HTTP-verb (GET som standard om det inte anges)
queryParams	Fråga parametrar som ska läggas till i URL:en. När det gäller en GET kan frågeparametrar anges via "data" eller "queryParams". För andra verb, till exempel POST, anger dataobjektet POST-brödtexten, så queryParams behövs för att ange parametrar som ska läggas till i frågesträngen för URL:en (ingår inte i post-brödtexten).
returnRawResponse	Om det är sant anger det att råsvaret ska returneras i begärans resulterande löfte i stället för att deserialisera svaret (standard).
routeTemplate	Routningsmall som används för att skapa sökvägen för begäran. Om routeTemplate INTE anges används locationId för att söka efter mallen via en OPTIONS-begäran.
routeValues	Ordlista över ersättningsvärden för vägmallar

Egenskapsinformation

apiVersion

API-versionssträngen som ska skickas i begäran (t.ex. "1.0" eller "2.0-preview.2")

apiVersion: string

Egenskapsvärde

string

body

Data som ska publiceras. I det här fallet med en GET anger detta frågeparametrar. För andra begäranden är detta begärandetextobjektet (som serialiseras till en JSON-sträng om inte isRawData är inställt på true).

body?: any

Egenskapsvärde

any

command

Aktuellt kommando för aktivitetsloggning. Detta åsidosätter RestClient's base alternativ.

command?: string

Egenskapsvärde

string

customHeaders

Gör att anroparen kan ange anpassade begärandehuvuden.

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

Egenskapsvärde

{[headerName: string]: any}

httpResponseType

Typen http-svar (Accept). Det här är "json" (motsvarar application/json Accept-huvudet) om inget annat anges. Andra möjliga värden är "html", "text", "zip" eller "binary" eller deras accepter-motsvarigheter (t.ex. application/zip).

httpResponseType?: string

Egenskapsvärde

string

isRawData

Om det är sant anger detta att ingen bearbetning ska göras på objektet "data" innan det skickas i begäran. Detta behövs sällan. Ett fall är när du postar ett HTML5-filobjekt.

isRawData?: boolean

Egenskapsvärde

boolean

method

HTTP-verb (GET som standard om det inte anges)

method?: string

Egenskapsvärde

string

queryParams

Fråga parametrar som ska läggas till i URL:en. När det gäller en GET kan frågeparametrar anges via "data" eller "queryParams". För andra verb, till exempel POST, anger dataobjektet POST-brödtexten, så queryParams behövs för att ange parametrar som ska läggas till i frågesträngen för URL:en (ingår inte i post-brödtexten).

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

Egenskapsvärde

{[key: string]: any}

returnRawResponse

Om det är sant anger det att råsvaret ska returneras i begärans resulterande löfte i stället för att deserialisera svaret (standard).

returnRawResponse?: boolean

Egenskapsvärde

boolean

routeTemplate

Routningsmall som används för att skapa sökvägen för begäran. Om routeTemplate INTE anges används locationId för att söka efter mallen via en OPTIONS-begäran.

routeTemplate: string

Egenskapsvärde

string

routeValues

Ordlista över ersättningsvärden för vägmallar

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

Egenskapsvärde

{[key: string]: any}