ジャンプ先

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

ルール・データの取得

get

/customercare/v1/rules

特定のセッションIDに対して実行されたすべてのルールを返します。トリガーされたルールの基本情報を提供し、完全な階層情報は提供しません。ルール実行データは非同期に永続化されているため、即時に使用できない場合があります。

リクエスト

問合せパラメータ

• sessionId(required): string
  セッションID

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

• application/xml
• application/json

200レスポンス

成功

本文()

ルート・スキーマ: RuleResponse

型: object

ソースを表示

• requestId: string
  ロギング/トラッキングを目的としたリクエストID
• runtimeData: object runtimeData
  使用可能なその他のプロパティ: RuntimeDataList

  ランタイムIDのランタイム・データ・リストへのマップ
• statusResponse: object StatusResponse
  APIコールのステータス情報

{
    "type":"object",
    "properties":{
        "requestId":{
            "type":"string",
            "description":"Request ID for logging/tracking purposes"
        },
        "runtimeData":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/RuntimeDataList"
            },
            "description":"Map of runtime IDs to runtime data lists"
        },
        "statusResponse":{
            "$ref":"#/components/schemas/StatusResponse"
        }
    }
}

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

型: object

使用可能なその他のプロパティ

ソースを表示

• array RuntimeDataList

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/RuntimeDataList"
    },
    "description":"Map of runtime IDs to runtime data lists"
}

ランタイムIDのランタイム・データ・リストへのマップ

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

型: object

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

ソースを表示

• responseCode: string
  リクエストのステータス・コード
• responseMessage: string
  レスポンス・コードに関連するレスポンス・メッセージ(必要に応じて)。
• sessionId: string
  認証のセッションID。
• status: boolean
  認証更新リクエスト・ステータス

{
    "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."
        }
    }
}

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

型: array

ソースを表示

• 配列: object RuntimeData

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RuntimeData"
    }
}

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

型: object

ソースを表示

• actionList: array actionList
• alertList: array alertList
• finalScore: integer
• ruleList: array ruleList
• runtime: integer
• runtimeName: string

{
    "type":"object",
    "properties":{
        "runtime":{
            "type":"integer"
        },
        "runtimeName":{
            "type":"string"
        },
        "finalScore":{
            "type":"integer"
        },
        "actionList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "alertList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alert"
            }
        },
        "ruleList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Rule"
            }
        }
    }
}

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

型: array

ソースを表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

ソースを表示

• 配列: object Alert

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Alert"
    }
}

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

型: array

ソースを表示

• 配列: object Rule

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Rule"
    }
}

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

型: object

ソースを表示

• id: integer
• level: string
• message: string
• type: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "level":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

• modelId: integer
• modelName: string
• ruleId: integer
• ruleName: string

{
    "type":"object",
    "properties":{
        "ruleName":{
            "type":"string"
        },
        "ruleId":{
            "type":"integer"
        },
        "modelName":{
            "type":"string"
        },
        "modelId":{
            "type":"integer"
        }
    }
}

400レスポンス

無効な入力

404レスポンス

セッションIDが見つかりません

先頭に戻る

例

次の例は、指定したセッションIDに対して実行されたすべてのルールを返すサンプルのリクエストとレスポンスを示しています。

JSON形式でルール・データを取得するcURLコマンド

curl --location --request DELETE '<RISKCC>/risk-cc/customercare/v1/rules?sessionId=0cf1f2d3-63fe-4fda-b593-d06fafbcd0e1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' 

JSON形式のサンプル・レスポンス

{
  "requestId": "0cf1f2d3-63fe-4fda-b593-d06fafbcd0e1",
  "runtimeData": {
    "400": [
      {
        "actionList": [
          "create_new",
          "update_cookie_state"
        ],
        "alertList": [],
        "finalScore": 0,
        "ruleList": [],
        "runtime": 400,
        "runtimeName": "deviceid"
      }
    ]
  },
  "statusResponse": {
    "responseCode": "0",
    "responseMessage": "",
    "status": true
  }
}

XML形式でルール・データを取得するcURLコマンド

curl --location --request PUT '<RISKCC>/risk-cc/customercare/v1/rules?sessionId=0cf1f2d3-63fe-4fda-b593-d06fafbcd0e1' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

XML形式のサンプル・レスポンス

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><RuleResponse>
<requestId>f50ad542-832f-4532-ab3b-a2f4bc103b86</requestId>
    <runtimeData>
      <entry>
        <key>400</key>
       <value>
        <RuntimeData>
        <runtime>400</runtime>
        <runtimeName>deviceid</runtimeName>
        <finalScore>0</finalScore>
        <actionList>create_new</actionList>
        <actionList>update_cookie_state</actionList>    
        </RuntimeData>        
       </value>    
    </entry>
    </runtimeData>
<statusResponse>
    <responseCode>0</responseCode>    
    <responseMessage></responseMessage>    
    <status>true</status>
</statusResponse>
</RuleResponse>

先頭に戻る