REST API for Risk Service in Oracle Advanced Risk Manager

Update custom user activitiy data

put

https://oaainstall-host/risk-analyzer/transaction/v1

Updates runtime data for custom user activities

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: array

List of runtime data for custom user activity create requests.

Show Source

Array of: object TransactionRequest

Data Object to create a Transaction

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TransactionRequest"
    },
    "description":"List of runtime data for custom user activity create requests."
}

Nested Schema : TransactionRequest

Type: object

Data Object to create a Transaction

Show Source

analyzePatterns: boolean

true if patterns should be analyzed
contextMap(required): array contextMap

context data
externalTransactionId: string

external transaction id
requestId(required): string

request identifier.
requestTime: string (date-time)

Date time string in the format rfc3339 sec 5.6. https://tools.ietf.org/html/rfc3339#section-5.6 e.g format 2021-08-13T01:29:29.768Z
status(required): integer

status of the transaction.
transactionId: number

Transaction identifier, generally used to update the transaction.
transactionKey(required): string

Key of the transaction

{
    "type":"object",
    "description":"Data Object to create a Transaction",
    "required":[
        "requestId",
        "contextMap",
        "status",
        "transactionKey"
    ],
    "properties":{
        "requestId":{
            "type":"string",
            "description":"request identifier."
        },
        "transactionId":{
            "type":"number",
            "description":"Transaction identifier, generally used to update the transaction."
        },
        "requestTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"time of the request."
        },
        "transactionKey":{
            "type":"string",
            "description":"Key of the transaction"
        },
        "externalTransactionId":{
            "type":"string",
            "description":"external transaction id"
        },
        "status":{
            "type":"integer",
            "description":"status of the transaction."
        },
        "analyzePatterns":{
            "type":"boolean",
            "description":"true if patterns should be analyzed"
        },
        "contextMap":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KeyValPair"
            },
            "description":"context data"
        }
    }
}

Nested Schema : contextMap

Type: array

context data

Show Source

Array of: object KeyValPair

Key-value pair which can be used generically.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/KeyValPair"
    },
    "description":"context data"
}

Nested Schema : KeyValPair

Type: object

Key-value pair which can be used generically.

Show Source

key(required): string

Key that can be used to fetch the related value.
value(required): object value

associated value.

{
    "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":"object",
            "description":"associated value."
        }
    }
}

Nested Schema : value

Type: object

associated value.

Root Schema : schema

Type: array

List of runtime data for custom user activity create requests.

Show Source

Array of: object TransactionRequest

Data Object to create a Transaction

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TransactionRequest"
    },
    "description":"List of runtime data for custom user activity create requests."
}

Nested Schema : TransactionRequest

Type: object

Data Object to create a Transaction

Show Source

analyzePatterns: boolean

true if patterns should be analyzed
contextMap(required): array contextMap

context data
externalTransactionId: string

external transaction id
requestId(required): string

request identifier.
requestTime: string (date-time)

Date time string in the format rfc3339 sec 5.6. https://tools.ietf.org/html/rfc3339#section-5.6 e.g format 2021-08-13T01:29:29.768Z
status(required): integer

status of the transaction.
transactionId: number

Transaction identifier, generally used to update the transaction.
transactionKey(required): string

Key of the transaction

{
    "type":"object",
    "description":"Data Object to create a Transaction",
    "required":[
        "requestId",
        "contextMap",
        "status",
        "transactionKey"
    ],
    "properties":{
        "requestId":{
            "type":"string",
            "description":"request identifier."
        },
        "transactionId":{
            "type":"number",
            "description":"Transaction identifier, generally used to update the transaction."
        },
        "requestTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"time of the request."
        },
        "transactionKey":{
            "type":"string",
            "description":"Key of the transaction"
        },
        "externalTransactionId":{
            "type":"string",
            "description":"external transaction id"
        },
        "status":{
            "type":"integer",
            "description":"status of the transaction."
        },
        "analyzePatterns":{
            "type":"boolean",
            "description":"true if patterns should be analyzed"
        },
        "contextMap":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KeyValPair"
            },
            "description":"context data"
        }
    }
}

Nested Schema : contextMap

Type: array

context data

Show Source

Array of: object KeyValPair

Key-value pair which can be used generically.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/KeyValPair"
    },
    "description":"context data"
}

Nested Schema : KeyValPair

Type: object

Key-value pair which can be used generically.

Show Source

key(required): string

Key that can be used to fetch the related value.
value(required): object value

associated value.

{
    "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":"object",
            "description":"associated value."
        }
    }
}

Nested Schema : value

Type: object

associated value.

Response

Supported Media Types

application/xml
application/json
text/plain

200 Response

Updated custom user activity response

Root Schema : StatusResponses

Type: array

List of status responses

Show Source

Array of: object StatusResponse

Status information for API call

{
    "type":"array",
    "description":"List of status responses",
    "items":{
        "$ref":"#/components/schemas/StatusResponse"
    }
}

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
transactionId: number

transactionId in case of transaction data.
userData: object SessionUserData

user related data

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

Nested Schema : SessionUserData

Type: object

user related data

Show Source

groupName(required): string

group name
loginName(required): string

Login name used for authentication
userId: string

user identifier.

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

400 Response

Invalid input

Root Schema : StatusResponses

Type: array

List of status responses

Show Source

Array of: object StatusResponse

Status information for API call

{
    "type":"array",
    "description":"List of status responses",
    "items":{
        "$ref":"#/components/schemas/StatusResponse"
    }
}

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
transactionId: number

transactionId in case of transaction data.
userData: object SessionUserData

user related data

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

Nested Schema : SessionUserData

Type: object

user related data

Show Source

groupName(required): string

group name
loginName(required): string

Login name used for authentication
userId: string

user identifier.

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

Unauthorized

500 Response

Internal server error

503 Response

Service Unavailable

Examples

The following example shows a sample request and response for updating runtime data for custom user activities.

cURL Command to Update Runtime Data for Custom User Activity in JSON Format

curl --location --request PUT '<RISK>/risk-analyzer/transaction/v1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '[
    {
        "requestId": "4fb04854-cd02-492d-ab87-164a87b7d06e",
        "transactionId": "7",
        "transactionKey": "Credit Card Activity",
        "status":1,
        "contextMap": [
            {
                "key": "transaction.price",
                "value": "400"
            },
            {
                "key": "CC.name",
                "value": "Mastercard"
            }
        ]
    }
]'

Sample Response in JSON Format

[
    {
        "responseCode": "0",
        "responseMessage": "",
        "status": true,
        "transactionId": 7
    }
]

cURL Command to Update Runtime Data for Custom User Activity in XML Format

curl --location --request PUT '<RISK>/risk-analyzer/transaction/v1' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '
<?xml version="1.0" encoding="UTF-8" ?>
<TransactionRequests>
    <TransactionRequest>
	<requestId>4fb04854-cd02-492d-ab87-164a87b7d06e</requestId>
	<transactionId>7</transactionId>
	<transactionKey>Credit Card Activity</transactionKey>
	<status>1</status>
	<contextMap>
		<key>transaction.price</key>
		<value>400</value>
	</contextMap>
	<contextMap>
		<key>CC.name</key>
		<value>Mastercard</value>
	</contextMap>
</TransactionRequests>
    </TransactionRequest>
'

Sample Response in XML Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<StatusResponses>
    <StatusResponse>
	<responseCode>0</responseCode>
	<responseMessage></responseMessage>
	<status>true</status>
	<transactionId>7</transactionId>
    </StatusResponses>
</StatusResponse>