通过

RestClientRequestParams interface

包:
azure-devops-extension-api

用于发送 WebApi 请求的参数

属性

apiVersion

要在请求中发送的 API 版本字符串（例如“1.0”或“2.0-preview.2”）
body

要发布的数据。 在本例中，这是 GET 的，这表示查询参数。 对于其他请求，这是请求正文对象（除非 isRawData 设置为 true，否则将序列化为 JSON 字符串）。
command

用于活动日志记录的当前命令。 这将覆盖 RestClient 的基本选项。
customHeaders

允许调用方指定自定义请求标头。
httpResponseType

http 响应 （Accept） 类型。 除非另有说明，否则这是“json”（对应于 application/json Accept 标头）。 其他可能的值是 “html”、“text”、“zip” 或 “binary” 或它们接受的标头等效项（例如 application/zip）。
isRawData

如果为 true，则表示在请求中发送“data”对象之前不应对其进行任何处理。 这很少需要。 一种情况是发布 HTML5 文件对象时。
method

HTTP 动词（如果未指定，则默认为 GET）
queryParams

要添加到 url 的查询参数。 在 GET 的情况下，可以通过 'data' 或 'queryParams' 提供查询参数。 对于其他动词（如 POST），数据对象指定 POST 正文，因此需要 queryParams 来指示要添加到 url 的查询字符串中的参数（不包含在 post 正文中）。
returnRawResponse

如果为 true，则表示应在请求的结果 Promise 中返回原始 Response，而不是反序列化响应（默认值）。
routeTemplate

用于形成请求路径的路由模板。 如果未指定 routeTemplate，则使用 locationId 通过 OPTIONS 请求查找模板。
routeValues

路由模板替换值字典

属性详细信息

apiVersion

要在请求中发送的 API 版本字符串（例如“1.0”或“2.0-preview.2”）

apiVersion: string

属性值

string

body

要发布的数据。 在本例中，这是 GET 的，这表示查询参数。 对于其他请求，这是请求正文对象（除非 isRawData 设置为 true，否则将序列化为 JSON 字符串）。

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” 或它们接受的标头等效项（例如 application/zip）。

httpResponseType?: string

属性值

string

isRawData

如果为 true，则表示在请求中发送“data”对象之前不应对其进行任何处理。 这很少需要。 一种情况是发布 HTML5 文件对象时。

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，则表示应在请求的结果 Promise 中返回原始 Response，而不是反序列化响应（默认值）。

returnRawResponse?: boolean

属性值

boolean

routeTemplate

用于形成请求路径的路由模板。 如果未指定 routeTemplate，则使用 locationId 通过 OPTIONS 请求查找模板。

routeTemplate: string

属性值

string

routeValues

路由模板替换值字典

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

属性值

{[key: string]: any}