RestClientRequestParams interface

Пакет:

azure-devops-extension-api

Параметры для отправки запроса WebApi

Свойства

apiVersion	Строка версии api для отправки в запросе (например, "1.0" или "2.0-preview.2")
body	Данные для публикации. В данном случае GET это указывает на параметры запроса. Для других запросов это объект тела запроса (который будет сериализован в строку JSON, если isRawData не установлен в true).
command	Текущая команда для ведения журнала активности. Это переопределит базовый параметр RestClient.
customHeaders	Позволяет вызывающему абоненту указывать пользовательские заголовки запросов.
httpResponseType	Тип ответа http (Accept). Это "json" (соответствует заголовку application/json Accept), если не указано иное. Другими возможными значениями являются "html", "text", "zip" или "binary" или их эквиваленты в заголовках accept (например, application/zip).
isRawData	Если значение true, это указывает на то, что не следует выполнять обработку объекта data до его отправки в запросе. Это редко нужно. Один из случаев — это публикация объекта HTML5 File.
method	HTTP глагол (по умолчанию GET, если не указан)
queryParams	Запрашивайте параметры для добавления в url. В случае GET параметры запроса могут быть предоставлены через 'data' или 'queryParams'. Для других команд, таких как POST, объект данных указывает тело POST, поэтому queryParams необходим для указания параметров, которые следует добавить в строку запроса URL-адреса (не включенного в тело POST).
returnRawResponse	Если true, указывает, что необработанный ответ должен быть возвращен в результирующем обещании запроса, а не десериализовать ответ (по умолчанию).
routeTemplate	Шаблон маршрута, который используется для формирования пути запроса. Если routeTemplate НЕ указан, то locationId используется для поиска шаблона с помощью запроса OPTIONS.
routeValues	Словарь значений замены шаблона маршрута

Сведения о свойстве

apiVersion

Строка версии api для отправки в запросе (например, "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 (Accept). Это "json" (соответствует заголовку application/json Accept), если не указано иное. Другими возможными значениями являются "html", "text", "zip" или "binary" или их эквиваленты в заголовках accept (например, application/zip).

httpResponseType?: string

Значение свойства

string

isRawData

Если значение true, это указывает на то, что не следует выполнять обработку объекта data до его отправки в запросе. Это редко нужно. Один из случаев — это публикация объекта HTML5 File.

isRawData?: boolean

Значение свойства

boolean

method

HTTP глагол (по умолчанию GET, если не указан)

method?: string

Значение свойства

string

queryParams

Запрашивайте параметры для добавления в url. В случае GET параметры запроса могут быть предоставлены через 'data' или 'queryParams'. Для других команд, таких как POST, объект данных указывает тело POST, поэтому queryParams необходим для указания параметров, которые следует добавить в строку запроса URL-адреса (не включенного в тело POST).

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}