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 응답(수락) 형식입니다. 달리 지정하지 않는 한 "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 본문을 지정하므로 url의 쿼리 문자열에 추가할 매개 변수를 나타내려면 queryParams가 필요합니다(포스트 본문에 포함되지 않음).
returnRawResponse	true이면 응답(기본값)을 역직렬화하는 대신 요청의 결과 약속에 원시 응답이 반환되어야 함을 나타냅니다.
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 응답(수락) 형식입니다. 달리 지정하지 않는 한 "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 본문을 지정하므로 url의 쿼리 문자열에 추가할 매개 변수를 나타내려면 queryParams가 필요합니다(포스트 본문에 포함되지 않음).

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}