REST API for Customer Care Service in Oracle Advanced Risk Manager

Get rules data

get

/customercare/v1/rules

Return all the rules excuted for the given session ID. Provides basic information of what rules got triggered, doesn't provide complete hierarchy information. Rules execution data is persisted asynchrously and may not be available immediately.

Request

Query Parameters

sessionId(required): string

Session ID

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success

Root Schema : RuleResponse

Type: object

Show Source

requestId: string

Request ID for logging/tracking purposes
runtimeData: object runtimeData

Additional Properties Allowed: RuntimeDataList

Map of runtime IDs to runtime data lists
statusResponse: object StatusResponse

Status information for API call

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

Nested Schema : runtimeData

Type: object

Additional Properties Allowed

Show Source

array RuntimeDataList

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

Map of runtime IDs to runtime data lists

Nested Schema : StatusResponse

Type: object

Status information for API call

Show Source

responseCode: string

status code of the request
responseMessage: string

response message related to the response code if needed.
sessionId: string

session id of the authentcation.
status: boolean

authentication update request status

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

Nested Schema : RuntimeDataList

Type: array

Show Source

Array of: object RuntimeData

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

Nested Schema : RuntimeData

Type: object

Show Source

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

Nested Schema : actionList

Type: array

Show Source

Array of: string

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

Nested Schema : alertList

Type: array

Show Source

Array of: object Alert

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

Nested Schema : ruleList

Type: array

Show Source

Array of: object Rule

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

Nested Schema : Alert

Type: object

Show Source

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

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

Nested Schema : Rule

Type: object

Show Source

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

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

400 Response

Invalid input

404 Response

Session ID not found

Examples

The following example shows a sample request and response for returning all the rules executed for the specified session ID.

cURL Command to Get Rules Data in JSON Format

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>)>'

Sample Response in JSON Format

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

cURL Command to Get Rules Data in XML Format

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>)>'

Sample Response in XML Format

<?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>