RestClientRequestParams interface

Balíček:

azure-devops-extension-api

Parametry pro odeslání požadavku WebApi

Vlastnosti

apiVersion	Řetězec verze rozhraní API pro odeslání v požadavku (např. 1.0 nebo 2.0-preview.2)
body	Data, která se mají publikovat V tomto případě get označuje parametry dotazu. U jiných požadavků se jedná o objekt textu požadavku (který se serializuje do řetězce JSON, pokud není nastavená hodnota true).
command	Aktuální příkaz pro protokolování aktivit Tím se přepíše základní možnost RestClient.
customHeaders	Umožňuje volajícímu zadat vlastní hlavičky požadavků.
httpResponseType	Typ odpovědi HTTP (Accept). Toto je json (odpovídá hlavičce application/json Accept), pokud není uvedeno jinak. Další možné hodnoty jsou "html", "text", "zip" nebo "binary" nebo jejich ekvivalenty hlavičky accept (např. application/zip).
isRawData	Pokud je pravda, znamená to, že před odesláním v požadavku by se nemělo provádět žádné zpracování u objektu data. To je zřídka potřeba. Jedním z případů je publikování objektu HTML5 File.
method	Příkaz HTTP (get ve výchozím nastavení, pokud není zadaný)
queryParams	Parametry dotazu, které se mají přidat na adresu URL. V případě metody GET je možné parametry dotazu zadat prostřednictvím "data" nebo "queryParams". U jiných sloves, jako je POST, datový objekt určuje tělo POST, takže queryParams je potřeba indikovat parametry, které se mají přidat do řetězce dotazu adresy URL (není součástí textu příspěvku).
returnRawResponse	Pokud ano, znamená to, že nezpracovaná odpověď by měla být vrácena ve výsledném slibu požadavku místo deserializace odpovědi (výchozí).
routeTemplate	Šablona trasy, která se používá k vytvoření cesty požadavku. Pokud parametr routeTemplate není zadaný, použije se k vyhledání šablony prostřednictvím požadavku OPTIONS ID umístění.
routeValues	Slovník náhradních hodnot šablon trasy

Podrobnosti vlastnosti

apiVersion

Řetězec verze rozhraní API pro odeslání v požadavku (např. 1.0 nebo 2.0-preview.2)

apiVersion: string

Hodnota vlastnosti

string

body

Data, která se mají publikovat V tomto případě get označuje parametry dotazu. U jiných požadavků se jedná o objekt textu požadavku (který se serializuje do řetězce JSON, pokud není nastavená hodnota true).

body?: any

Hodnota vlastnosti

any

command

Aktuální příkaz pro protokolování aktivit Tím se přepíše základní možnost RestClient.

command?: string

Hodnota vlastnosti

string

customHeaders

Umožňuje volajícímu zadat vlastní hlavičky požadavků.

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

Hodnota vlastnosti

{[headerName: string]: any}

httpResponseType

Typ odpovědi HTTP (Accept). Toto je json (odpovídá hlavičce application/json Accept), pokud není uvedeno jinak. Další možné hodnoty jsou "html", "text", "zip" nebo "binary" nebo jejich ekvivalenty hlavičky accept (např. application/zip).

httpResponseType?: string

Hodnota vlastnosti

string

isRawData

Pokud je pravda, znamená to, že před odesláním v požadavku by se nemělo provádět žádné zpracování u objektu data. To je zřídka potřeba. Jedním z případů je publikování objektu HTML5 File.

isRawData?: boolean

Hodnota vlastnosti

boolean

method

Příkaz HTTP (get ve výchozím nastavení, pokud není zadaný)

method?: string

Hodnota vlastnosti

string

queryParams

Parametry dotazu, které se mají přidat na adresu URL. V případě metody GET je možné parametry dotazu zadat prostřednictvím "data" nebo "queryParams". U jiných sloves, jako je POST, datový objekt určuje tělo POST, takže queryParams je potřeba indikovat parametry, které se mají přidat do řetězce dotazu adresy URL (není součástí textu příspěvku).

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

Hodnota vlastnosti

{[key: string]: any}

returnRawResponse

Pokud ano, znamená to, že nezpracovaná odpověď by měla být vrácena ve výsledném slibu požadavku místo deserializace odpovědi (výchozí).

returnRawResponse?: boolean

Hodnota vlastnosti

boolean

routeTemplate

Šablona trasy, která se používá k vytvoření cesty požadavku. Pokud parametr routeTemplate není zadaný, použije se k vyhledání šablony prostřednictvím požadavku OPTIONS ID umístění.

routeTemplate: string

Hodnota vlastnosti

string

routeValues

Slovník náhradních hodnot šablon trasy

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

Hodnota vlastnosti

{[key: string]: any}