RestClientRequestParams interface

Paket:

azure-devops-extension-api

Parameter untuk mengirim permintaan WebApi

Properti

apiVersion	String versi api yang akan dikirim dalam permintaan (misalnya "1.0" atau "2.0-preview.2")
body	Data untuk diposting. Dalam kasus GET ini, ini menunjukkan parameter kueri. Untuk permintaan lain, ini adalah objek isi permintaan (yang akan diserialkan menjadi string JSON kecuali isRawData diatur ke true).
command	Perintah saat ini untuk pengelogan aktivitas. Ini akan mengganti opsi dasar RestClient.
customHeaders	Mengizinkan pemanggil untuk menentukan header permintaan kustom.
httpResponseType	Jenis respons http (Terima). Ini adalah "json" (sesuai dengan header Accept application/json) kecuali ditentukan lain. Nilai lain yang mungkin adalah "html", "text", "zip", atau "binary" atau setara header penerimaan mereka (misalnya application/zip).
isRawData	Jika benar, ini menunjukkan bahwa tidak ada pemrosesan yang harus dilakukan pada objek 'data' sebelum dikirim dalam permintaan. Ini jarang diperlukan. Salah satu kasusnya adalah saat memposting objek File HTML5.
method	Kata kerja HTTP (GET secara default jika tidak ditentukan)
queryParams	Parameter kueri untuk ditambahkan ke url. Dalam kasus GET, parameter kueri dapat disediakan melalui 'data' atau 'queryParams'. Untuk kata kerja lain seperti POST, objek data menentukan isi POST, jadi queryParams diperlukan untuk menunjukkan parameter yang akan ditambahkan ke string kueri url (tidak disertakan dalam isi posting).
returnRawResponse	Jika true, menunjukkan bahwa Respons mentah harus dikembalikan dalam janji yang dihasilkan permintaan daripada mendeserialisasi respons (default).
routeTemplate	Templat rute yang digunakan untuk membentuk jalur permintaan. Jika routeTemplate TIDAK ditentukan, maka locationId digunakan untuk mencari templat melalui permintaan OPTIONS.
routeValues	Kamus nilai penggantian templat rute

Detail Properti

apiVersion

String versi api yang akan dikirim dalam permintaan (misalnya "1.0" atau "2.0-preview.2")

apiVersion: string

Nilai Properti

string

body

Data untuk diposting. Dalam kasus GET ini, ini menunjukkan parameter kueri. Untuk permintaan lain, ini adalah objek isi permintaan (yang akan diserialkan menjadi string JSON kecuali isRawData diatur ke true).

body?: any

Nilai Properti

any

command

Perintah saat ini untuk pengelogan aktivitas. Ini akan mengganti opsi dasar RestClient.

command?: string

Nilai Properti

string

customHeaders

Mengizinkan pemanggil untuk menentukan header permintaan kustom.

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

Nilai Properti

{[headerName: string]: any}

httpResponseType

Jenis respons http (Terima). Ini adalah "json" (sesuai dengan header Accept application/json) kecuali ditentukan lain. Nilai lain yang mungkin adalah "html", "text", "zip", atau "binary" atau setara header penerimaan mereka (misalnya application/zip).

httpResponseType?: string

Nilai Properti

string

isRawData

Jika benar, ini menunjukkan bahwa tidak ada pemrosesan yang harus dilakukan pada objek 'data' sebelum dikirim dalam permintaan. Ini jarang diperlukan. Salah satu kasusnya adalah saat memposting objek File HTML5.

isRawData?: boolean

Nilai Properti

boolean

method

Kata kerja HTTP (GET secara default jika tidak ditentukan)

method?: string

Nilai Properti

string

queryParams

Parameter kueri untuk ditambahkan ke url. Dalam kasus GET, parameter kueri dapat disediakan melalui 'data' atau 'queryParams'. Untuk kata kerja lain seperti POST, objek data menentukan isi POST, jadi queryParams diperlukan untuk menunjukkan parameter yang akan ditambahkan ke string kueri url (tidak disertakan dalam isi posting).

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

Nilai Properti

{[key: string]: any}

returnRawResponse

Jika true, menunjukkan bahwa Respons mentah harus dikembalikan dalam janji yang dihasilkan permintaan daripada mendeserialisasi respons (default).

returnRawResponse?: boolean

Nilai Properti

boolean

routeTemplate

Templat rute yang digunakan untuk membentuk jalur permintaan. Jika routeTemplate TIDAK ditentukan, maka locationId digunakan untuk mencari templat melalui permintaan OPTIONS.

routeTemplate: string

Nilai Properti

string

routeValues

Kamus nilai penggantian templat rute

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

Nilai Properti

{[key: string]: any}