プロセス・ルール
put
https://oaainstall-host/risk-analyzer/risk/v1/processrulessecurely
特定のセッション(リクエスト)およびチェックポイントのルールを実行します。
リクエスト
この操作にはリクエスト・パラメータはありません。
サポートされているメディア・タイプ
- application/xml
- application/json
ルート・スキーマ: schema
型:
object
プロセス・ルール・リクエスト・オブジェクト
ソースを表示
-
checkpointList: array checkpointList
実行するチェックポイントのリスト。現在、リクエストごとに1つのチェックポイントのみがサポートされています。
-
contextMap: array contextMap
ルール評価の追加コンテキスト。
-
extTransactionId: string
外部トランザクションID。transactionIdがnullの場合にのみ使用されます
-
requestId(required): string
リクエストのリクエストID
-
requestTime: string (date-time)
rfc3339セクション5.6の形式の日時文字列。https://tools.ietf.org/html/rfc3339#section-5.6 (例: 2021-08-13T01:29:29.768Z)
-
transactionId: number
このセッションに作成されたユーザー・アクティビティ・データ識別子
ネストされたスキーマ: KeyValPair
型:
object
一般的に使用できるキーと値のペア。
ソースを表示
-
key(required): string
関連値のフェッチに使用できるキー。
-
value(required): string
関連付けられた値。
ルート・スキーマ: schema
型:
object
プロセス・ルール・リクエスト・オブジェクト
ソースを表示
-
checkpointList: array checkpointList
実行するチェックポイントのリスト。現在、リクエストごとに1つのチェックポイントのみがサポートされています。
-
contextMap: array contextMap
ルール評価の追加コンテキスト。
-
extTransactionId: string
外部トランザクションID。transactionIdがnullの場合にのみ使用されます
-
requestId(required): string
リクエストのリクエストID
-
requestTime: string (date-time)
rfc3339セクション5.6の形式の日時文字列。https://tools.ietf.org/html/rfc3339#section-5.6 (例: 2021-08-13T01:29:29.768Z)
-
transactionId: number
このセッションに作成されたユーザー・アクティビティ・データ識別子
ネストされたスキーマ: KeyValPair
型:
object
一般的に使用できるキーと値のペア。
ソースを表示
-
key(required): string
関連値のフェッチに使用できるキー。
-
value(required): string
関連付けられた値。
レスポンス
サポートされているメディア・タイプ
- application/xml
- application/json
- text/plain
200レスポンス
認証コンテキストに対して処理されたルール。
ルート・スキーマ: ProcessRiskResponse
型:
object
処理されたルールのレスポンス・オブジェクト
ソースを表示
-
alertMessageList: array alertMessageList
実行されたルールに従ったアラートのリスト
-
allActions: array allActions
アクションのリスト。
-
apiRespone: object ProcessRiskApiResponse
リクエスト・ステータスを示すプロセス・ルールのルールAPIレスポンス
-
deviceId: number
関連付けられたデバイスIDを返します。
-
result: string
これは実行するアクションです。このアクションは、ルール・エンジンから返されたアクションのリストに処理ルールを適用した後に実行されます。
-
resultMap: array resultMap
これを使用して、リクエストされた各チェックポイントの結果を取得します。ルール評価リクエストごとにチェックポイントが1つあるため、このフィールドは使用されません。
-
runtimeType: integer
処理されたルールの実行時の型。
-
score: integer
ルールの実行後にスコアを取得する方法
-
statusResponse: object StatusResponse
APIコールのステータス情報
-
transactionLogId: number
入力で指定されたユーザー・アクティビティ・データ識別子。
ネストされたスキーマ: ProcessRiskApiResponse
型:
object
リクエスト・ステータスを示すプロセス・ルールのルールAPIレスポンス
ソースを表示
-
responseCode: string
リクエストのステータス・コード
-
responseMessage: string
レスポンス・コードに関連するレスポンス・メッセージ(必要に応じて)。
ネストされたスキーマ: resultMap
型:
array
これを使用して、リクエストされた各チェックポイントの結果を取得します。ルール評価リクエストごとにチェックポイントが1つあるため、このフィールドは使用されません。
ソースを表示
- 配列: object KeyValPair
一般的に使用できるキーと値のペア。
ネストされたスキーマ: StatusResponse
型:
object
APIコールのステータス情報
ソースを表示
-
responseCode: string
リクエストのステータス・コード
-
responseMessage: string
レスポンス・コードに関連するレスポンス・メッセージ(必要に応じて)。
-
sessionId: string
認証のセッションID。
-
status: boolean
認証更新リクエスト・ステータス
-
transactionId: number
トランザクション・データの場合はtransactionId。
-
userData: object SessionUserData
ユーザー関連データ
ネストされたスキーマ: KeyValPair
型:
object
一般的に使用できるキーと値のペア。
ソースを表示
-
key(required): string
関連値のフェッチに使用できるキー。
-
value(required): string
関連付けられた値。
ネストされたスキーマ: SessionUserData
型:
object
ユーザー関連データ
ソースを表示
-
groupName(required): string
グループ名
-
loginName(required): string
認証に使用されるログイン名
-
userId: string
ユーザー識別子。
400レスポンス
無効な入力
ルート・スキーマ: ProcessRiskApiResponse
型:
object
リクエスト・ステータスを示すプロセス・ルールのルールAPIレスポンス
ソースを表示
-
responseCode: string
リクエストのステータス・コード
-
responseMessage: string
レスポンス・コードに関連するレスポンス・メッセージ(必要に応じて)。
401レスポンス
未認可
500レスポンス
内部サーバー・エラー
503レスポンス
サービス使用不可
例
次の例では、特定のセッション(リクエスト)およびチェックポイントの処理ルールに対するサンプルのリクエストとレスポンスを示します。
JSON形式でルールを処理するcURLコマンド
curl --location --request PUT '<RISK>/risk-analyzer/risk/v1/processrulessecurely' \ --header 'Content-Type: application/json' \ --header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \ --data '{ "requestId":"96eb744b-b84e-4c13-8b78-06b64ad81d94", "checkpointList": [ 1600 ], "transactionId": 1, "contextMap": [ { "key": "Dummy", "value": "Value" } ] } }'
JSON形式のサンプル・レスポンス
{ "allActions": [ "Block" ], "result": "Block", "score": 1000, "transactionLogId": 6, "resultMap": [], "alertMessageList": [ "sessActionMapId=279;loginId=testuser;userId=testuser;deviceId=85;ip=10.175.171.219;lastTransactionId=6;msg=Purchased Item Exceeds Limit" ], "runtimeType": 1600, "deviceId": 85, "statusResponse": { "responseCode": "0", "responseMessage": "", "status": true } }
XML形式でルールを処理するcURLコマンド
curl --location --request PUT '<RISK>/risk-analyzer/risk/v1/processrulessecurely' \ --header 'Content-Type: application/xml' \ --header 'Accept: application/xml' \ --header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \ --data ' <?xml version="1.0" encoding="UTF-8"?> <ProcessRiskRequest> <requestId>96eb744b-b84e-4c13-8b78-06b64ad81d94</requestId> <checkpointList>1600</checkpointList> <transactionId>1</transactionId> <contextMap> <key>Dummy</key> <value>Value</value> </contextMap> </ProcessRiskRequest> '
XML形式のサンプル・レスポンス
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ProcessRiskResponse> <allActions>Block</allActions> <result>Block</result> <score>1000</score> <transactionLogId>6</transactionLogId> <alertMessageList>sessActionMapId=279;loginId=testuser;userId=testuser;deviceId=85;ip=10.175.171.219;lastTransactionId=6;msg=Purchased Item Exceeds Limit</alertMessageList> <runtimeType>1600</runtimeType> <deviceId>85</deviceId> <statusResponse> <responseCode>0</responseCode> <responseMessage></responseMessage> <status>true</status> </statusResponse> </ProcessRiskResponse>