OperationSpec interface
Specifica che definisce un'operazione.
Proprietà
base |
URL fornito nella specifica del servizio. Questa operazione includerà comunque tutte le variabili del modello di URL. Se non viene specificato quando viene creato OperationSpec, verrà popolato da una proprietà "baseUri" in ServiceClient. |
content |
Tipo di contenuto del corpo della richiesta. Questo valore verrà usato come intestazione "Content-Type" se specificato. |
form |
Parametri per il metodo dell'operazione che verrà usato per creare un corpo formdata per la richiesta HTTP dell'operazione. |
header |
Parametri del metodo dell'operazione che verranno convertiti in intestazioni nella richiesta HTTP dell'operazione. |
http |
Metodo HTTP che deve essere utilizzato dalle richieste per questa operazione. |
isXML | Indica se questa operazione utilizza o meno corpi di richiesta e risposta XML. |
media |
Tipo di supporto del corpo della richiesta. Questo valore può essere usato per facilitare la serializzazione, se specificato. |
path | Percorso fisso per l'URL di questa operazione. Questa operazione includerà comunque tutte le variabili del modello di URL. |
query |
Parametri al metodo dell'operazione che verrà aggiunto alla query dell'URL costruito. |
request |
Parametro che verrà usato per costruire il corpo della richiesta HTTP. |
responses | I diversi tipi di risposte che questa operazione può restituire in base al codice di stato restituito. |
serializer | Serializzatore da utilizzare in questa operazione. |
url |
Parametri del metodo dell'operazione che verranno sostituiti nell'URL costruito. |
Dettagli proprietà
baseUrl
URL fornito nella specifica del servizio. Questa operazione includerà comunque tutte le variabili del modello di URL. Se non viene specificato quando viene creato OperationSpec, verrà popolato da una proprietà "baseUri" in ServiceClient.
baseUrl?: string
Valore della proprietà
string
contentType
Tipo di contenuto del corpo della richiesta. Questo valore verrà usato come intestazione "Content-Type" se specificato.
contentType?: string
Valore della proprietà
string
formDataParameters
Parametri per il metodo dell'operazione che verrà usato per creare un corpo formdata per la richiesta HTTP dell'operazione.
formDataParameters?: readonly OperationParameter[]
Valore della proprietà
readonly OperationParameter[]
headerParameters
Parametri del metodo dell'operazione che verranno convertiti in intestazioni nella richiesta HTTP dell'operazione.
headerParameters?: readonly OperationParameter[]
Valore della proprietà
readonly OperationParameter[]
httpMethod
Metodo HTTP che deve essere utilizzato dalle richieste per questa operazione.
httpMethod: HttpMethods
Valore della proprietà
isXML
Indica se questa operazione utilizza o meno corpi di richiesta e risposta XML.
isXML?: boolean
Valore della proprietà
boolean
mediaType
Tipo di supporto del corpo della richiesta. Questo valore può essere usato per facilitare la serializzazione, se specificato.
mediaType?: string
Valore della proprietà
string
path
Percorso fisso per l'URL di questa operazione. Questa operazione includerà comunque tutte le variabili del modello di URL.
path?: string
Valore della proprietà
string
queryParameters
Parametri al metodo dell'operazione che verrà aggiunto alla query dell'URL costruito.
queryParameters?: readonly OperationQueryParameter[]
Valore della proprietà
readonly OperationQueryParameter[]
requestBody
Parametro che verrà usato per costruire il corpo della richiesta HTTP.
requestBody?: OperationParameter
Valore della proprietà
responses
I diversi tipi di risposte che questa operazione può restituire in base al codice di stato restituito.
responses: {[responseCode: string]: OperationResponseMap}
Valore della proprietà
{[responseCode: string]: OperationResponseMap}
serializer
Serializzatore da utilizzare in questa operazione.
serializer: Serializer
Valore della proprietà
urlParameters
Parametri del metodo dell'operazione che verranno sostituiti nell'URL costruito.
urlParameters?: readonly OperationURLParameter[]
Valore della proprietà
readonly OperationURLParameter[]