Fungible Token FrameworkラッパーAPIパッケージ

Oracle Blockchain Platform Digital Assets Editionには、保証金トークン・シナリオに固有の操作をサポートするようにREST APIを拡張するラッパーAPIパッケージが含まれています。

ラッパーAPIパッケージは、APIゲートウェイ・サービスおよびOCI Functionsを使用して、デポジット・トークン・アプリケーション用に特別に設計されたAPIルートをデプロイします。真菌性トークン・フレームワーク・ラッパーAPIパッケージは、Oracle Blockchain Platformコンソールからダウンロードでき、次のコンポーネントが含まれています。
  • DepositTokenWrapperAPI.zip。デプロイメントに必要なTerraformスクリプトを含むラッパーAPIパッケージを含むアーカイブ・ファイル。このファイルをOracle Cloud Infrastructure (OCI)のリソース・マネージャ・スタックにデプロイして、ラッパーAPIに必要なOracleリソースを作成します。
  • DepositToken_WrapperAPI.postman_collection.jsonは、デプロイされたラッパーAPIをテストできるPostmanコレクションです。コレクションには、ラッパーAPIパッケージで定義されたAPIに対応するエンドポイントおよびペイロードを含む事前構成済リクエストが含まれます。

ラッパーAPI

activateAccount
元のメソッド名: activateAccount
このPOSTメソッドは、トークン・アカウントをアクティブ化します。このメソッドは、指定した組織のToken AdminまたはOrg Adminによってのみコールできます。アカウント・ステータス機能より前に作成されたアカウントの場合は、このメソッドをコールしてアカウント・ステータスをアクティブにする必要があります。
ペイロード:
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
パラメータ:
  • tokenId: string– トークンのID。
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値:
  • 成功すると、指定したトークン・アカウントのアカウント・ステータス・オブジェクトのJSON表現。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "db0738d4a44f6d9c80b24fce7c518c07023f7be19edaa69b272eaf7886b4b925",
        "payload": {
            "assetType": "oaccountStatus",
            "status_id": "oaccountStatus~d5814d96d8517ac31727d60aace0519c58a425892ab0d378fcfb0a35771f65ae",
            "account_id": "oaccount~802bf8da5579c6103b2dddaa6c4385df8e722d639a18029e0e93d7a5d6f826d6",
            "status": "active"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 194
    }
}
addTokenAdmin
元のメソッド名: addTokenAdmin
このPOSTメソッドは、ユーザーをチェーンコードのToken Adminとして追加します。このメソッドをコールできるのは、チェーンコードのToken Adminのみです。
ペイロード:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
パラメータ:
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値:
  • 成功すると、チェーンコードのToken Adminとして追加されたユーザーの詳細を含むメッセージが表示されます。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
            "msg": "User (Org_Id: CB, User_Id: cb) is already Token Admin."
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 193
    }
}
addTokenAuditor
このPOSTメソッドは、ユーザーをチェーンコードのToken Auditorとして追加します。このメソッドをコールできるのは、チェーンコードのToken Adminのみです。
ペイロード:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
パラメータ:
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値:
  • 成功すると、チェーンコードのToken Auditorとして追加されたユーザーの詳細を含むメッセージが表示されます。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "cd81f6c4c9e7c18ece357dbf5c139ef66ef2d6566be3b14de5f6d0a3fd4bb2f0",
        "payload": {
            "msg": "Successfully added Token Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 196
    }
}
addOrgAdmin
元のメソッド名: addOrgAdmin
このPOSTメソッドは、ユーザーをチェーンコードのToken Adminとして追加します。このメソッドは、チェーンコードのToken Adminまたは指定された組織のOrg Adminによってのみコールできます。
ペイロード:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
パラメータ:
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値:
  • 成功すると、チェーンコードのOrg Adminとして追加されたユーザーの詳細を含むメッセージが表示されます。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "96a84dffcb9156f7271dfb414e8c43b540595044cf9145f5fd56e9873797fc4a",
        "payload": {
            "msg": "Successfully added Org Admin (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 197
    }
}
addOrgAuditor
このPOSTメソッドは、ユーザーをチェーンコードのOrg Auditorとして追加します。このメソッドは、チェーンコードのToken Adminまたは指定された組織のOrg Adminによってのみコールできます。
ペイロード:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
パラメータ:
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値:
  • 成功すると、チェーンコードのOrg Auditorとして追加されたユーザーの詳細を含むメッセージが表示されます。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "44bbad35a1478cb714e32f7cfd551897868a203520aab9cea5771d3aadc1cf03",
        "payload": {
            "msg": "Successfully added Org Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 198
    }
}
addRole
元のメソッド名: addRole
このメソッドは、指定されたユーザーおよびトークンにロールを追加します。
ペイロード:
{
    "tokenId": "{{bc-token-id}}",
    "role": "role value (for example minter / burner / notary)",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
パラメータ:
  • tokenId: string– トークンのID。
  • role: string– 指定したユーザーを追加するロールの名前。
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "29ea766dee8e6d273eba3c40a9fea75a1aa85dc3c280d40695f6224c5c52d93c",
        "payload": {
            "msg": "Successfully added role 'notary' to Account Id: oaccount~2eb5f8a9bc561f8f41a4ea3be9511958cc6684ef14f2337ca396efc301b627d8 (Org-Id: CB, User-Id: manager_user_cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 201
    }
}
approveMint
元のメソッド名: approveMint
Notariesは、このPOSTメソッドをコールして、ミントのリクエストを承認できます。
ペイロード:
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "sameOrgEndorser": true
}
パラメータ:
  • tokenId: string– トークンのID。
  • operationId: string– 承認するミント・リクエストの一意の操作ID。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "a4537ef34a955b023b7c205b9abf06a6c79e4fdd761fb24f41b8eb34126b66c0",
        "payload": {
            "msg": "Successfully minted 10 tokens to Account Id: oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0 (Org-Id: CB, User-Id: creator_user_cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 204
    }
}
executeHoldTokens
元のメソッド名: executeHoldTokens
Notariesは、このメソッドを呼び出してトークンの保留を承認します。トークン所有者によって以前に保留されたトークンの数量が、受信者に転送されるようになりました。quantity値が実際の保留値より小さい場合、残りの金額はトークンの所有者が再度使用できます。roles動作がトークン・モデルのbehaviorsセクションで指定され、notary_role_name値が設定されている場合、コール元アカウントにはノータリー・ロールが必要です。それ以外の場合、アカウントを持つすべての発信者が公証人として機能できます。
ペイロード:
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "quantity": 1,
    "endorsers": {{endorsers}}
}
パラメータ:
  • tokenId: string– トークンのID。
  • operationId: string– 承認するミント・リクエストの一意の操作ID。
  • quantity: number– 転送する保留トークンの数。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "c1149aaa486abc4931d9024c18dfcb230bb321723d1160b0bf981c0011c4856a",
        "payload": {
            "msg": "Account Id: oaccount~51e676d7182a02ea7418ef58a6d54ecfe3858ef40b4ffb3d859b320da3921594 (Org-Id: CB, User-Id: issuer_user_cb) is successfully executed '10' tokens from Operation Id '8e3145'."
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 213
    }
}
associateTokenToAccount
元のメソッド名: associateTokenToAccount
このPOSTメソッドは、指定されたアカウントIDを指定されたトークンに関連付けます。Token AdminまたはOrg Adminによってコールできます。
ペイロード:
{
    "accountId": "account_id value",
    "tokenId": "{{bc-token-id}}",
    "endorsers": {{endorsers}}
}
パラメータ:
  • accountId: string– アカウントのID。
  • tokenId: string– トークンのID。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "efc7381fb6fc6174a40e83ff5f09d2bbf7f6f490365e3bbf19d5502c2cfec474",
        "payload": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~1c6aa60e220b8fc70caf4cea1ed723ddb193a00321e5e0004def062816b77090",
            "user_id": "cb12",
            "org_id": "CB",
            "token_type": "fungible",
            "token_id": "USD",
            "token_name": "cbdc",
            "balance": 0,
            "onhold_balance": 0,
            "onhold_burn_balance": 0,
            "max_daily_amount": 10000,
            "daily_amount": 0,
            "max_daily_transactions": 100,
            "daily_transactions": 0,
            "current_date": "2024-12-11T00:00:00.000Z"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 216
    }
}
createAccount
元のメソッド名: createAccount
このメソッドは、指定されたユーザーおよびトークンのアカウントを作成します。任意の時点でトークンを持つすべてのユーザーに対してアカウントを作成する必要があります。アカウントIDは、アセット・タイプとトークンIDを連結してから、組織IDとユーザーIDを連結したSHA-256ハッシュを作成することで形成されます。このメソッドは、チェーンコードのToken Adminまたは指定された組織のOrg Adminによってのみコールできます。
ペイロード:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "tokenType": "fungible",
    "dailyLimits": "{\"max_daily_amount\":10000,\"max_daily_transactions\":100}",
    "endorsers": {{endorsers}}
}
パラメータ:
  • orgId– アカウントを作成するユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。IDは英数字で始める必要があり、文字、数字、およびアンダースコア(_)、ピリオド(.)、アットマーク(@)、ハイフン(-)などの特殊文字を含めることができます。
  • userId– ユーザーのユーザー名または電子メールID。IDは英数字で始める必要があり、文字、数字、およびアンダースコア(_)、ピリオド(.)、アットマーク(@)、ハイフン(-)などの特殊文字を含めることができます。
  • tokenType: TokenType– トークンのタイプ。fungibleである必要があります。
  • daily_limits: DailyLimits– 次のタイプのJSONオブジェクト。
    {
     "max_daily_amount": 100000
     "max_daily_transactions": 10000
 }
    この例では、max_daily_amount値は毎日処理できるトークンの最大量であり、max_daily_transactions値は毎日完了できるトランザクションの最大数です。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "453821c7ffd477987ef8ccbd836b893969531ab768098cd4a99e3b89cd38a391",
        "payload": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~28ac774001f374064029d51af4fb67e26ea1ea9ef62828b7a72dbf3beb8efd8d",
            "user_id": "admin_user_cb",
            "org_id": "CB",
            "token_type": "fungible",
            "token_id": "",
            "token_name": "",
            "balance": 0,
            "onhold_balance": 0,
            "onhold_burn_balance": 0,
            "max_daily_amount": 10000,
            "daily_amount": 0,
            "max_daily_transactions": 100,
            "daily_transactions": 0,
            "current_date": "2024-12-09T00:00:00.000Z"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 188
    }
}
getAccount
元のメソッド名: getAccount
このメソッドは、指定されたユーザーのアカウント詳細を返します。このメソッドは、チェーンコードのToken AdminまたはアカウントのAccount Ownerによってのみコールできます。
Query:
/getAccount?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
パラメータ:
  • tokenId: string– トークンのID。
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "status": "active",
            "account_id": "oaccount~cdc6fa5e64bc29f700f99da69f980d8cbb768c7e1a11dd17274e75651f6afafe",
            "user_id": "admin_user_cb",
            "org_id": "CB",
            "token_type": "fungible",
            "token_id": "USD",
            "token_name": "cbdc",
            "balance": 0,
            "onhold_balance": 0,
            "onhold_burn_balance": 0,
            "max_daily_amount": 10000,
            "daily_amount": 0,
            "max_daily_transactions": 1000,
            "daily_transactions": 0,
            "current_date": "2024-11-20T00:00:00.000Z"
        },
        "encode": "JSON"
    }
}
getAccountBalance
元のメソッド名: getAccountBalance
このGETメソッドは、指定されたアカウントおよびトークンの現在の残高を返します。このメソッドは、アカウントのToken AdminまたはAccountOwnerによってのみコールできます。 
/getAccountBalance?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
パラメータ:
  • tokenId: string– トークンのID。
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Current Balance is: 100",
            "user_balance": 100
        },
        "encode": "JSON"
    }
}
getAccountsByUser
元のメソッド名: getAccountsByUser
このメソッドは、指定されたユーザーのすべてのアカウントのリストを返します。このメソッドは、チェーンコードのToken AdminまたはアカウントのAccount Ownerによってのみコールできます。
Query:
/getAccountsByUser?orgId={{bc-org-id}}&userId={{bc-user-id}}
パラメータ:
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "bapAccountVersion": 0,
                "assetType": "oaccount",
                "account_id": "oaccount~8db15b42910eeec401e1bf22c69dfdd11c820ecc26539ea03a3426fa25cb8c28",
                "user_id": "admin_user_cb",
                "org_id": "CB",
                "token_type": "fungible",
                "token_id": "",
                "token_name": "",
                "balance": 0,
                "onhold_balance": 0,
                "onhold_burn_balance": 0,
                "max_daily_amount": 10000,
                "daily_amount": 0,
                "max_daily_transactions": 1000,
                "daily_transactions": 0,
                "current_date": "2024-11-20T00:00:00.000Z"
            },
            {
                "bapAccountVersion": 0,
                "assetType": "oaccount",
                "account_id": "oaccount~cdc6fa5e64bc29f700f99da69f980d8cbb768c7e1a11dd17274e75651f6afafe",
                "user_id": "admin_user_cb",
                "org_id": "CB",
                "token_type": "fungible",
                "token_id": "USD",
                "token_name": "cbdc",
                "balance": 0,
                "onhold_balance": 0,
                "onhold_burn_balance": 0,
                "max_daily_amount": 10000,
                "daily_amount": 0,
                "max_daily_transactions": 1000,
                "daily_transactions": 0,
                "current_date": "2024-11-20T00:00:00.000Z"
            },
            {
                "bapAccountVersion": 0,
                "assetType": "oaccount",
                "account_id": "oaccount~28ac774001f374064029d51af4fb67e26ea1ea9ef62828b7a72dbf3beb8efd8d",
                "user_id": "admin_user_cb",
                "org_id": "CB",
                "token_type": "fungible",
                "token_id": "",
                "token_name": "",
                "balance": 0,
                "onhold_balance": 0,
                "onhold_burn_balance": 0,
                "max_daily_amount": 10000,
                "daily_amount": 0,
                "max_daily_transactions": 100,
                "daily_transactions": 0,
                "current_date": "2024-12-09T00:00:00.000Z"
            }
        ],
        "encode": "JSON"
    }
}
getAccountTransactionHistory
元のメソッド名: getAccountTransactionHistory
このGETメソッドは、勘定科目トランザクション履歴を返します。このメソッドは、チェーンコードのToken Adminまたはアカウント所有者によってのみコールできます。 
/getAccountTransactionHistory?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
パラメータ:
  • tokenId: string– トークンのID。
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "transaction_id": "otransaction~64c5a4830949eae1424600f3d4a438c6f603a7c3ea31a68e374b899803999e22",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:37:28.000Z",
                "balance": 550,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REJECT_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~a4537ef34a955b023b7c205b9abf06a6c79e4fdd761fb24f41b8eb34126b66c0",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:36:32.000Z",
                "balance": 550,
                "onhold_balance": 10,
                "token_id": "USD",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "APPROVE_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~6237a759422bd9fb112742e8cd7e6450df5a74a32236d9b1005571afed8904a4",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:36:18.000Z",
                "balance": 540,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REQUEST_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~06b35071415d74aa1a7c18449149c937d886cae76a832c44cf8d98e84586e76e",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:35:46.000Z",
                "balance": 540,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REQUEST_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            }
        ],
        "encode": "JSON"
    }
}
getAccountTransactionHistoryWithFiltersFromRichHistDB
元のメソッド名: getAccountTransactionHistoryWithFiltersFromRichHistDB
このメソッドは、リッチ履歴データベースから勘定科目トランザクション履歴詳細を返します。このメソッドは、アカウントのToken AdminまたはAccountOwnerのみがコールできます。この方法を使用する前に、卸売CBDCのOracle Databaseビュー定義の説明に従って、Oracle REST Data Services (ORDS)およびOAuthを有効にしてOracle Autonomous Databaseを実行する必要があります。 
/getAccountTransactionHistoryWithFiltersFromRichHistDB?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}&customEndpoint=custom_endpoint value&bearerToken=bearer_token value&filters={"pageSize":20,"bookmark":"","startTime":"2022-01-16T15:16:36+00:00","endTime":"2022-01-17T15:16:36+00:00"}
パラメータ:
  • tokenId: string– トークンのID。
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
  • customEndpoint– トランザクション履歴をフェッチするリッチ履歴データベースのRESTfulサービス・エンドポイント。
  • bearerToken– リクエストが認可されていることを確認するためにRESTfulエンドポイントをコールするために使用するトークン。
  • filters: string– オプション・パラメータ。空の場合は、すべてのレコードが返されます。PageSizeプロパティは、戻すレコード数を決定します。PageSizeが0の場合、デフォルトのページ・サイズは20です。Bookmarkプロパティは、返されるレコードの開始索引を決定します。StartTimeおよびEndTimeプロパティは、RFC-3339形式で指定する必要があります。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "transaction_id": "otransaction~64c5a4830949eae1424600f3d4a438c6f603a7c3ea31a68e374b899803999e22",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:37:28.000Z",
                "balance": 550,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REJECT_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~a4537ef34a955b023b7c205b9abf06a6c79e4fdd761fb24f41b8eb34126b66c0",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:36:32.000Z",
                "balance": 550,
                "onhold_balance": 10,
                "token_id": "USD",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "APPROVE_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~6237a759422bd9fb112742e8cd7e6450df5a74a32236d9b1005571afed8904a4",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:36:18.000Z",
                "balance": 540,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REQUEST_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            },
            {
                "transaction_id": "otransaction~06b35071415d74aa1a7c18449149c937d886cae76a832c44cf8d98e84586e76e",
                "transacted_amount": 10,
                "timestamp": "2024-12-11T13:35:46.000Z",
                "balance": 540,
                "onhold_balance": 10,
                "token_id": "USD",
                "category": "category value",
                "description": "description value",
                "transacted_account": "oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0",
                "transaction_type": "REQUEST_MINT",
                "transacted_org_id": "CB",
                "transacted_user_id'": "creator_user_cb"
            }
        ],
        "encode": "JSON"
    }
}
getNetTokens
元のメソッド名: getNetTokens
このGETメソッドは、指定されたトークンに対してシステムで使用可能なトークンの合計正味数を返します。ネット・トークンの合計は、トークンの書込み後に残っているトークンの量です。このメソッドは、チェーンコードのToken Adminまたは指定された組織のOrg Adminによってのみコールできます。 
/getNetCBDCTokens?tokenId={{bc-token-id}}
パラメータ:
  • tokenId: string– トークンのID。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Net supply of token for Token Id: USD is 878 tokens.",
            "quantity": 878
        },
        "encode": "JSON"
    }
}
getOnHoldIds
元のメソッド名: getOnHoldIds
このGETメソッドは、指定されたユーザーおよびトークンのすべての保持IDのリストを返します。このメソッドは、アカウントのToken Admin、Org AdminまたはAccountOwnerによってのみコールできます。 
/getOnHoldIds?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
パラメータ:
  • tokenId: string– トークンのID。
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Holding Ids are: ohold~cbdc~USD~8e3147,ohold~cbdc~USD~8e315",
            "holding_ids": [
                "ohold~cbdc~USD~8e3147",
                "ohold~cbdc~USD~8e315"
            ]
        },
        "encode": "JSON"
    }
}
getTotalMintedTokens
元のメソッド名: getTotalMintedTokens
このGETメソッドは、指定されたトークンのミント・トークンの合計数を返します。このメソッドは、Token AdminまたはOrg Adminによってのみコールできます。
Query:
/getTotalMintedTokens?tokenId={{bc-token-id}}
パラメータ:
  • tokenId: string– トークンのID。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "msg": "Total minted token for Token Id: USD is 910 tokens.",
            "quantity": 910
        },
        "encode": "JSON"
    }
}
getUserByAccountId
元のメソッド名: getUserByAccountId
このGETメソッドは、指定されたアカウントのユーザー詳細を返します。このメソッドは、Token Admin、Token AuditorまたはOrg Auditorによってコールできます。
Query:
/getUserByAccountId?accountId=account_id value
パラメータ:
  • accountId: string– アカウントのID。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "token_id": "USD",
            "user_id": "admin_user_cb",
            "org_id": "CB"
        },
        "encode": "JSON"
    }
}
getUsersByRole
元のメソッド名: getUsersByRole
このメソッドは、指定されたロールおよびトークンのすべてのユーザーのリストを返します。このメソッドは、Token Adminによってのみコールできます。 
/getUsersByRole?tokenId={{bc-token-id}}&role=role value (for example minter / burner / notary)
パラメータ:
  • tokenId: string– トークンのID。
  • role: string– 検索するロールの名前。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "users": [
                {
                    "token_id": "USD",
                    "user_id": "creator_user_cb",
                    "org_id": "CB"
                },
                {
                    "token_id": "USD",
                    "user_id": "cb4",
                    "org_id": "CB"
                }
            ]
        },
        "encode": "JSON"
    }
}
holdTokens
元のメソッド名: holdTokens
このメソッドは、to_account_idアカウントを持つトークンの所有者のかわりに保留を作成します。保留の完了またはリリースを担当する公証勘定が指定されています。保留が作成されると、支払人から指定されたトークン残高が保留になります。保留残高は、保留が完了またはリリースされるまで転送できません。このメソッドのコール元には、すでにアカウントが作成されている必要があります。
ペイロード:
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "toOrgId": "to_org_id value",
    "toUserId": "to_user_id value",
    "notaryOrgId": "notary_org_id value",
    "notaryUserId": "notary_user_id value",
    "quantity": 1,
    "timeToExpiration": "time_to_expiration value",
    "infoDetails": "{\"category\":\"category value\",\"description\":\"description value\"}",
    "endorsers": {{endorsers}}
}
パラメータ:
  • tokenId: string– トークンのID。
  • operationId: string– 保留操作を識別する一意のID。通常、このIDはクライアント・アプリケーションによって渡されます。
  • toOrgId: string– 現在の組織内の受信者のメンバーシップ・サービス・プロバイダ(MSP)ID。
  • toUserId: string– 受信者のユーザー名または電子メールID。
  • notaryOrgId: string– 現在の組織の公証人のメンバーシップ・サービス・プロバイダ(MSP)ID。
  • notaryUserId: string– 公証人のユーザー名または電子メールID。
  • quantity: number– 保留にするトークンの数。
  • timeToExpiration– 保留が失効する時間。永続的な保留の場合は 0を指定します。それ以外の場合は、RFC-3339形式を使用します。たとえば、2021-06-02T12:46:06Zです。
  • infoDetails: JSON– 次の例に示す説明とカテゴリ。
    {
   "category" : "category input",
   "description" : "description input"
}
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e575d339299bb98afe83207e749cd07654f209673c84c6973738b6094da33062",
        "payload": {
            "msg": "AccountId oaccount~51e676d7182a02ea7418ef58a6d54ecfe3858ef40b4ffb3d859b320da3921594 (Org-Id: CB , User-Id: issuer_user_cb) is successfully holding 10 tokens"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 211
    }
}
init
元のメソッド名: init
このメソッドは、チェーンコードがデプロイされるときにコールされます。ユーザー情報は、チェーンコードのToken Adminとして保存されます。
ペイロード:
{
    "adminList": "[{\"org_id\":\"{{bc-org-id}}\",\"user_id\":\"{{bc-admin-user}}\"}]"
}
パラメータ:
  • adminList array– トークン管理者のリストを指定する{user_id, org_id}情報の配列。adminList配列は必須パラメータです。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "fdb7dc89832c8045a333823b77fa24ae628178148dc93b3550040e070d7cd807",
        "payload": "",
        "encode": "UTF-8",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 263
    }
}
initializeDepositToken
元のメソッド名: initializeDepositToken
このメソッドはトークンを作成し、トークン・プロパティを初期化します。アセットとそのプロパティは、状態データベースに保存されます。このメソッドは、チェーンコードのToken Adminのみがコールできます。
ペイロード:
{
    "tokenAsset": "{\"token_id\":\"{{bc-token-id}}\",\"token_desc\":\"token_desc value\"}",
    "sameOrgEndorser": true
}
パラメータ:
  • tokenAsset: <Token Class>– トークン・アセットがこのメソッドにパラメータとして渡されます。トークン・アセットのプロパティは、モデル・ファイルに記述されています。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値:
  • 成功すると、作成されたトークン・アセットのJSON表現。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "aa7a4f4cc214e1a041a5a6fb7ca7530f08256559e538c9f9582e6fd12c9e65c8",
        "payload": {
            "assetType": "otoken",
            "events": false,
            "token_id": "t1",
            "token_name": "cbdc",
            "token_desc": "token_desc value",
            "token_standard": "ttf+",
            "token_type": "fungible",
            "token_unit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "holdable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner",
                "notary_role_name": "notary",
                "mint_approver_role_name": "notary",
                "burn_approver_role_name": "notary"
            },
            "mintable": {
                "max_mint_quantity": 1000,
                "mint_approval_required": true
            },
            "burnable": {
                "burn_approval_required": true
            },
            "divisible": {
                "decimal": 2
            },
            "token_to_currency_ratio": 999
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 267
    }
}
getAccountHistory
元のメソッド名: getAccountHistory
このGETメソッドは、指定されたユーザーおよびトークンのアカウント履歴の詳細を返します。
Query:
/getAccountHistory?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
パラメータ:
  • tokenId: string– トークンのID。
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
              "trxId":"2gsdh17fff222467e5667be042e33ce18e804b3e065cca15de306f837e416d7c3e",
              "timeStamp":1629718288,
              "value":{
                 "assetType":"oaccount",
                 "account_id":"oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
                 "user_id":"user1",
                 "org_id":"Org1MSP",
                 "token_id":"digiCurr101",
                 "token_name":"digicur",
                 "balance":100,
                 "onhold_balance":0,
                 "bapAccountVersion": 1
           },
           {
              "trxId":"9fd07fff222467e5667be042e33ce18e804b3e065cca15de306f837e416d7c3e",
              "timeStamp":1629718288,
              "value":{
                 "assetType":"oaccount",
                 "account_id":"oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
                 "user_id":"user1",
                 "org_id":"Org1MSP",
                 "token_id":"digiCurr101",
                 "token_name":"digicur",
                 "balance":0,
                 "onhold_balance":0,
                 "bapAccountVersion": 0
              }
           }
        ],
        "encode": "JSON"
    }
}
rejectMint
元のメソッド名: rejectMint
このメソッドは、指名リクエストを拒否するために公証人が呼び出すことができます。
ペイロード:
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "sameOrgEndorser": true
}
パラメータ:
  • token_id: string– ミントを拒否するトークンのID。
  • operation_id: string–mintリクエストを表す一意の操作ID。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "64c5a4830949eae1424600f3d4a438c6f603a7c3ea31a68e374b899803999e22",
        "payload": {
            "msg": "Successfully rejected mint request with Operation Id 'op1234' to mint 10 tokens of token id USD"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 205
    }
}
releaseHoldTokens
元のメソッド名: releaseHoldTokens
このPOSTメソッドは、トークンの保留を解除します。転送が完了しておらず、すべての保留トークンは元の所有者が再度使用できます。
ペイロード:
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "endorsers": {{endorsers}}
}
パラメータ:
  • token_id: string– トークンのID。
  • operation_id: string– 保留操作を識別する一意のID。通常、このIDはクライアント・アプリケーションによって渡されます。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "f04ba8895d52bc636d843f88476002bc99d01480c36be87c8fa259cd47a29380",
        "payload": {
            "msg": "Successfully released '10' tokens from Operation Id '8e3144' to Account Id: oaccount~51e676d7182a02ea7418ef58a6d54ecfe3858ef40b4ffb3d859b320da3921594 (Org-Id: CB, User-Id: issuer_user_cb)."
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 214
    }
}
removeTokenAdmin
元のメソッド名: removeTokenAdmin
このPOSTメソッドは、チェーンコードのToken Adminとしてユーザーを削除します。このメソッドをコールできるのは、チェーンコードのToken Adminのみです。管理者は自分自身を削除できません。
ペイロード:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
パラメータ:
  • org_id: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • user_id: string– ユーザーのユーザー名または電子メールID。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "6a3b9b568d04b5beb29830f91efe4e8c6310b6cf36940cecfb4ab690fbfde739",
        "payload": {
            "msg": "Successfully removed Token Admin (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 218
    }
}
removeTokenAuditor
元のメソッド名: removeTokenAuditor
このPOSTメソッドは、チェーンコードのToken Auditorとしてユーザーを削除します。このメソッドをコールできるのは、チェーンコードのToken Adminのみです。
ペイロード:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
パラメータ:
  • org_id: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • user_id: string– ユーザーのユーザー名または電子メールID。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "a886a6040fbc76374a3c78c89ab0ffc9f7b8391cc5239b169bf3b878cf40c67b",
        "payload": {
            "msg": "Successfully removed Token Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 219
    }
}
removeOrgAdmin
元のメソッド名: removeOrgAdmin
このPOSTメソッドは、チェーンコードのOrg Adminとしてユーザーを削除します。このメソッドは、指定した組織のToken AdminまたはOrg Adminによってのみコールできます。
ペイロード:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
パラメータ:
  • org_id: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • user_id: string– ユーザーのユーザー名または電子メールID。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e2a634f6093f89b1984e20ff86a513fabb7c3ade7cc9e27d9734b4aaf6c88597",
        "payload": {
            "msg": "Successfully removed Org Admin (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 220
    }
}
removeOrgAuditor
元のメソッド名: removeOrgAuditor
このPOSTメソッドは、チェーンコードのOrg Auditorとしてユーザーを削除します。このメソッドは、指定した組織のToken AdminまたはOrg Adminによってのみコールできます。
ペイロード:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
パラメータ:
  • org_id: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • user_id: string– ユーザーのユーザー名または電子メールID。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "c3bc720461004a53b37c68d4bb264858b88d980bc093a0a3ebb62a32974fb306",
        "payload": {
            "msg": "Successfully removed Org Auditor (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 221
    }
}
removeRole
元のメソッド名: removeRole
このメソッドは、指定されたユーザーからロールを削除します。このメソッドは、チェーンコードのToken Adminまたは指定された組織のOrg Adminによってのみコールできます。
ペイロード:
{
    "tokenId": "{{bc-token-id}}",
    "role": "role value (for example minter / burner / notary)",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
パラメータ:
  • tokenId: string– トークンのID。
  • role: string– 指定したユーザーから削除するロールの名前。mintableおよびburnableの動作は、仕様ファイルのminter_role_nameおよびburner_role_nameプロパティに対応します。
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "274f0d0a2c4c3929817fb85b2e857519695c3c238ccf9903b084b87e9be7ee12",
        "payload": {
            "msg": "Successfully removed role 'notary' from Account Id: oaccount~2eb5f8a9bc561f8f41a4ea3be9511958cc6684ef14f2337ca396efc301b627d8 (Org-Id: CB, User-Id: manager_user_cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 200
    }
}
requestMint
元のメソッド名: requestMint
このメソッドは、指定された量のトークンを作成するリクエストを公証人に送信するために、minterからコールできます。
ペイロード:
{
    "tokenId": "{{bc-token-id}}",
    "operationId": "operation_id value",
    "notaryOrgId": "notary_org_id value",
    "notaryUserId": "notary_user_id value",
    "quantity": 1,
    "timeToExpiration": "time_to_expiration value",
    "infoDetails": "{\"category\":\"category value\",\"description\":\"description value\"}",
    "sameOrgEndorser": true
}
パラメータ:
  • tokenId: string–mintへのトークンのID。
  • operationId: string–mintリクエストを表す一意の操作ID。
  • notaryOrgId: string– リクエストを処理するミナー公証人のメンバーシップ・サービス・プロバイダ(MSP)ID。
  • notaryUserId: string– リクエストを処理する鉱夫のユーザー名または電子メールID。
  • quantity: number–mintへのトークンの量。
  • timeToExpiration– ミント・リクエストが期限切れになり、有効ではなくなった時間。
  • infoDetails: JSON– 次の例に示すように、リクエストのカテゴリ(category)および説明(description)を指定するオブジェクト。
    {
     "category" : "category input",
     "description" : "description input"
}
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "06b35071415d74aa1a7c18449149c937d886cae76a832c44cf8d98e84586e76e",
        "payload": {
            "msg": "AccountId oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0 (Org-Id: CB , User-Id: creator_user_cb) has successfully submitted request to mint 10 tokens"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 202
    }
}
burnTokens
元のメソッド名: burnTokens
このPOSTメソッドは、トランザクション・コール元のアカウントからトークンを非アクティブ化またはバーンします。このメソッドのコール元には、アカウントとバーナー・ロールが必要です。数量は、仕様ファイルのdivisible動作のdecimalパラメータで指定された10進数値内にする必要があります。このメソッドは、バーナー・ロールを持つアカウントのAccountOwnerによってコールできます。
ペイロード:
{
    "tokenId": "{{bc-token-id}}",
    "quantity": 1,
    "infoDetails": "{\"category\":\"category value\",\"description\":\"description value\"}",
    "sameOrgEndorser": true
}
パラメータ:
  • tokenId: string– トークンのID。
  • quantity– 書き込むトークンの数。
  • infoDetails: JSON– 次の例に示すように、リクエストのカテゴリ(category)および説明(description)を指定するオブジェクト。
    {
     "category" : "category input",
     "description" : "description input"
}
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値:
  • 成功すると、トークンの数量とアカウントIDを含む成功メッセージが表示されます。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "aff0b2dbb163ec8076747525db81fbe8f678ac88a277c5f234337f0747eb1a8d",
        "payload": {
            "msg": "Successfully burned 10 tokens from account id: oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0 (Org-Id: CB, User-Id: creator_user_cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 96
    }
}
setMaxDailyAmount
元のメソッド名: setMaxDailyAmount
このPOSTメソッドは、指定された金額のアカウント詳細のmaxDailyAmountパラメータを設定するために使用します。このメソッドは、チェーンコードのToken Adminまたは指定された組織のOrg Adminによってのみコールできます。
ペイロード:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "tokenId": "{{bc-token-id}}",
    "maxDailyAmount": 1,
    "endorsers": {{endorsers}}
}
パラメータ:
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
  • tokenId: string– トークンのID。
  • maxDailyAmount: number– 指定したアカウントの最大日次金額値。毎日処理できる最大金額を定義します。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "28682e0564e4721b6c1a8ec106f8c5c98319e9439959dbb9f83d8e6f111d9975",
        "payload": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~cdc6fa5e64bc29f700f99da69f980d8cbb768c7e1a11dd17274e75651f6afafe",
            "user_id": "admin_user_cb",
            "org_id": "CB",
            "token_type": "fungible",
            "token_id": "USD",
            "token_name": "cbdc",
            "balance": 0,
            "onhold_balance": 0,
            "onhold_burn_balance": 0,
            "max_daily_amount": 10000,
            "daily_amount": 0,
            "max_daily_transactions": 1000,
            "daily_transactions": 0,
            "current_date": "2024-11-20T00:00:00.000Z"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 222
    }
}
setMaxDailyTransactionCount
元のメソッド名: setMaxDailyTransactionCount
このPOSTメソッドは、指定された金額のアカウント詳細のmaxDailyTransactionsパラメータを設定するために使用します。このメソッドは、チェーンコードのToken Adminまたは指定された組織のOrg Adminによってのみコールできます。
ペイロード:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "tokenId": "{{bc-token-id}}",
    "maxDailyTransactions": 1,
    "endorsers": {{endorsers}}
}
パラメータ:
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
  • tokenId: string– トークンのID。
  • maxDailyTransactions: number–1日当たりに許可されるトランザクションの最大数を定義する、指定されたアカウントの最大日次金額値。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "8b6fb01de697562ee098110054f05d4a314933bd11ef471991cb43e25b68bad9",
        "payload": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~cdc6fa5e64bc29f700f99da69f980d8cbb768c7e1a11dd17274e75651f6afafe",
            "user_id": "admin_user_cb",
            "org_id": "CB",
            "token_type": "fungible",
            "token_id": "USD",
            "token_name": "cbdc",
            "balance": 0,
            "onhold_balance": 0,
            "onhold_burn_balance": 0,
            "max_daily_amount": 10000,
            "daily_amount": 0,
            "max_daily_transactions": 1000,
            "daily_transactions": 0,
            "current_date": "2024-11-20T00:00:00.000Z"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20010",
        "blockNumber": 223
    }
}
suspendAccount
元のメソッド名: suspendAccount
このメソッドは、真菌可能なトークン・アカウントを一時停止します。accountStatus値がレジャーで見つからない場合、エラーがスローされます。このメソッドは、チェーンコードのToken Adminまたは指定された組織のOrg Adminによってのみコールできます。
ペイロード:
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
パラメータ:
  • tokenId: string– トークンのID。
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e21d91d98091df77f90105d84074c0b802b01fc97a6b1304247774397fed1294",
        "payload": {
            "assetType": "oaccountStatus",
            "status_id": "oaccountStatus~d5814d96d8517ac31727d60aace0519c58a425892ab0d378fcfb0a35771f65ae",
            "account_id": "oaccount~802bf8da5579c6103b2dddaa6c4385df8e722d639a18029e0e93d7a5d6f826d6",
            "status": "suspended"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 195
    }
}
transferTokens
元のメソッド名: transferTokens
このメソッドは、トークンをコール元から指定されたアカウントに転送します。メソッドのコール元にはアカウントが必要です。数量は、仕様ファイルのdivisible動作のdecimalパラメータで指定された10進数値内にする必要があります。
ペイロード:
{
    "tokenId": "{{bc-token-id}}",
    "toOrgId": "to_org_id value",
    "toUserId": "to_user_id value",
    "quantity": 1,
    "infoDetails": "{\"category\":\"category value\",\"description\":\"description value\"}",
    "endorsers": {{endorsers}}
}
パラメータ:
  • tokenId: string– トークンのID。
  • toOrgId: string– 現在の組織内の受信者(受取人)のメンバーシップ・サービス・プロバイダ(MSP)ID。
  • toUserId: string– 受信者のユーザー名または電子メールID。
  • quantity: number– 転送するトークンの数。
  • infoDetails: JSON– 次の例に示すように、リクエストのカテゴリ(category)および説明(description)を指定するオブジェクト。
    {
     "category" : "category input",
     "description" : "description input"
}
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "d613b2494b965811b2fa2106152b7085f2d6d7d43e949b10b8668722d3636fe7",
        "payload": {
            "msg": "Successfully transferred 10 tokens from account id: oaccount~9d9806fa92aa0c4fdb34eaffac6e830181b5d47e64fbce752195e83024125ca0 (Org-Id: CB, User-Id: creator_user_cb) to account id: oaccount~51e676d7182a02ea7418ef58a6d54ecfe3858ef40b4ffb3d859b320da3921594 (Org-Id: CB, User-Id: issuer_user_cb). Only 999 number of transactions and 1990 amount transfer left for today: 12/11/2024"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 224
    }
}
initializeExchangePoolUser
元のメソッド名: initializeExchangePoolUser
このメソッドは、交換プール・ユーザー(1回かぎりのアクティビティ)を初期化します。このメソッドは、Token Adminによってのみコールできます。
ペイロード:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}
パラメータ:
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e21d91d98091df77f90105d84074c0b802b01fc97a6b1304247774397fed1294",
        "payload": {
            "assetType": "oconversion",
            "convertor_id": "bcb1f3b1442c625d3ce205660c5e717c5858a1fe1e12c325df799a851ceaa09b",
            "org_id": "Org1MSP",
            "user_id": "exchangepooluser"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 196
    }
}
createExchangePoolAccounts
元のメソッド名: createExchangePoolAccounts
このメソッドは、トークンIDの指定された配列の交換プールトークンアカウントを作成します。このメソッドをコールできるのは、チェーンコードのToken Adminのみです。
ペイロード:
{
    "tokenIds": "[{{bc-token-id}}]",
    "sameOrgEndorser": true
}
パラメータ:
  • token_ids: string []– トークンIDの配列。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e21d91d98091df77f90105d84074c0b802b01fc97a6b1304247774397fed1294",
        "payload": [
            {
                "account_id": "oaccount~cc9d84f6d4a5976532493ef5200c9603e138adc35166ffd5fd1aad9c1647f034",
                "token_id": "USD",
                "status": "created"
            },
            {
                "account_id": "oaccount~3d4933111ec8bd6cc1ebb43f2b2c390deb929cfa534f9c6ada8e63bac04a13c0",
                "token_id": "INR",
                "status": "created"
            }
        ],
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 197
    }
}
addConversionRate
元のメソッド名: addConversionRate
このメソッドは、トークンのペアの換算レートを追加します。トークン換算レートは、小数点以下8桁まで指定できます。このメソッドをコールできるのは、チェーンコードのToken Adminのみです。
ペイロード:
{
    "fromTokenId": "from_token_id value",
    "toTokenId": "to_token_id value",
    "tokenConversionRate": 10,
    "sameOrgEndorser": true
}
パラメータ:
  • fromTokenId: string– 変換元のトークンのID。
  • toTokenId: string– 変換先のトークンのID。
  • tokenConversionRate: number– fromTokenIdトークンをtoTokenIdトークンに変換するレート。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e21d91d98091df77f90105d84074c0b802b01fc97a6b1304247774397fed1294",
        "payload": {
          "assetType": "oconversionRate",
          "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
          "from_token_id": "USD",
          "to_token_id": "INR",
          "conversion_rate": 10
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 189
    }
}
updateConversionRate
元のメソッド名: updateConversionRate
このメソッドは、トークンのペアの現在の換算レートを更新します。トークン換算レートは、小数点以下8桁まで指定できます。このメソッドをコールできるのは、チェーンコードのToken Adminのみです。
ペイロード:
{
    "fromTokenId": "from_token_id value",
    "toTokenId": "to_token_id value",
    "tokenConversionRate": 20,
    "sameOrgEndorser": true
}
パラメータ:
  • fromTokenId: string– 変換元のトークンのID。
  • toTokenId: string– 変換先のトークンのID。
  • tokenConversionRate: number– fromTokenIdトークンをtoTokenIdトークンに変換するレート。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e21d91d98091df77f90105d84074c0b802b01fc97a6b1304247774397fed1294",
        "payload": {
          "assetType": "oconversionRate",
          "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
          "from_token_id": "USD",
          "to_token_id": "INR",
          "conversion_rate": 20
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 208
    }
}
mintWithFundingExchangePool
元のメソッド名: mintWithFundingExchangePool
このメソッドは、指定されたトークンIDおよび数量に基づいて、コール元のアカウント内のトークンをミントします。次に、ミント数量からのトークンの割合が交換プール・トークン・アカウントに転送されます。
{
    "tokenId": "{{bc-token-id}}",
    "tokenQuantity": 100,
    "percentageTokenToExchangePool": 20,
    "sameOrgEndorser": true
}
パラメータ:
  • tokenId: string–mintへのトークンのID。
  • tokenQuantity: number–mintへのトークンの合計数。
  • percentageTokenToExchangePool: number– 交換プール・トークン・アカウントに転送するミント・トークンの割合。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e21d91d98091df77f90105d84074c0b802b01fc97a6b1304247774397fed1294",
        "payload": {
            "msg": "Successfully minted 100 tokens to Account Id: oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb (Org-Id: Org1MSP, User-Id: admin) and Successfully transfered 20 tokens to exchange pool Account with Account Id: oaccount~cc9d84f6d4a5976532493ef5200c9603e138adc35166ffd5fd1aad9c1647f034 (Org-Id: Org1MSP, User-Id: exchangepooluser) "
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 209
    }
}
tokenConversion
元のメソッド名: tokenConversion
このメソッドは、コール元のアカウントから、to_token_id、to_org_idおよびto_user_idの値で指定されたアカウントにトークンを変換します。このメソッドは、チェーンコードのToken Adminおよび任意のトークン・アカウント所有者によってコールできます。交換プール・ユーザーはこのメソッドをコールできません。 
{
    "fromTokenId": "from_token_id value",
    "toTokenId": "to_token_id value",
    "toOrgId": "to_org_id value",
    "toUserId": "to_user_id value",
    "tokenQuantity": 5,
    "endorsers": {{endorsers}}
}
パラメータ:
  • fromTokenId: string– 変換元のトークンのID。
  • toTokenId: string– 変換先のトークンのID。
  • toOrgId: string– トークンを受信する現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • toUserId: string– トークンを受信するユーザーのユーザー名または電子メールID。
  • tokenQuantity: number– 転送するトークンの合計数。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "e21d91d98091df77f90105d84074c0b802b01fc97a6b1304247774397fed1294",
        "payload": {
            "msg": "Succesfully converted 5 of tokens with tokenId: [USD] from AccountId: oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb (Org-Id: Org1MSP, User-Id: admin) to 100 of tokens with tokenId: [INR] to AccountId: oaccount~25e2e66718b6dbb59aea9c32acebec60e09d912b2578d4933d377ae5d0628f1e (Org-Id: Org1MSP, User-Id: user) as per the conversion rate of 20"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 213
    }
}
getConversionRate
元のメソッド名: getConversionRate
このGETメソッドは、トークンのペアの現在の換算レートを取得します。このメソッドは、Token Admin、Token Auditor、Org AdminまたはOrg Auditorによってコールできます。
Query:
/getConversionRate?fromTokenId=from_token_id value&toTokenId=to_token_id value
パラメータ:
  • fromTokenId: string– 変換元のトークンのID。
  • toTokenId: string– 変換先のトークンのID。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
          "assetType": "oconversionRate",
          "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
          "from_token_id": "USD",
          "to_token_id": "INR",
          "conversion_rate": 20
        },
        "encode": "JSON"
    }
}
getConversionHistory
元のメソッド名: getConversionRate
このGETメソッドは、指定されたトークン・アカウントのトークン変換履歴を返します。このメソッドは、Token Admin、Token Auditor、Org Admin、Org Auditorまたはトークン・アカウント所有者によってコールできます。
Query:
/getConversionHistory?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
パラメータ:
  • tokenId: string– トークンのID。
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
          {
            "transaction_id": "otransaction~34edd19e03ec8bbbc77bc3372081410a824a5c10f9aa522b3a6390d7e8cb11cf",
            "from_account_id": "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
            "to_account_id": "oaccount~25e2e66718b6dbb59aea9c32acebec60e09d912b2578d4933d377ae5d0628f1e",
            "transacted_amount": 5,
            "converted_amount": 100,
            "conversion_rate": "20",
            "from_token_id": "USD",
            "to_token_id": "INR",
            "balance": 75,
            "onhold_balance": 0,
            "timestamp": "2022-11-30T11:03:20.000Z",
            "transaction_type": "TOKEN_CONVERSION_DEBIT"
          }
        ],
        "encode": "JSON"
    }
}
getConversionRateHistory
元のメソッド名: getConversionRate
このメソッドは、トークンのペアのトークン換算レート履歴を返します。このメソッドは、Token Admin、Token Auditor、Org Admin、Org Auditorおよび任意のトークン・アカウント所有者によってコールできます。 
/getConversionRateHistory?fromTokenId=from_token_id value&toTokenId=to_token_id value
パラメータ:
  • fromTokenId: string– 換算レートを計算するための変換元のトークンのID。
  • toTokenId: string– 換算レートの計算を目的とした、変換先のトークンのID。
戻り値:
  • 成功すると、換算レート履歴の詳細を含むJSONオブジェクト。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload":  [
          {
            "trxId": "0b1ba7bc2620e1438b6580365e5c0ab852247ccfa5a3eb2157d3baca02c0e521",
            "timeStamp": "2022-11-30T10:23:38.000Z",
            "value": {
              "assetType": "oconversionRate",
              "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
              "from_token_id": "USD",
              "to_token_id": "INR",
              "conversion_rate": 20
            }
          },
          {
            "trxId": "36fc40ddb3d8308ee7e156af700da131d78d941fe390fc57985b7589e7035d5c",
            "timeStamp": "2022-11-30T10:13:18.000Z",
            "value": {
              "assetType": "oconversionRate",
              "conversion_rate_id": "oconversionRate~91c7eeb0614e7a50b1d5ecad559fcbc80b94034648bf405c9491dacf8d57873b",
              "from_token_id": "USD",
              "to_token_id": "INR",
              "conversion_rate": 10
            }
          }
        ],
        "encode": "JSON"
    }
}
getExchangePoolUser
元のメソッド名: getExchangePoolUser
このGETメソッドは、交換プール・ユーザーの組織IDおよびユーザーIDの値を返します。このメソッドは、チェーンコードのToken AdminまたはToken Auditorによってのみコールできます。
Query:
/getExchangePoolUser
パラメータ:
  • なし
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload":  {
           "assetType": "oconversion",
           "convertor_id": "bcb1f3b1442c625d3ce205660c5e717c5858a1fe1e12c325df799a851ceaa09b",
           "org_id": "Org1MSP",
           "user_id": "exchangepooluser"
        },
        "encode": "JSON"
    }
}
getAccountOnHoldBalance
元のメソッド名: getAccountOnHoldBalance
このGETメソッドは、指定されたアカウントおよびトークンの現在の保留残高を返します。このメソッドは、アカウントのToken Admin、Token Auditor、Org Admin、Org AuditorまたはAccountOwnerによってのみコールできます。
Query:
/getAccountOnHoldBalance?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
パラメータ:
  • tokenId: string– トークンのID。
  • orgId: string– 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP)ID。
  • userId: string– ユーザーのユーザー名または電子メールID。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload":  {
            "msg":"Total Holding Balance is: 0","holding_balance":0
        },
        "encode": "JSON"
    }
}
getAccountStatus
元のメソッド名: getAccountStatus
このGETメソッドは、トークン・アカウントの現在のステータスを取得します。このメソッドは、Token Admin、Token Auditor、Org Admin、Org Auditor、またはトークン・アカウント所有者によってコールできます。
Query:
/getAccountStatus?tokenId={{bc-token-id}}&orgId={{bc-org-id}}&userId={{bc-user-id}}
パラメータ:
  • tokenId: string– トークンのID。
  • orgId: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザーのユーザー名または電子メールID。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload":  {
            "assetType": "oaccountStatus",
            "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
            "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
            "status": "active"
        },
        "encode": "JSON"
    }
}
getAccountsByRole
元のメソッド名: getAccountsByRole
このメソッドは、指定されたロールのすべてのアカウントIDのリストを返します。このメソッドをコールできるのは、チェーンコードのToken Adminのみです。
Query:
/getAccountsByRole?tokenId={{bc-token-id}}&role=role value (for example minter / burner / notary)
パラメータ:
  • tokenId: string – トークンのID。
  • role: string– 検索するロールの名前。
戻り値の例:
{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload":  {
            "accounts":["oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f"]
        },
        "encode": "JSON"
    }
}