RestClientRequestParams interface

Csomag:

azure-devops-extension-api

WebApi-kérés küldéséhez szükséges paraméterek

Tulajdonságok

apiVersion	A kérelemben elküldendő API-verzió sztringje (például "1.0" vagy "2.0-preview.2")
body	Közzétenni kívánt adatok. Ebben az esetben a GET lekérdezési paramétereket jelzi. Más kérések esetén ez a kérelem törzsobjektuma (amely JSON-sztringbe lesz szerializálva, kivéve, ha az isRawData true értékre van állítva).
command	A tevékenységnaplózás aktuális parancsa. Ez felülbírálja a RestClient alapbeállítását.
customHeaders	Lehetővé teszi a hívó számára egyéni kérelemfejlécek megadását.
httpResponseType	A http-válasz (Elfogadás) típusa. Ez a "json" (az application/json Accept fejlécnek felel meg), hacsak nincs másképp megadva. További lehetséges értékek a "html", "text", "zip" vagy "binary" vagy azok elfogadó fejléc megfelelői (pl. application/zip).
isRawData	Ha igaz, ez azt jelzi, hogy a "data" objektumon nem kell feldolgozni a kérelem elküldése előtt. Erre ritkán van szükség. Az egyik eset egy HTML5 fájlobjektum közzététele.
method	HTTP-művelet (alapértelmezés szerint GET, ha nincs megadva)
queryParams	Az URL-címhez hozzáadandó lekérdezési paraméterek. GET esetén a lekérdezési paraméterek a "data" vagy a "queryParams" segítségével adhatók meg. Más műveletek (például POST) esetében az adatobjektum határozza meg a POST törzset, így a queryParams szükséges az url lekérdezési sztringjéhez hozzáadandó paraméterek jelzéséhez (nem szerepel a bejegyzés törzsében).
returnRawResponse	Ha igaz, azt jelzi, hogy a nyers választ a kérés eredményül kapott ígéretében kell visszaadni a válasz deszerializálása helyett (alapértelmezett).
routeTemplate	A kérelem elérési útjának kialakításához használt útvonalsablon. Ha routeTemplate NINCS megadva, akkor a locationId használatával keresi meg a sablont egy OPTIONS kéréssel.
routeValues	Útvonalsablon-helyettesítő értékek szótára

Tulajdonság adatai

apiVersion

A kérelemben elküldendő API-verzió sztringje (például "1.0" vagy "2.0-preview.2")

apiVersion: string

Tulajdonság értéke

string

body

Közzétenni kívánt adatok. Ebben az esetben a GET lekérdezési paramétereket jelzi. Más kérések esetén ez a kérelem törzsobjektuma (amely JSON-sztringbe lesz szerializálva, kivéve, ha az isRawData true értékre van állítva).

body?: any

Tulajdonság értéke

any

command

A tevékenységnaplózás aktuális parancsa. Ez felülbírálja a RestClient alapbeállítását.

command?: string

Tulajdonság értéke

string

customHeaders

Lehetővé teszi a hívó számára egyéni kérelemfejlécek megadását.

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

Tulajdonság értéke

{[headerName: string]: any}

httpResponseType

A http-válasz (Elfogadás) típusa. Ez a "json" (az application/json Accept fejlécnek felel meg), hacsak nincs másképp megadva. További lehetséges értékek a "html", "text", "zip" vagy "binary" vagy azok elfogadó fejléc megfelelői (pl. application/zip).

httpResponseType?: string

Tulajdonság értéke

string

isRawData

Ha igaz, ez azt jelzi, hogy a "data" objektumon nem kell feldolgozni a kérelem elküldése előtt. Erre ritkán van szükség. Az egyik eset egy HTML5 fájlobjektum közzététele.

isRawData?: boolean

Tulajdonság értéke

boolean

method

HTTP-művelet (alapértelmezés szerint GET, ha nincs megadva)

method?: string

Tulajdonság értéke

string

queryParams

Az URL-címhez hozzáadandó lekérdezési paraméterek. GET esetén a lekérdezési paraméterek a "data" vagy a "queryParams" segítségével adhatók meg. Más műveletek (például POST) esetében az adatobjektum határozza meg a POST törzset, így a queryParams szükséges az url lekérdezési sztringjéhez hozzáadandó paraméterek jelzéséhez (nem szerepel a bejegyzés törzsében).

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

Tulajdonság értéke

{[key: string]: any}

returnRawResponse

Ha igaz, azt jelzi, hogy a nyers választ a kérés eredményül kapott ígéretében kell visszaadni a válasz deszerializálása helyett (alapértelmezett).

returnRawResponse?: boolean

Tulajdonság értéke

boolean

routeTemplate

A kérelem elérési útjának kialakításához használt útvonalsablon. Ha routeTemplate NINCS megadva, akkor a locationId használatával keresi meg a sablont egy OPTIONS kéréssel.

routeTemplate: string

Tulajdonság értéke

string

routeValues

Útvonalsablon-helyettesítő értékek szótára

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

Tulajdonság értéke

{[key: string]: any}