Jump to

• Request
• Response
• Examples

Create custom user activity data

post

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

Creates new runtime data for custom user activities

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

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
  One of the config values from tracker.transaction.status.enum. To check the possible values of the tracker.transaction.status.enum, use the config property REST API operation GET with URL <PolicyURL>/policy/config/property/v1?propertyName=tracker.transaction.status.enum.
• 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":"One of the config values from tracker.transaction.status.enum. To check the possible values of the tracker.transaction.status.enum, use the config property REST API operation GET with URL <PolicyURL>/policy/config/property/v1?propertyName=tracker.transaction.status.enum."
        },
        "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): string
  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":"string",
            "description":"associated value."
        }
    }
}

Request Body - 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
  One of the config values from tracker.transaction.status.enum. To check the possible values of the tracker.transaction.status.enum, use the config property REST API operation GET with URL <PolicyURL>/policy/config/property/v1?propertyName=tracker.transaction.status.enum.
• 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":"One of the config values from tracker.transaction.status.enum. To check the possible values of the tracker.transaction.status.enum, use the config property REST API operation GET with URL <PolicyURL>/policy/config/property/v1?propertyName=tracker.transaction.status.enum."
        },
        "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): string
  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":"string",
            "description":"associated value."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json
• text/plain

201 Response

Created custom user activity response

Body ()

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

Body ()

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

Back to Top

Examples

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

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

curl --location --request POST '<RISK>/risk-analyzer/transaction/v1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '[
    {
        "requestId": "96eb744b-b84e-4c13-8b78-06b64ad81d94",
        "transactionKey": "Credit Card Activity",
        "status": "1",
        "contextMap": [
            {
                "key": "transaction.price",
                "value": "700"
            },
            {
                "key": "CC.name",
                "value": "Visa"
            }
        ]
    }
]'

Sample Response in JSON Format

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

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

curl --location --request POST '<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>96eb744b-b84e-4c13-8b78-06b64ad81d94</requestId>
	<transactionKey>Credit Card Activity</transactionKey>
	<status>1</status>
	<contextMap>
		<key>transaction.price</key>
		<value>700</value>
	</contextMap>
	<contextMap>
		<key>CC.name</key>
		<value>Visa</value>
	</contextMap>
    </TransactionRequest>
</TransactionRequests>
'

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>5</transactionId>
    </StatusResponse>
</StatusResponses>

Back to Top