外部サービスからの結果通知APIの詳細
結果通知用APIの詳細について説明します。
- URLは署名されているため、パラメータを変更することはできません。
メソッド
POST
URL
https://{APIエンドポイント}/handlers/to-http/{status}?tenantId={tenantId}&docId={docId}&date={date}&expiresIn={expiresIn}&sig={sig}
パスパラメータ
| パラメータ名 | 説明 |
|---|---|
| status | successまたはerrorになります。 |
クエリパラメータ
| パラメータ名 | 説明 |
|---|---|
| tenantId | ルールを実行したユーザーの所属テナントIDです。 |
| docId | 実行中のルールのIDです。 |
| date | URLの発行日時です。 |
| expiresIn | URLの有効期間です。 |
| sig | 署名です。 |
リクエストヘッダー
不要です。
リクエストボディ
不要です。
レスポンス
| ステータスコード | 条件 | メッセージ |
|---|---|---|
| 200 | 正常 | "The status of the rule has been successfully updated." |
| 400 | パラメータが不足 | "The value of the parameter [${key}] is incorrect." |
| 400 | URLの有効期限切れ | "The requested URL has expired." |
| 403 | 署名がない、または不正 | "There is no operation authority." |
| 404 | ルールが実行中でない | "The data [${doc-id}] cannot be found." |
| 500 | サーバー内部のエラー | "Unknown server error occurred." |