RestClientRequestParams interface

Pakket:

azure-devops-extension-api

Parameters voor het verzenden van een WebApi-aanvraag

Eigenschappen

apiVersion	De api-versietekenreeks die moet worden verzonden in de aanvraag (bijvoorbeeld '1.0' of '2.0-preview.2')
body	Gegevens die moeten worden geplaatst. In dit geval van een GET geeft dit queryparameters aan. Voor andere aanvragen is dit het object voor de aanvraagbody (dat wordt geserialiseerd in een JSON-tekenreeks, tenzij isRawData is ingesteld op true).
command	Huidige opdracht voor activiteitenlogboekregistratie. Hierdoor wordt de basisoptie van de RestClient overschreven.
customHeaders	Hiermee kan de beller aangepaste aanvraagheaders opgeven.
httpResponseType	Het http-antwoordtype (Accepteren). Dit is 'json' (komt overeen met de header Application/json Accept), tenzij anders is opgegeven. Andere mogelijke waarden zijn 'html', 'text', 'zip' of 'binary' of de bijbehorende accept-header-equivalenten (bijvoorbeeld application/zip).
isRawData	Indien waar, geeft dit aan dat er geen verwerking moet worden uitgevoerd op het object 'gegevens' voordat deze in de aanvraag wordt verzonden. Dit is zelden nodig. Een geval is bij het plaatsen van een HTML5-bestandsobject.
method	HTTP-woord (GET standaard indien niet opgegeven)
queryParams	Queryparameters die moeten worden toegevoegd aan de URL. In het geval van een GET kunnen queryparameters worden opgegeven via 'data' of 'queryParams'. Voor andere werkwoorden, zoals POST, geeft het gegevensobject de POST-hoofdtekst op, dus queryParams is nodig om parameters aan te geven die moeten worden toegevoegd aan de queryreeks van de URL (niet opgenomen in de hoofdtekst van het bericht).
returnRawResponse	Als waar is, geeft u aan dat het onbewerkte antwoord moet worden geretourneerd in de resulterende belofte van de aanvraag in plaats van het antwoord te deserialiseren (de standaardinstelling).
routeTemplate	Routesjabloon die wordt gebruikt om het aanvraagpad te vormen. Als routeTemplate NIET is opgegeven, wordt locationId gebruikt om de sjabloon op te zoeken via een OPTIONS-aanvraag.
routeValues	Woordenlijst met vervangende waarden voor routesjablonen

Eigenschapdetails

apiVersion

De api-versietekenreeks die moet worden verzonden in de aanvraag (bijvoorbeeld '1.0' of '2.0-preview.2')

apiVersion: string

Waarde van eigenschap

string

body

Gegevens die moeten worden geplaatst. In dit geval van een GET geeft dit queryparameters aan. Voor andere aanvragen is dit het object voor de aanvraagbody (dat wordt geserialiseerd in een JSON-tekenreeks, tenzij isRawData is ingesteld op true).

body?: any

Waarde van eigenschap

any

command

Huidige opdracht voor activiteitenlogboekregistratie. Hierdoor wordt de basisoptie van de RestClient overschreven.

command?: string

Waarde van eigenschap

string

customHeaders

Hiermee kan de beller aangepaste aanvraagheaders opgeven.

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

Waarde van eigenschap

{[headerName: string]: any}

httpResponseType

Het http-antwoordtype (Accepteren). Dit is 'json' (komt overeen met de header Application/json Accept), tenzij anders is opgegeven. Andere mogelijke waarden zijn 'html', 'text', 'zip' of 'binary' of de bijbehorende accept-header-equivalenten (bijvoorbeeld application/zip).

httpResponseType?: string

Waarde van eigenschap

string

isRawData

Indien waar, geeft dit aan dat er geen verwerking moet worden uitgevoerd op het object 'gegevens' voordat deze in de aanvraag wordt verzonden. Dit is zelden nodig. Een geval is bij het plaatsen van een HTML5-bestandsobject.

isRawData?: boolean

Waarde van eigenschap

boolean

method

HTTP-woord (GET standaard indien niet opgegeven)

method?: string

Waarde van eigenschap

string

queryParams

Queryparameters die moeten worden toegevoegd aan de URL. In het geval van een GET kunnen queryparameters worden opgegeven via 'data' of 'queryParams'. Voor andere werkwoorden, zoals POST, geeft het gegevensobject de POST-hoofdtekst op, dus queryParams is nodig om parameters aan te geven die moeten worden toegevoegd aan de queryreeks van de URL (niet opgenomen in de hoofdtekst van het bericht).

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

Waarde van eigenschap

{[key: string]: any}

returnRawResponse

Als waar is, geeft u aan dat het onbewerkte antwoord moet worden geretourneerd in de resulterende belofte van de aanvraag in plaats van het antwoord te deserialiseren (de standaardinstelling).

returnRawResponse?: boolean

Waarde van eigenschap

boolean

routeTemplate

Routesjabloon die wordt gebruikt om het aanvraagpad te vormen. Als routeTemplate NIET is opgegeven, wordt locationId gebruikt om de sjabloon op te zoeken via een OPTIONS-aanvraag.

routeTemplate: string

Waarde van eigenschap

string

routeValues

Woordenlijst met vervangende waarden voor routesjablonen

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

Waarde van eigenschap

{[key: string]: any}