WebHookActivity interface
WebHook-Aktivität.
- Extends
Eigenschaften
| authentication | Authentifizierungsmethode, die für den Aufruf des Endpunkts verwendet wird. |
| body | Stellt die Nutzlast dar, die an den Endpunkt gesendet wird. Erforderlich für POST/PUT-Methode, nicht zulässig für GET-Methodentyp: Zeichenfolge (oder Ausdruck mit resultType-Zeichenfolge). |
| headers | Stellt die Kopfzeilen dar, die an die Anforderung gesendet werden. Um beispielsweise die Sprache und den Typ für eine Anforderung festzulegen: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Typ: Zeichenfolge (oder Ausdruck mit resultType-Zeichenfolge). |
| method | Rest-API-Methode für den Zielendpunkt. |
| policy | Aktivitätsrichtlinie. |
| report |
Bei Festlegung auf "true", "statusCode", "Output" und "error" im Anforderungstext des Rückrufs wird die Aktivität verwendet. Die Aktivität kann durch Festlegen von statusCode >= 400 in der Rückrufanforderung als fehlgeschlagen gekennzeichnet werden. Der Standardwert ist "false". Typ: boolean (oder Ausdruck mit resultType boolean). |
| timeout | Das Timeout, in dem der Webhook zurück aufgerufen werden soll. Wenn kein Wert angegeben ist, wird der Standardwert auf 10 Minuten festgelegt. Typ: Zeichenfolge. Muster: ((\d+).)? (\d\d):(60|( [0-5][0-9])):(60|( [0-5][0-9])). |
| type | Polymorphe Diskriminator, der die verschiedenen Typen angibt, die dieses Objekt sein kann |
| url | Zielendpunkt und Pfad der WebHook-Aktivität. Typ: Zeichenfolge (oder Ausdruck mit resultType-Zeichenfolge). |
Geerbte Eigenschaften
| depends |
Aktivität hängt von der Bedingung ab. |
| description | Aktivitätsbeschreibung. |
| name | Aktivitätsname. |
| on |
Statusergebnis der Aktivität, wenn der Zustand auf "Inaktiv" festgelegt ist. Dies ist eine optionale Eigenschaft und wird nicht angegeben, wenn die Aktivität inaktiv ist, wird der Status standardmäßig erfolgreich sein. |
| state | Aktivitätsstatus. Dies ist eine optionale Eigenschaft, und wenn nicht angegeben, ist der Zustand standardmäßig aktiv. |
| user |
Aktivitätsbenutzereigenschaften. |
Details zur Eigenschaft
authentication
Authentifizierungsmethode, die für den Aufruf des Endpunkts verwendet wird.
authentication?: WebActivityAuthentication
Eigenschaftswert
body
Stellt die Nutzlast dar, die an den Endpunkt gesendet wird. Erforderlich für POST/PUT-Methode, nicht zulässig für GET-Methodentyp: Zeichenfolge (oder Ausdruck mit resultType-Zeichenfolge).
body?: any
Eigenschaftswert
any
headers
Stellt die Kopfzeilen dar, die an die Anforderung gesendet werden. Um beispielsweise die Sprache und den Typ für eine Anforderung festzulegen: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Typ: Zeichenfolge (oder Ausdruck mit resultType-Zeichenfolge).
headers?: {[propertyName: string]: any}
Eigenschaftswert
{[propertyName: string]: any}
method
Rest-API-Methode für den Zielendpunkt.
method: string
Eigenschaftswert
string
policy
reportStatusOnCallBack
Bei Festlegung auf "true", "statusCode", "Output" und "error" im Anforderungstext des Rückrufs wird die Aktivität verwendet. Die Aktivität kann durch Festlegen von statusCode >= 400 in der Rückrufanforderung als fehlgeschlagen gekennzeichnet werden. Der Standardwert ist "false". Typ: boolean (oder Ausdruck mit resultType boolean).
reportStatusOnCallBack?: any
Eigenschaftswert
any
timeout
Das Timeout, in dem der Webhook zurück aufgerufen werden soll. Wenn kein Wert angegeben ist, wird der Standardwert auf 10 Minuten festgelegt. Typ: Zeichenfolge. Muster: ((\d+).)? (\d\d):(60|( [0-5][0-9])):(60|( [0-5][0-9])).
timeout?: string
Eigenschaftswert
string
type
Polymorphe Diskriminator, der die verschiedenen Typen angibt, die dieses Objekt sein kann
type: "WebHook"
Eigenschaftswert
"WebHook"
url
Zielendpunkt und Pfad der WebHook-Aktivität. Typ: Zeichenfolge (oder Ausdruck mit resultType-Zeichenfolge).
url: any
Eigenschaftswert
any
Geerbte Eigenschaftsdetails
dependsOn
Aktivität hängt von der Bedingung ab.
dependsOn?: ActivityDependency[]
Eigenschaftswert
Geerbt vonControlActivity.dependsOn
description
Aktivitätsbeschreibung.
description?: string
Eigenschaftswert
string
name
onInactiveMarkAs
Statusergebnis der Aktivität, wenn der Zustand auf "Inaktiv" festgelegt ist. Dies ist eine optionale Eigenschaft und wird nicht angegeben, wenn die Aktivität inaktiv ist, wird der Status standardmäßig erfolgreich sein.
onInactiveMarkAs?: string
Eigenschaftswert
string
state
Aktivitätsstatus. Dies ist eine optionale Eigenschaft, und wenn nicht angegeben, ist der Zustand standardmäßig aktiv.
state?: string
Eigenschaftswert
string
userProperties
Aktivitätsbenutzereigenschaften.
userProperties?: UserProperty[]