WebHookActivity interface
WebHook アクティビティ。
- Extends
プロパティ
| authentication | エンドポイントの呼び出しに使用される認証方法。 |
| body | エンドポイントに送信されるペイロードを表します。 POST/PUT メソッドでは必須。GET メソッドの型: string (または resultType 文字列を含む式) には使用できません。 |
| headers | 要求に送信されるヘッダーを表します。 たとえば、要求に言語と型を設定するには:"headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }。 型: string (または resultType 文字列を含む式)。 |
| method | ターゲット エンドポイントの REST API メソッド。 |
| report |
true に設定すると、コールバック要求本文の statusCode、出力、エラーがアクティビティによって使用されます。 コールバック要求で statusCode >= 400 を設定することで、アクティビティを失敗としてマークできます。 既定値は false です。 型: boolean (または resultType ブール値を持つ式)。 |
| timeout | Webhook を呼び戻すタイムアウト。 値が指定されていない場合、既定値は 10 分です。 型: 文字列。 パターン: ((\d+).)?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). |
| type | ポリモーフィック識別子。このオブジェクトは、さまざまな型を指定します。 |
| url | WebHook アクティビティのターゲット エンドポイントとパス。 型: string (または resultType 文字列を含む式)。 |
継承されたプロパティ
| depends |
アクティビティは条件によって異なります。 |
| description | アクティビティの説明。 |
| name | アクティビティ名。 |
| on |
状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブのときに指定されていない場合、状態は既定で Succeeded になります。 |
| state | アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定でアクティブになります。 |
| user |
アクティビティ ユーザーのプロパティ。 |
プロパティの詳細
authentication
body
エンドポイントに送信されるペイロードを表します。 POST/PUT メソッドでは必須。GET メソッドの型: string (または resultType 文字列を含む式) には使用できません。
body?: anyプロパティ値
any
headers
要求に送信されるヘッダーを表します。 たとえば、要求に言語と型を設定するには:"headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }。 型: string (または resultType 文字列を含む式)。
headers?: anyプロパティ値
any
method
ターゲット エンドポイントの REST API メソッド。
method: stringプロパティ値
string
reportStatusOnCallBack
true に設定すると、コールバック要求本文の statusCode、出力、エラーがアクティビティによって使用されます。 コールバック要求で statusCode >= 400 を設定することで、アクティビティを失敗としてマークできます。 既定値は false です。 型: boolean (または resultType ブール値を持つ式)。
reportStatusOnCallBack?: anyプロパティ値
any
timeout
Webhook を呼び戻すタイムアウト。 値が指定されていない場合、既定値は 10 分です。 型: 文字列。 パターン: ((\d+).)?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])).
timeout?: stringプロパティ値
string
type
ポリモーフィック識別子。このオブジェクトは、さまざまな型を指定します。
type: "WebHook"プロパティ値
"WebHook"
url
WebHook アクティビティのターゲット エンドポイントとパス。 型: string (または resultType 文字列を含む式)。
url: anyプロパティ値
any
継承されたプロパティの詳細
dependsOn
アクティビティは条件によって異なります。
dependsOn?: ActivityDependency[]プロパティ値
description
name
onInactiveMarkAs
状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブのときに指定されていない場合、状態は既定で Succeeded になります。
onInactiveMarkAs?: stringプロパティ値
string
state
アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定でアクティブになります。
state?: stringプロパティ値
string
userProperties
アクティビティ ユーザーのプロパティ。
userProperties?: UserProperty[]