RestClientRequestParams interface

Pakiet:

azure-devops-extension-api

Parametry wysyłania żądania interfejsu WebApi

Właściwości

apiVersion	Ciąg wersji interfejsu API, który ma zostać wysłany w żądaniu (np. "1.0" lub "2.0-preview.2")
body	Dane do opublikowania. W tym przypadku GET wskazuje to parametry zapytania. W przypadku innych żądań jest to obiekt treści żądania (który zostanie serializowany do ciągu JSON, chyba że parametr isRawData jest ustawiony na wartość true).
command	Bieżące polecenie rejestrowania aktywności. Spowoduje to zastąpienie opcji podstawowej RestClient.
customHeaders	Zezwala obiektowi wywołującemu na określenie niestandardowych nagłówków żądań.
httpResponseType	Typ odpowiedzi http (Accept). Jest to "json" (odpowiada nagłówkowi application/json Accept), chyba że określono inaczej. Inne możliwe wartości to "html", "text", "zip" lub "binary" lub ich odpowiedniki w nagłówku accept (np. application/zip).
isRawData	Jeśli to prawda, oznacza to, że na obiekcie "data" nie powinno być wykonywane żadne przetwarzanie przed wysłaniem go w żądaniu. Jest to rzadko potrzebne. Jednym z takich przypadków jest publikowanie obiektu pliku HTML5.
method	Czasownik HTTP (domyślnie GET, jeśli nie zostanie określony)
queryParams	Parametry zapytania, które mają zostać dodane do adresu URL. W przypadku GET parametry zapytania mogą być dostarczane za pośrednictwem polecenia "data" lub "queryParams". W przypadku innych czasowników, takich jak POST, obiekt danych określa treść POST, więc queryParams jest potrzebny do wskazania parametrów, które należy dodać do ciągu zapytania adresu URL (nie jest uwzględniony w treści postu).
returnRawResponse	Jeśli true, wskazuje, że nieprzetworzona odpowiedź powinna zostać zwrócona w wynikowej obietnicy żądania, a nie deserializacja odpowiedzi (wartość domyślna).
routeTemplate	Szablon trasy, który jest używany do tworzenia ścieżki żądania. Jeśli routeTemplate NIE zostanie określony, locationId jest używany do wyszukiwania szablonu za pośrednictwem żądania OPTIONS.
routeValues	Słownik wartości zastępczych szablonu trasy

Szczegóły właściwości

apiVersion

Ciąg wersji interfejsu API, który ma zostać wysłany w żądaniu (np. "1.0" lub "2.0-preview.2")

apiVersion: string

Wartość właściwości

string

body

Dane do opublikowania. W tym przypadku GET wskazuje to parametry zapytania. W przypadku innych żądań jest to obiekt treści żądania (który zostanie serializowany do ciągu JSON, chyba że parametr isRawData jest ustawiony na wartość true).

body?: any

Wartość właściwości

any

command

Bieżące polecenie rejestrowania aktywności. Spowoduje to zastąpienie opcji podstawowej RestClient.

command?: string

Wartość właściwości

string

customHeaders

Zezwala obiektowi wywołującemu na określenie niestandardowych nagłówków żądań.

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

Wartość właściwości

{[headerName: string]: any}

httpResponseType

Typ odpowiedzi http (Accept). Jest to "json" (odpowiada nagłówkowi application/json Accept), chyba że określono inaczej. Inne możliwe wartości to "html", "text", "zip" lub "binary" lub ich odpowiedniki w nagłówku accept (np. application/zip).

httpResponseType?: string

Wartość właściwości

string

isRawData

Jeśli to prawda, oznacza to, że na obiekcie "data" nie powinno być wykonywane żadne przetwarzanie przed wysłaniem go w żądaniu. Jest to rzadko potrzebne. Jednym z takich przypadków jest publikowanie obiektu pliku HTML5.

isRawData?: boolean

Wartość właściwości

boolean

method

Czasownik HTTP (domyślnie GET, jeśli nie zostanie określony)

method?: string

Wartość właściwości

string

queryParams

Parametry zapytania, które mają zostać dodane do adresu URL. W przypadku GET parametry zapytania mogą być dostarczane za pośrednictwem polecenia "data" lub "queryParams". W przypadku innych czasowników, takich jak POST, obiekt danych określa treść POST, więc queryParams jest potrzebny do wskazania parametrów, które należy dodać do ciągu zapytania adresu URL (nie jest uwzględniony w treści postu).

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

Wartość właściwości

{[key: string]: any}

returnRawResponse

Jeśli true, wskazuje, że nieprzetworzona odpowiedź powinna zostać zwrócona w wynikowej obietnicy żądania, a nie deserializacja odpowiedzi (wartość domyślna).

returnRawResponse?: boolean

Wartość właściwości

boolean

routeTemplate

Szablon trasy, który jest używany do tworzenia ścieżki żądania. Jeśli routeTemplate NIE zostanie określony, locationId jest używany do wyszukiwania szablonu za pośrednictwem żądania OPTIONS.

routeTemplate: string

Wartość właściwości

string

routeValues

Słownik wartości zastępczych szablonu trasy

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

Wartość właściwości

{[key: string]: any}