RestClientRequestParams interface

Paquet:

azure-devops-extension-api

Paramètres pour l’envoi d’une requête WebApi

Propriétés

apiVersion	Chaîne de version de l’API à envoyer dans la demande (par exemple, « 1.0 » ou « 2.0-preview.2 »)
body	Données à publier. Dans le cas d’un GET, cela indique les paramètres de la requête. Pour les autres requêtes, il s’agit de l’objet corps de la requête (qui sera sérialisé dans une chaîne JSON, sauf si isRawData est défini sur true).
command	Commande actuelle pour la journalisation des activités. Cela remplacera l’option de base de RestClient.
customHeaders	Permet à l’appelant de spécifier des en-têtes de demande personnalisés.
httpResponseType	Type de réponse http (Accept). Il s’agit de « json » (correspond à l’en-tête application/json Accept), sauf indication contraire. D’autres valeurs possibles sont « html », « text », « zip » ou « binary » ou leurs équivalents d’en-tête accept (par exemple application/zip).
isRawData	Si la valeur est true, cela indique qu’aucun traitement ne doit être effectué sur l’objet 'data' avant qu’il ne soit envoyé dans la demande. C’est rarement nécessaire. C’est le cas lors de la publication d’un objet Fichier HTML5.
method	Verbe HTTP (GET par défaut s’il n’est pas spécifié)
queryParams	Paramètres de requête à ajouter à l’url. Dans le cas d’un GET, les paramètres de requête peuvent être fournis via 'data' ou 'queryParams'. Pour d’autres verbes tels que POST, l’objet data spécifie le corps POST, donc queryParams est nécessaire pour indiquer les paramètres à ajouter à la chaîne de requête de l’url (non incluse dans le corps de l’article).
returnRawResponse	Si true, indique que la réponse brute doit être renvoyée dans la promesse résultante de la requête plutôt que de désérialiser la réponse (valeur par défaut).
routeTemplate	Modèle de route utilisé pour former le chemin d’accès à la demande. Si routeTemplate n’est PAS spécifié, locationId est utilisé pour rechercher le modèle via une requête OPTIONS.
routeValues	Dictionnaire des valeurs de remplacement des modèles d’itinéraire

Détails de la propriété

apiVersion

Chaîne de version de l’API à envoyer dans la demande (par exemple, « 1.0 » ou « 2.0-preview.2 »)

apiVersion: string

Valeur de propriété

string

body

Données à publier. Dans le cas d’un GET, cela indique les paramètres de la requête. Pour les autres requêtes, il s’agit de l’objet corps de la requête (qui sera sérialisé dans une chaîne JSON, sauf si isRawData est défini sur true).

body?: any

Valeur de propriété

any

command

Commande actuelle pour la journalisation des activités. Cela remplacera l’option de base de RestClient.

command?: string

Valeur de propriété

string

customHeaders

Permet à l’appelant de spécifier des en-têtes de demande personnalisés.

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

Valeur de propriété

{[headerName: string]: any}

httpResponseType

Type de réponse http (Accept). Il s’agit de « json » (correspond à l’en-tête application/json Accept), sauf indication contraire. D’autres valeurs possibles sont « html », « text », « zip » ou « binary » ou leurs équivalents d’en-tête accept (par exemple application/zip).

httpResponseType?: string

Valeur de propriété

string

isRawData

Si la valeur est true, cela indique qu’aucun traitement ne doit être effectué sur l’objet 'data' avant qu’il ne soit envoyé dans la demande. C’est rarement nécessaire. C’est le cas lors de la publication d’un objet Fichier HTML5.

isRawData?: boolean

Valeur de propriété

boolean

method

Verbe HTTP (GET par défaut s’il n’est pas spécifié)

method?: string

Valeur de propriété

string

queryParams

Paramètres de requête à ajouter à l’url. Dans le cas d’un GET, les paramètres de requête peuvent être fournis via 'data' ou 'queryParams'. Pour d’autres verbes tels que POST, l’objet data spécifie le corps POST, donc queryParams est nécessaire pour indiquer les paramètres à ajouter à la chaîne de requête de l’url (non incluse dans le corps de l’article).

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

Valeur de propriété

{[key: string]: any}

returnRawResponse

Si true, indique que la réponse brute doit être renvoyée dans la promesse résultante de la requête plutôt que de désérialiser la réponse (valeur par défaut).

returnRawResponse?: boolean

Valeur de propriété

boolean

routeTemplate

Modèle de route utilisé pour former le chemin d’accès à la demande. Si routeTemplate n’est PAS spécifié, locationId est utilisé pour rechercher le modèle via une requête OPTIONS.

routeTemplate: string

Valeur de propriété

string

routeValues

Dictionnaire des valeurs de remplacement des modèles d’itinéraire

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

Valeur de propriété

{[key: string]: any}