ジャンプ先

• リクエスト
• レスポンス

非推奨 - プロセス・ルール

put

https://oaainstall-host/risk-analyzer/risk/v1/{requestId}

非推奨: processrulessecurely APIを使用してください。特定のセッション(リクエスト)およびチェックポイントのルールを実行します。

リクエスト

パス・パラメータ

• requestId(required): string

サポートされているメディア・タイプ

• application/xml
• application/json

リクエスト本文 - application/xml ()

ルート・スキーマ: 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
  このセッションに作成されたユーザー・アクティビティ・データ識別子

{
    "type":"object",
    "description":"Process rule request object",
    "required":[
        "requestId"
    ],
    "properties":{
        "requestId":{
            "type":"string",
            "description":"requestId for the request"
        },
        "transactionId":{
            "type":"number",
            "description":"User Activity data Identifier created for this session"
        },
        "extTransactionId":{
            "type":"string",
            "description":"external transaction Id, used only when transactionId is null"
        },
        "requestTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"time of the request"
        },
        "checkpointList":{
            "type":"array",
            "items":{
                "type":"integer"
            },
            "description":"List of checkpoints to be executed. Currently, only one checkpoint per request is supported."
        },
        "contextMap":{
            "type":"array",
            "description":"additional context for rule evaluation.",
            "items":{
                "$ref":"#/components/schemas/KeyValPair"
            }
        }
    }
}

ネストされたスキーマ: checkpointList

型: array

実行するチェックポイントのリスト。現在、リクエストごとに1つのチェックポイントのみがサポートされています。

ソースを表示

• 配列: integer

{
    "type":"array",
    "items":{
        "type":"integer"
    },
    "description":"List of checkpoints to be executed. Currently, only one checkpoint per request is supported."
}

ネストされたスキーマ: contextMap

型: array

ルール評価の追加コンテキスト。

ソースを表示

• 配列: object KeyValPair
  一般的に使用できるキーと値のペア。

{
    "type":"array",
    "description":"additional context for rule evaluation.",
    "items":{
        "$ref":"#/components/schemas/KeyValPair"
    }
}

ネストされたスキーマ: KeyValPair

型: object

一般的に使用できるキーと値のペア。

ソースを表示

• key(required): string
  関連値のフェッチに使用できるキー。
• value(required): string
  関連付けられた値。

{
    "type":"object",
    "description":"Key-value pair which can be used generically.",
    "required":[
        "key",
        "value"
    ],
    "properties":{
        "key":{
            "type":"string",
            "description":"Key that can be used to fetch the related value."
        },
        "value":{
            "type":"string",
            "description":"associated value."
        }
    }
}

リクエスト本文 - 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
  このセッションに作成されたユーザー・アクティビティ・データ識別子

{
    "type":"object",
    "description":"Process rule request object",
    "required":[
        "requestId"
    ],
    "properties":{
        "requestId":{
            "type":"string",
            "description":"requestId for the request"
        },
        "transactionId":{
            "type":"number",
            "description":"User Activity data Identifier created for this session"
        },
        "extTransactionId":{
            "type":"string",
            "description":"external transaction Id, used only when transactionId is null"
        },
        "requestTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"time of the request"
        },
        "checkpointList":{
            "type":"array",
            "items":{
                "type":"integer"
            },
            "description":"List of checkpoints to be executed. Currently, only one checkpoint per request is supported."
        },
        "contextMap":{
            "type":"array",
            "description":"additional context for rule evaluation.",
            "items":{
                "$ref":"#/components/schemas/KeyValPair"
            }
        }
    }
}

ネストされたスキーマ: checkpointList

型: array

実行するチェックポイントのリスト。現在、リクエストごとに1つのチェックポイントのみがサポートされています。

ソースを表示

• 配列: integer

{
    "type":"array",
    "items":{
        "type":"integer"
    },
    "description":"List of checkpoints to be executed. Currently, only one checkpoint per request is supported."
}

ネストされたスキーマ: contextMap

型: array

ルール評価の追加コンテキスト。

ソースを表示

• 配列: object KeyValPair
  一般的に使用できるキーと値のペア。

{
    "type":"array",
    "description":"additional context for rule evaluation.",
    "items":{
        "$ref":"#/components/schemas/KeyValPair"
    }
}

ネストされたスキーマ: KeyValPair

型: object

一般的に使用できるキーと値のペア。

ソースを表示

• key(required): string
  関連値のフェッチに使用できるキー。
• value(required): string
  関連付けられた値。

{
    "type":"object",
    "description":"Key-value pair which can be used generically.",
    "required":[
        "key",
        "value"
    ],
    "properties":{
        "key":{
            "type":"string",
            "description":"Key that can be used to fetch the related value."
        },
        "value":{
            "type":"string",
            "description":"associated value."
        }
    }
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• 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
  入力で指定されたユーザー・アクティビティ・データ識別子。

{
    "type":"object",
    "description":"Reponse object for processed rules",
    "properties":{
        "apiRespone":{
            "$ref":"#/components/schemas/ProcessRiskApiResponse",
            "description":"status of the request"
        },
        "allActions":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"List of actions."
        },
        "result":{
            "type":"string",
            "description":"This is the action to be taken. This action is the after applying the processing rule on the list of actions returned by the rule engine"
        },
        "score":{
            "type":"integer",
            "description":"Method to get the score after running the rules"
        },
        "transactionLogId":{
            "type":"number",
            "description":"User Activity data Identifier provided in the input."
        },
        "resultMap":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KeyValPair"
            },
            "description":"Use this to get result of each requested checkpoint. Since there is one checkpoint per rule evaluation request, this field is not used."
        },
        "alertMessageList":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"List of alerts as per the rules executed"
        },
        "runtimeType":{
            "type":"integer",
            "description":"runtime type of the rule processed."
        },
        "deviceId":{
            "type":"number",
            "description":"Returns the associated Device Id."
        },
        "statusResponse":{
            "$ref":"#/components/schemas/StatusResponse",
            "description":"response of the rule processing request."
        }
    }
}

ネストされたスキーマ: alertMessageList

型: array

実行されたルールに従ったアラートのリスト

ソースを表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"List of alerts as per the rules executed"
}

ネストされたスキーマ: allActions

型: array

アクションのリスト。

ソースを表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"List of actions."
}

ネストされたスキーマ: ProcessRiskApiResponse

型: object

リクエスト・ステータスを示すプロセス・ルールのルールAPIレスポンス

ソースを表示

• responseCode: string
  リクエストのステータス・コード
• responseMessage: string
  レスポンス・コードに関連するレスポンス・メッセージ(必要に応じて)。

{
    "type":"object",
    "description":"Rule api response for the process rule stating the request status",
    "properties":{
        "responseCode":{
            "type":"string",
            "description":"status code of the request"
        },
        "responseMessage":{
            "type":"string",
            "description":"response message related to the response code if needed."
        }
    }
}

ネストされたスキーマ: resultMap

型: array

これを使用して、リクエストされた各チェックポイントの結果を取得します。ルール評価リクエストごとにチェックポイントが1つあるため、このフィールドは使用されません。

ソースを表示

• 配列: object KeyValPair
  一般的に使用できるキーと値のペア。

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/KeyValPair"
    },
    "description":"Use this to get result of each requested checkpoint. Since there is one checkpoint per rule evaluation request, this field is not used."
}

ネストされたスキーマ: StatusResponse

型: object

APIコールのステータス情報

ソースを表示

• responseCode: string
  リクエストのステータス・コード
• responseMessage: string
  レスポンス・コードに関連するレスポンス・メッセージ(必要に応じて)。
• sessionId: string
  認証のセッションID。
• status: boolean
  認証更新リクエスト・ステータス
• transactionId: number
  トランザクション・データの場合はtransactionId。
• userData: object SessionUserData
  ユーザー関連データ

{
    "type":"object",
    "description":"Status information for API call",
    "properties":{
        "responseCode":{
            "type":"string",
            "description":"status code of the request"
        },
        "responseMessage":{
            "type":"string",
            "description":"response message related to the response code if needed."
        },
        "status":{
            "type":"boolean",
            "description":"authentication update request status"
        },
        "sessionId":{
            "type":"string",
            "description":"session id of the authentcation."
        },
        "transactionId":{
            "type":"number",
            "description":"transactionId in case of transaction data."
        },
        "userData":{
            "$ref":"#/components/schemas/SessionUserData",
            "description":"user data used in the session."
        }
    }
}

ネストされたスキーマ: KeyValPair

型: object

一般的に使用できるキーと値のペア。

ソースを表示

• key(required): string
  関連値のフェッチに使用できるキー。
• value(required): string
  関連付けられた値。

{
    "type":"object",
    "description":"Key-value pair which can be used generically.",
    "required":[
        "key",
        "value"
    ],
    "properties":{
        "key":{
            "type":"string",
            "description":"Key that can be used to fetch the related value."
        },
        "value":{
            "type":"string",
            "description":"associated value."
        }
    }
}

ネストされたスキーマ: SessionUserData

型: object

ユーザー関連データ

ソースを表示

• groupName(required): string
  グループ名
• loginName(required): string
  認証に使用されるログイン名
• userId: string
  ユーザー識別子。

{
    "type":"object",
    "description":"user related data",
    "required":[
        "loginName",
        "groupName"
    ],
    "properties":{
        "loginName":{
            "type":"string",
            "description":"Login name used for authentication"
        },
        "groupName":{
            "type":"string",
            "description":"group name"
        },
        "userId":{
            "type":"string",
            "description":"user identifier."
        }
    }
}

401レスポンス

未認可

405レスポンス

無効な入力

本文()

ルート・スキーマ: ProcessRiskApiResponse

型: object

リクエスト・ステータスを示すプロセス・ルールのルールAPIレスポンス

ソースを表示

• responseCode: string
  リクエストのステータス・コード
• responseMessage: string
  レスポンス・コードに関連するレスポンス・メッセージ(必要に応じて)。

{
    "type":"object",
    "description":"Rule api response for the process rule stating the request status",
    "properties":{
        "responseCode":{
            "type":"string",
            "description":"status code of the request"
        },
        "responseMessage":{
            "type":"string",
            "description":"response message related to the response code if needed."
        }
    }
}

500レスポンス

内部サーバー・エラー

503レスポンス

サービス使用不可

先頭に戻る