OperationSpec interface
Specifikace, která definuje operaci.
Vlastnosti
base |
Adresa URL, která byla uvedená ve specifikaci služby. Stále bude obsahovat všechny proměnné šablony adresy URL. Pokud se při vytvoření OperationSpec nezadá, vyplní se vlastnost "baseUri" na ServiceClient. |
content |
Typ obsahu textu požadavku. Tato hodnota se použije jako hlavička Content-Type, pokud je zadaná. |
form |
Parametry metody operace, které se použijí k vytvoření těla formdata pro požadavek HTTP operace. |
header |
Parametry metody operace, které budou převedeny na hlavičky požadavku HTTP operace. |
http |
Metoda HTTP, která by měla být používána požadavky pro tuto operaci. |
isXML | Určuje, jestli tato operace používá těla požadavků a odpovědí XML. |
media |
Typ média v textu požadavku. Tato hodnota může být použita k odpočiňování serializace, pokud je poskytnuta. |
path | Pevná cesta pro adresu URL této operace. Stále bude 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é může tato operace vrátit na základě vráceného stavového kódu. |
serializer | Serializátor, který se má použít v této operaci. |
url |
Parametry metody operace, které budou nahrazeny vytvořenou adresou URL. |
Podrobnosti vlastnosti
baseUrl
Adresa URL, která byla uvedená ve specifikaci služby. Stále bude obsahovat všechny proměnné šablony adresy URL. Pokud se při vytvoření OperationSpec nezadá, vyplní se 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 zadaná.
contentType?: string
Hodnota vlastnosti
string
formDataParameters
Parametry metody operace, které se použijí k vytvoření těla formdata pro požadavek HTTP operace.
formDataParameters?: readonly OperationParameter[]
Hodnota vlastnosti
readonly OperationParameter[]
headerParameters
Parametry metody operace, které budou převedeny na hlavičky požadavku HTTP operace.
headerParameters?: readonly OperationParameter[]
Hodnota vlastnosti
readonly OperationParameter[]
httpMethod
Metoda HTTP, která by měla být používána požadavky pro tuto operaci.
httpMethod: HttpMethods
Hodnota vlastnosti
isXML
Určuje, jestli tato operace používá těla požadavků a odpovědí XML.
isXML?: boolean
Hodnota vlastnosti
boolean
mediaType
Typ média v textu požadavku. Tato hodnota může být použita k odpočiňování serializace, pokud je poskytnuta.
mediaType?: string
Hodnota vlastnosti
string
path
Pevná cesta pro adresu URL této operace. Stále bude 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é může tato operace vrátit na základě vráceného stavového kódu.
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 vytvořenou adresou URL.
urlParameters?: readonly OperationURLParameter[]
Hodnota vlastnosti
readonly OperationURLParameter[]