ジャンプ先

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

カスタム・ユーザー・アクティビティ・データの作成

post

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

カスタム・ユーザー・アクティビティの新しいランタイム・データを作成します

リクエスト

この操作にはリクエスト・パラメータはありません。

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

• application/xml
• application/json

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

ルート・スキーマ: schema

型: array

カスタム・ユーザー・アクティビティ作成リクエストのランタイム・データのリスト。

ソースを表示

• 配列: object TransactionRequest
  トランザクションを作成するためのデータ・オブジェクト

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

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

型: object

トランザクションを作成するためのデータ・オブジェクト

ソースを表示

• analyzePatterns: boolean
  パターンを分析する場合はtrue
• contextMap(required): array contextMap
  コンテキスト・データ
• externalTransactionId: string
  外部トランザクションID
• requestId(required): string
  リクエスト識別子。
• requestTime: string (date-time)
  rfc3339セクション5.6の形式の日時文字列。https://tools.ietf.org/html/rfc3339#section-5.6 (例: 2021-08-13T01:29:29.768Z)
• status(required): integer
  tracker.transaction.status.enumの構成値の1つ。tracker.transaction.status.enumの使用可能な値を確認するには、構成プロパティのREST API操作GETを、URL <PolicyURL>/policy/config/property/v1?propertyName=tracker.transaction.status.enumとともに使用します。
• transactionId: number
  トランザクション識別子。通常はトランザクションの更新に使用されます。
• transactionKey(required): string
  トランザクションのキー

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

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

型: array

コンテキスト・データ

ソースを表示

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

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

ネストされたスキーマ: 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

型: array

カスタム・ユーザー・アクティビティ作成リクエストのランタイム・データのリスト。

ソースを表示

• 配列: object TransactionRequest
  トランザクションを作成するためのデータ・オブジェクト

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

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

型: object

トランザクションを作成するためのデータ・オブジェクト

ソースを表示

• analyzePatterns: boolean
  パターンを分析する場合はtrue
• contextMap(required): array contextMap
  コンテキスト・データ
• externalTransactionId: string
  外部トランザクションID
• requestId(required): string
  リクエスト識別子。
• requestTime: string (date-time)
  rfc3339セクション5.6の形式の日時文字列。https://tools.ietf.org/html/rfc3339#section-5.6 (例: 2021-08-13T01:29:29.768Z)
• status(required): integer
  tracker.transaction.status.enumの構成値の1つ。tracker.transaction.status.enumの使用可能な値を確認するには、構成プロパティのREST API操作GETを、URL <PolicyURL>/policy/config/property/v1?propertyName=tracker.transaction.status.enumとともに使用します。
• transactionId: number
  トランザクション識別子。通常はトランザクションの更新に使用されます。
• transactionKey(required): string
  トランザクションのキー

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

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

型: array

コンテキスト・データ

ソースを表示

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

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

ネストされたスキーマ: 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

201レスポンス

作成されたカスタム・ユーザー・アクティビティ・レスポンス

本文()

ルート・スキーマ: StatusResponses

型: array

ステータス・レスポンスのリスト

ソースを表示

• 配列: object StatusResponse
  APIコールのステータス情報

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

ネストされたスキーマ: 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."
        }
    }
}

ネストされたスキーマ: 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."
        }
    }
}

400レスポンス

無効な入力

本文()

ルート・スキーマ: StatusResponses

型: array

ステータス・レスポンスのリスト

ソースを表示

• 配列: object StatusResponse
  APIコールのステータス情報

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

ネストされたスキーマ: 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."
        }
    }
}

ネストされたスキーマ: 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レスポンス

未認可

500レスポンス

内部サーバー・エラー

503レスポンス

サービス使用不可

先頭に戻る

例

次の例では、カスタム・ユーザー・アクティビティのランタイム・データを作成するサンプルのリクエストとレスポンスを示します。

JSON形式でカスタム・ユーザー・アクティビティのランタイム・データを作成するcURLコマンド

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

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

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

XML形式でカスタム・ユーザー・アクティビティのランタイム・データを作成するcURLコマンド

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

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

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

先頭に戻る