RestClientRequestParams interface

الحزمة:

azure-devops-extension-api

معلمات إرسال طلب WebApi

الخصائص

apiVersion	سلسلة إصدار واجهة برمجة التطبيقات المراد إرسالها في الطلب (على سبيل المثال، "1.0" أو "2.0-preview.2")
body	البيانات المراد نشرها. في هذه الحالة من GET، يشير هذا إلى معلمات الاستعلام. بالنسبة للطلبات الأخرى، هذا هو كائن نص الطلب (الذي سيتم تسلسله في سلسلة JSON ما لم يتم تعيين isRawData إلى true).
command	الأمر الحالي لتسجيل النشاط. سيؤدي هذا إلى تجاوز الخيار الأساسي ل RestClient.
customHeaders	يسمح للمتصل بتحديد رؤوس الطلبات المخصصة.
httpResponseType	نوع استجابة http (قبول). هذا هو "json" (يتوافق مع رأس قبول التطبيق/json) ما لم ينص على خلاف ذلك. القيم المحتملة الأخرى هي "html" أو "text" أو "zip" أو "binary" أو ما يعادلها في رأس القبول (مثل application/zip).
isRawData	إذا كان هذا صحيحا، فهذا يشير إلى أنه لا ينبغي إجراء أي معالجة على كائن "البيانات" قبل إرساله في الطلب. نادرا ما تكون هناك حاجة إلى ذلك. إحدى الحالات هي عند نشر كائن ملف HTML5.
method	فعل HTTP (GET افتراضيا إذا لم يتم تحديده)
queryParams	معلمات الاستعلام لإضافتها إلى عنوان url. في حالة GET ، يمكن توفير معلمات الاستعلام عبر "data" أو "queryParams". بالنسبة للأفعال الأخرى مثل POST ، يحدد كائن البيانات نص POST ، لذلك هناك حاجة إلى queryParams للإشارة إلى المعلمات لإضافتها إلى سلسلة الاستعلام الخاصة بعنوان url (غير مضمنة في نص المنشور).
returnRawResponse	إذا كان true، فيشير إلى أنه يجب إرجاع الاستجابة الأولية في الوعد الناتج للطلب بدلا من إلغاء تسلسل الاستجابة (الافتراضي).
routeTemplate	قالب المسار المستخدم لتشكيل مسار الطلب. إذا لم يتم تحديد routeTemplate، استخدام locationId للبحث عن القالب عبر طلب OPTIONS.
routeValues	قاموس قيم استبدال قالب المسار

تفاصيل الخاصية

apiVersion

سلسلة إصدار واجهة برمجة التطبيقات المراد إرسالها في الطلب (على سبيل المثال، "1.0" أو "2.0-preview.2")

apiVersion: string

قيمة الخاصية

string

body

البيانات المراد نشرها. في هذه الحالة من GET، يشير هذا إلى معلمات الاستعلام. بالنسبة للطلبات الأخرى، هذا هو كائن نص الطلب (الذي سيتم تسلسله في سلسلة JSON ما لم يتم تعيين isRawData إلى true).

body?: any

قيمة الخاصية

any

command

الأمر الحالي لتسجيل النشاط. سيؤدي هذا إلى تجاوز الخيار الأساسي ل RestClient.

command?: string

قيمة الخاصية

string

customHeaders

يسمح للمتصل بتحديد رؤوس الطلبات المخصصة.

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

قيمة الخاصية

{[headerName: string]: any}

httpResponseType

نوع استجابة http (قبول). هذا هو "json" (يتوافق مع رأس قبول التطبيق/json) ما لم ينص على خلاف ذلك. القيم المحتملة الأخرى هي "html" أو "text" أو "zip" أو "binary" أو ما يعادلها في رأس القبول (مثل application/zip).

httpResponseType?: string

قيمة الخاصية

string

isRawData

إذا كان هذا صحيحا، فهذا يشير إلى أنه لا ينبغي إجراء أي معالجة على كائن "البيانات" قبل إرساله في الطلب. نادرا ما تكون هناك حاجة إلى ذلك. إحدى الحالات هي عند نشر كائن ملف HTML5.

isRawData?: boolean

قيمة الخاصية

boolean

method

فعل HTTP (GET افتراضيا إذا لم يتم تحديده)

method?: string

قيمة الخاصية

string

queryParams

معلمات الاستعلام لإضافتها إلى عنوان url. في حالة GET ، يمكن توفير معلمات الاستعلام عبر "data" أو "queryParams". بالنسبة للأفعال الأخرى مثل POST ، يحدد كائن البيانات نص POST ، لذلك هناك حاجة إلى queryParams للإشارة إلى المعلمات لإضافتها إلى سلسلة الاستعلام الخاصة بعنوان url (غير مضمنة في نص المنشور).

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

قيمة الخاصية

{[key: string]: any}

returnRawResponse

إذا كان true، فيشير إلى أنه يجب إرجاع الاستجابة الأولية في الوعد الناتج للطلب بدلا من إلغاء تسلسل الاستجابة (الافتراضي).

returnRawResponse?: boolean

قيمة الخاصية

boolean

routeTemplate

قالب المسار المستخدم لتشكيل مسار الطلب. إذا لم يتم تحديد routeTemplate، استخدام locationId للبحث عن القالب عبر طلب OPTIONS.

routeTemplate: string

قيمة الخاصية

string

routeValues

قاموس قيم استبدال قالب المسار

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

قيمة الخاصية

{[key: string]: any}