OperationUpdateContract interface
Details zum API-Vorgangsaktualisierungsvertrag.
Eigenschaften
| description | Beschreibung des Vorgangs. Kann HTML-Formatierungstags enthalten. |
| display |
Vorgangsname. |
| method | Eine gültige HTTP-Vorgangsmethode. Typische HTTP-Methoden wie GET, PUT, POST, aber nicht nur durch sie beschränkt. |
| policies | Vorgangsrichtlinien |
| request | Eine Entität, die Anforderungsdetails enthält. |
| responses | Array von Vorgangsantworten. |
| template |
Sammlung von URL-Vorlagenparametern. |
| url |
Relative URL-Vorlage, die die Zielressource für diesen Vorgang identifiziert. Kann Parameter enthalten. Beispiel: /customers/{cid}/orders/{oid}/?date={date} |
Details zur Eigenschaft
description
Beschreibung des Vorgangs. Kann HTML-Formatierungstags enthalten.
description?: string
Eigenschaftswert
string
displayName
Vorgangsname.
displayName?: string
Eigenschaftswert
string
method
Eine gültige HTTP-Vorgangsmethode. Typische HTTP-Methoden wie GET, PUT, POST, aber nicht nur durch sie beschränkt.
method?: string
Eigenschaftswert
string
policies
Vorgangsrichtlinien
policies?: string
Eigenschaftswert
string
request
Eine Entität, die Anforderungsdetails enthält.
request?: RequestContract
Eigenschaftswert
responses
templateParameters
Sammlung von URL-Vorlagenparametern.
templateParameters?: ParameterContract[]
Eigenschaftswert
urlTemplate
Relative URL-Vorlage, die die Zielressource für diesen Vorgang identifiziert. Kann Parameter enthalten. Beispiel: /customers/{cid}/orders/{oid}/?date={date}
urlTemplate?: string
Eigenschaftswert
string