OperationContractProperties interface
Eigenschappen van bewerkingscontract
- Uitbreiding
Eigenschappen
display |
Bewerkingsnaam. |
method | Een geldige HTTP-bewerkingsmethode. Typische HTTP-methoden zoals GET, PUT, POST, maar niet beperkt door alleen deze methoden. |
url |
Relatieve URL-sjabloon die de doelresource voor deze bewerking identificeert. Kan parameters bevatten. Voorbeeld: /customers/{cid}/orders/{oid}/?date={date} |
Overgenomen eigenschappen
description | Beschrijving van de bewerking. Kan HTML-opmaaktags bevatten. |
policies | Bewerkingsbeleid |
request | Een entiteit met aanvraaggegevens. |
responses | Matrix met bewerkingsantwoorden. |
template |
Verzameling van URL-sjabloonparameters. |
Eigenschapdetails
displayName
Bewerkingsnaam.
displayName: string
Waarde van eigenschap
string
method
Een geldige HTTP-bewerkingsmethode. Typische HTTP-methoden zoals GET, PUT, POST, maar niet beperkt door alleen deze methoden.
method: string
Waarde van eigenschap
string
urlTemplate
Relatieve URL-sjabloon die de doelresource voor deze bewerking identificeert. Kan parameters bevatten. Voorbeeld: /customers/{cid}/orders/{oid}/?date={date}
urlTemplate: string
Waarde van eigenschap
string
Details van overgenomen eigenschap
description
Beschrijving van de bewerking. Kan HTML-opmaaktags bevatten.
description?: string
Waarde van eigenschap
string
Overgenomen vanOperationEntityBaseContract.description
policies
Bewerkingsbeleid
policies?: string
Waarde van eigenschap
string
Overgenomen vanOperationEntityBaseContract.policies
request
Een entiteit met aanvraaggegevens.
request?: RequestContract
Waarde van eigenschap
Overgenomen vanOperationEntityBaseContract.request
responses
Matrix met bewerkingsantwoorden.
responses?: ResponseContract[]
Waarde van eigenschap
Overgenomen vanOperationEntityBaseContract.responses
templateParameters
Verzameling van URL-sjabloonparameters.
templateParameters?: ParameterContract[]
Waarde van eigenschap
Overgenomen vanOperationEntityBaseContract.templateParameters