OperationSpec interface
Specifikace, která definuje operaci.
Vlastnosti
base |
Adresa URL, která byla poskytnuta ve specifikaci služby. Bude v něm stále obsahovat všechny proměnné šablony adresy URL. Pokud není k dispozici při vytvoření OperationSpec, pak se naplní vlastností "baseUri" na ServiceClient. |
content |
Typ obsahu textu požadavku. Tato hodnota se použije jako hlavička Content-Type, pokud je zadána. |
form |
Parametry metody operace, která se použije k vytvoření těla formdata pro požadavek HTTP operace. |
header |
Parametry na metodu operace, která se převede na hlavičky požadavku HTTP operace. |
http |
Metoda HTTP, kterou by měly používat požadavky na tuto operaci. |
isXML | Bez ohledu na to, jestli tato operace používá požadavek XML a tělo odpovědi. |
media |
Typ média textu požadavku. Tuto hodnotu lze použít k použití při serializaci, pokud je k dispozici. |
path | Pevná cesta pro adresu URL této operace. Bude v něm stále obsahovat všechny proměnné šablony adresy URL. |
query |
Parametry metody operace, které se přidají do dotazu vytvořené adresy URL. |
request |
Parametr, který se použije k vytvoření textu požadavku HTTP. |
responses | Různé typy odpovědí, které tato operace může vrátit, na základě toho, jaký stavový kód se vrátí. |
serializer | Serializátor, který se má použít v této operaci. |
url |
Parametry metody operace, které budou nahrazeny do vytvořené adresy URL. |
Podrobnosti vlastnosti
baseUrl
Adresa URL, která byla poskytnuta ve specifikaci služby. Bude v něm stále obsahovat všechny proměnné šablony adresy URL. Pokud není k dispozici při vytvoření OperationSpec, pak se naplní vlastností "baseUri" na ServiceClient.
baseUrl?: string
Hodnota vlastnosti
string
contentType
Typ obsahu textu požadavku. Tato hodnota se použije jako hlavička Content-Type, pokud je zadána.
contentType?: string
Hodnota vlastnosti
string
formDataParameters
Parametry metody operace, která se použije k vytvoření těla formdata pro požadavek HTTP operace.
formDataParameters?: readonly OperationParameter[]
Hodnota vlastnosti
readonly OperationParameter[]
headerParameters
Parametry na metodu operace, která se převede na hlavičky požadavku HTTP operace.
headerParameters?: readonly OperationParameter[]
Hodnota vlastnosti
readonly OperationParameter[]
httpMethod
Metoda HTTP, kterou by měly používat požadavky na tuto operaci.
httpMethod: HttpMethods
Hodnota vlastnosti
isXML
Bez ohledu na to, jestli tato operace používá požadavek XML a tělo odpovědi.
isXML?: boolean
Hodnota vlastnosti
boolean
mediaType
Typ média textu požadavku. Tuto hodnotu lze použít k použití při serializaci, pokud je k dispozici.
mediaType?: string
Hodnota vlastnosti
string
path
Pevná cesta pro adresu URL této operace. Bude v něm stále obsahovat všechny proměnné šablony adresy URL.
path?: string
Hodnota vlastnosti
string
queryParameters
Parametry metody operace, které se přidají do dotazu vytvořené adresy URL.
queryParameters?: readonly OperationQueryParameter[]
Hodnota vlastnosti
readonly OperationQueryParameter[]
requestBody
Parametr, který se použije k vytvoření textu požadavku HTTP.
requestBody?: OperationParameter
Hodnota vlastnosti
responses
Různé typy odpovědí, které tato operace může vrátit, na základě toho, jaký stavový kód se vrátí.
responses: {[responseCode: string]: OperationResponseMap}
Hodnota vlastnosti
{[responseCode: string]: OperationResponseMap}
serializer
Serializátor, který se má použít v této operaci.
serializer: Serializer
Hodnota vlastnosti
urlParameters
Parametry metody operace, které budou nahrazeny do vytvořené adresy URL.
urlParameters?: readonly OperationURLParameter[]
Hodnota vlastnosti
readonly OperationURLParameter[]