RestClientRequestParams interface

Paket:

azure-devops-extension-api

WebApi isteği gönderme parametreleri

Özellikler

apiVersion	İstekte gönderilecek API sürüm dizesi (örn. "1.0" veya "2.0-preview.2")
body	Gönderilecek veriler. Bu get durumunda sorgu parametrelerini gösterir. Diğer istekler için bu istek gövdesi nesnesidir (isRawData true olarak ayarlanmadığı sürece JSON dizesi olarak serileştirilir).
command	Etkinlik günlüğü için geçerli komut. Bu, RestClient'ın temel seçeneğini geçersiz kılar.
customHeaders	Çağıranın özel istek üst bilgilerini belirtmesine izin verir.
httpResponseType	Http yanıtı (Kabul Et) türü. Aksi belirtilmedikçe bu "json" (application/json Accept üst bilgisine karşılık gelir) şeklindedir. Diğer olası değerler "html", "text", "zip" veya "binary" değerleri ya da kabul üst bilgisi eşdeğerleridir (örneğin, application/zip).
isRawData	True ise, istekte gönderilmeden önce 'data' nesnesinde işlem yapılmaması gerektiğini gösterir. Bu,nadiren gereklidir. Bir durum bir HTML5 Dosyası nesnesi gönderildiğinde olur.
method	HTTP fiili (belirtilmezse varsayılan olarak GET)
queryParams	URL'ye eklenecek sorgu parametreleri. GET söz konusu olduğunda sorgu parametreleri 'data' veya 'queryParams' aracılığıyla sağlanabilir. POST gibi diğer fiiller için, veri nesnesi POST gövdesini belirtir, bu nedenle url'nin sorgu dizesine eklenecek parametreleri belirtmek için queryParams gereklidir (post gövdesine dahil değildir).
returnRawResponse	True ise, ham Yanıtın yanıtın seri durumdan çıkarılması yerine isteğin sonuçta elde edilen sözlerinde döndürülmesi gerektiğini gösterir (varsayılan).
routeTemplate	İstek yolunu oluşturmak için kullanılan yol şablonu. routeTemplate belirtilmezse, bir OPTIONS isteği aracılığıyla şablonu aramak için locationId kullanılır.
routeValues	Rota şablonu değiştirme değerlerinin sözlüğü

Özellik Ayrıntıları

apiVersion

İstekte gönderilecek API sürüm dizesi (örn. "1.0" veya "2.0-preview.2")

apiVersion: string

Özellik Değeri

string

body

Gönderilecek veriler. Bu get durumunda sorgu parametrelerini gösterir. Diğer istekler için bu istek gövdesi nesnesidir (isRawData true olarak ayarlanmadığı sürece JSON dizesi olarak serileştirilir).

body?: any

Özellik Değeri

any

command

Etkinlik günlüğü için geçerli komut. Bu, RestClient'ın temel seçeneğini geçersiz kılar.

command?: string

Özellik Değeri

string

customHeaders

Çağıranın özel istek üst bilgilerini belirtmesine izin verir.

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

Özellik Değeri

{[headerName: string]: any}

httpResponseType

Http yanıtı (Kabul Et) türü. Aksi belirtilmedikçe bu "json" (application/json Accept üst bilgisine karşılık gelir) şeklindedir. Diğer olası değerler "html", "text", "zip" veya "binary" değerleri ya da kabul üst bilgisi eşdeğerleridir (örneğin, application/zip).

httpResponseType?: string

Özellik Değeri

string

isRawData

True ise, istekte gönderilmeden önce 'data' nesnesinde işlem yapılmaması gerektiğini gösterir. Bu,nadiren gereklidir. Bir durum bir HTML5 Dosyası nesnesi gönderildiğinde olur.

isRawData?: boolean

Özellik Değeri

boolean

method

HTTP fiili (belirtilmezse varsayılan olarak GET)

method?: string

Özellik Değeri

string

queryParams

URL'ye eklenecek sorgu parametreleri. GET söz konusu olduğunda sorgu parametreleri 'data' veya 'queryParams' aracılığıyla sağlanabilir. POST gibi diğer fiiller için, veri nesnesi POST gövdesini belirtir, bu nedenle url'nin sorgu dizesine eklenecek parametreleri belirtmek için queryParams gereklidir (post gövdesine dahil değildir).

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

Özellik Değeri

{[key: string]: any}

returnRawResponse

True ise, ham Yanıtın yanıtın seri durumdan çıkarılması yerine isteğin sonuçta elde edilen sözlerinde döndürülmesi gerektiğini gösterir (varsayılan).

returnRawResponse?: boolean

Özellik Değeri

boolean

routeTemplate

İstek yolunu oluşturmak için kullanılan yol şablonu. routeTemplate belirtilmezse, bir OPTIONS isteği aracılığıyla şablonu aramak için locationId kullanılır.

routeTemplate: string

Özellik Değeri

string

routeValues

Rota şablonu değiştirme değerlerinin sözlüğü

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

Özellik Değeri

{[key: string]: any}