1. Oracle Blockchain Platformデジタル・アセット・エディション
  2. 汎用トークン・フレームワーク
  3. 結合トークン・フレームワーク
  4. 結合トークン・フレームワーク・ラッパーAPIパッケージ

結合トークン・フレームワーク・ラッパーAPIパッケージ

Oracle Blockchain Platform Digital Assets Editionには、REST APIを拡張して、収集可能なNFTマーケットプレイスに固有の操作をサポートするラッパーAPIパッケージが含まれています。

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

ラッパーAPI

activateAccount
元のメソッド名: activateAccount
このPOSTメソッドは、トークン・アカウントをアクティブ化します。このメソッドをコールできるのは、管理者またはアカウント所有者のみです。accountStatusが元帳に見つからない既存のアカウントの場合、このメソッドは、ステータスがactiveに設定されたaccountStatusオブジェクトを返します。
ペイロード:
{
    "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表現。
戻り値の例:
{
  "assetType": "oaccountStatus",
  "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
  "status": "active"
}
addTokenAdmin
元のメソッド名: addTokenAdmin
このPOSTメソッドは、ユーザーをチェーンコードのToken Adminとして追加します。このメソッドは、チェーンコードのToken Adminのみがコールできます。
ペイロード:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
パラメータ:
  • orgId: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザーのユーザー名または電子メールID。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値:
  • 成功の場合、チェーンコードのToken Adminとして追加されたユーザーの詳細を含むメッセージ。
戻り値の例:
{
  "msg": "Successfully added Admin (OrgId: appDev, UserId: user1)"
}
addRole
元のメソッド名: addRole
このPOSTメソッドは、指定されたユーザーおよびトークンにロールを追加します。このメソッドは、チェーンコードのToken Adminのみがコールできます。tokenDetailsパラメータのFungibleトークンには、入力としてtokenId値が必要です。非真菌性トークンでは、tokenDetailパラメータを使用して真菌性トークンと非真菌性トークンの詳細を異なる方法で指定できるように、入力としてtokenNameが必要です。
ペイロード:
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "role": "role minter/burner"
    "tokenDetails": "{"tokenName": "token name value"}"
    "endorsers": {{endorsers}}
}
パラメータ:
  • tokenId: string – トークンのID。
  • orgId: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザーのユーザー名または電子メールID。
  • role: string – 指定したユーザーに追加するロールの名前。
  • tokenDetails: TokenDetail – トークンを指定する詳細。代替可能トークンの場合は、次の形式を使用します:
    {"tokenId":"token1"}
    非代替トークンの場合は、次の形式を使用します:
    {"tokenName":"artCollection"}
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
  "msg": "Successfully added role 'minter' to Account Id: oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a 
(Org-Id: appdev, User-Id: user2)"
}
associateFungibleTokenToAccount
元のメソッド名: associateFungibleTokenToAccount
このPOSTメソッドは、ユーザーの真菌可能トークン・アカウントを指定されたトークンに関連付けます。
ペイロード:
{
    "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など)。
戻り値の例:
{
  "assetType": "ouaccount",
  "accountId": "ouaccount~24ffd4d32a028a85b4b960f5d55536c837b5429bc7f346150adfa904ec2937cc",
  "userId": "user2",
  "orgId": "appdev",
  "totalAccounts": 1,
  "totalFtAccounts": 1,
  "associatedFtAccounts": [
    {
      "accountId": "oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a",
      "tokenId": "tokenOne"
    }
  ],
  "associatedNftAccount": ""
}
buyWithEthCoin
元のメソッド名: buyWithEthCoin
アカウント所有者は、このPOSTメソッドを使用してEthereumを使用してNFTを購入し、ロイヤルティ・トークンを報酬ポイントとして転送できます。
ペイロード:
{
   "fromOrgId":"from_org_id value",
   "fromUserId":"from_user_id value",
   "toOrgId":"to_org_id value",
   "toUserId":"to_user_id value",
   "nftId":"[\"nft_id value\"]",
   "loyaltyId":"[\"loyalty_id value\"]",
   "ethQty":"[eth_qty value]",
   "loyaltyRewardQuantity":"[loyalty_reward_quantity value]",
   "endorsers":{{"endorsers"}}
}
パラメータ:
  • fromOrgId: string– 現在の組織内の送信者(所有者)のメンバーシップ・サービス・プロバイダ(MSP) ID。
  • fromUserId: string– 送信者(所有者)のユーザー名または電子メールID。
  • toOrgId: string – 現在の組織内の受信者のメンバーシップ・サービス・プロバイダ(MSP) ID。
  • toUserId: string – 受信者のユーザー名または電子メールID。
  • nftId: string– 購入するトークンのID。
  • loyaltyId: string– ロイヤルティ・ポイントを表す真菌可能トークンのID。
  • ethQty: number–Ethereumのトークンの価格。
  • loyaltyRewardQuantity: string– 転送するロイヤルティ・ポイントの数量。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
  "msg": "Token ID : 'artcollection1' has been successfully transferred to UserID : 'user1'"
}
balanceOfBatch
元のメソッド名: balanceOfBatch
このGETメソッドは、トークン・アカウントの残高を取得するバッチ操作を完了します。このメソッドは、チェーンコードのToken Adminまたはアカウント所有者のみがコールできます。
Query:
/balanceOfBatch?orgIds=["{{bc-org-id}}"]&userIds=["{{bc-user-id}}"]&tokenIds=["{{bc-token-id}}"]
パラメータ:
  • orgIds: string[] – 現在の組織のメンバーシップ・サービス・プロバイダ(MSP) IDのリスト。
  • userIds: string[] – ユーザー名または電子メールIDのリスト。
  • tokenIds: string[]– トークンIDのリスト。
戻り値の例:
[
    {
        "orgId": "AppBldFFFFMay22",
        "userId": "user2",
        "userAccountId": "ouaccount~412de5e3998dcd100973e1bad6e8729fddc1c7ff610beab8376d733a35c51f38",
        "tokenAccountId": "oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371",
        "tokenId": "FNFT",
        "balance": 100
    },
    {
        "orgId": "AppBldFFFFMay22",
        "userId": "user2",
        "userAccountId": "ouaccount~412de5e3998dcd100973e1bad6e8729fddc1c7ff610beab8376d733a35c51f38",
        "tokenAccountId": "oaccount~21206f309941a2a23c4f158a0fe1b8f12bb8e2b0c9a2e1358f5efebc0c7d410e",
        "tokenId": "FT",
        "balance": 50
    },
    {
        "orgId": "AppBldFFFFMay22",
        "userId": "example_minter",
        "userAccountId": "ouaccount~9501bb774c156eb8354dfe489250ea91f757523d70f08ee494bda98bb352003b",
        "tokenAccountId": "oaccount~dcee860665db8740cb77b846e823752185a1e9a185814d0acb305890f5903446",
        "tokenId": "FNFT",
        "balance": 10
    }
]
batchTransferFrom
元のメソッド名: batchTransferFrom
このPOSTメソッドは、トークンIDのリストで指定されたトークンを、あるユーザーから別のユーザーに転送するバッチ操作を完了します。このメソッドは、どのユーザーでもコールできます。
ペイロード:
{
 "fromOrgId": "fromOrgId value",
 "fromUserId": "fromUserId value",
 "toOrgId": "toOrgId value",
 "toUserId": "toUserId value",
 "tokenIds": "[\"{{bc-token-id}}\"]",
 "quantity": "[quantity value]",
 "endorsers": {{endorsers}}
}
パラメータ:
  • fromOrgId: string– 送信者のメンバーシップ・サービス・プロバイダ(MSP) ID。
  • fromUserId: string– 送信者のユーザーID。
  • toOrgId: string– 受信者のメンバーシップ・サービス・プロバイダ(MSP) ID。
  • toUserId: string– 受信者のユーザーID。
  • tokenIds: string[] – 転送するトークンのトークンIDのリスト。
  • quantity: number[] – 転送するトークンの数量のリストで、トークンID配列に対応します。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値:
  • 成功の場合、各トークン転送の詳細を含むメッセージ。
戻り値の例:
[
    {
        "msg": "Successfully transferred NFT token: 'FNFT' of '10' quantity from Account-Id: oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371 (Org-Id: AppBldFFFFMay22, User-Id: user2) to Account-Id: oaccount~dcee860665db8740cb77b846e823752185a1e9a185814d0acb305890f5903446 (Org-Id: AppBldFFFFMay22, User-Id: example_minter)"
    },
    {
        "msg": "Successfully transferred 10 FT token: 'FT' from Account-Id: oaccount~21206f309941a2a23c4f158a0fe1b8f12bb8e2b0c9a2e1358f5efebc0c7d410e (Org-Id: AppBldFFFFMay22, User-Id: user2) to Account-Id: oaccount~1089ee5122f367ee0ca38c6660298f4b81f199627e4f67f3691c0f628237974c (Org-Id: AppBldFFFFMay22, User-Id: example_minter)"
    },
    {
        "msg": "Successfully transferred NFT token: 'NFT' from Account-Id: oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371 (Org-Id: AppBldFFFFMay22, User-Id: user2) to Account-Id: oaccount~dcee860665db8740cb77b846e823752185a1e9a185814d0acb305890f5903446 (Org-Id: AppBldFFFFMay22, User-Id: example_minter)"
    }
]
burnBatch
元のメソッド名: burnBatch
このPOSTメソッドは、指定された代替可能トークンおよび非代替トークンを非アクティブ化(バーン)します。バーナー・ロールを持つすべてのユーザーがこのメソッドをコールできます。
ペイロード:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "tokenIds": "[\"{{bc-token-id}}\"]",
 "quantity": "[quantity value]",
 "sameOrgEndorser": true
}
パラメータ:
  • orgId: string – 現在の組織のメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザー名または電子メールID。
  • tokenIds: string[] – バーンするトークンIDのリスト
  • quantity: number[] – バーンするトークンの数量のリストで、トークンID配列に対応します。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値:
  • 成功の場合、バーン操作の詳細を含むメッセージ。
戻り値の例:
[
  {
    "msg": "Successfully burned NFT token: 'art' from Account-Id: oaccount~76cb672eeb1bd535899562a840d0c15a356db89e24bc8b43ac1dba845a4282c6 (Org-Id: appdev, User-Id: user2)"
  },
  {
    "msg": "Successfully burned 5 tokens of tokenId: tokenOne from Account-ID oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a (Org-Id: appdev, User-Id: user2)"
  },
  {
    "msg": "Successfully burned 2 token share of tokenId: FNFT from Account-ID oaccount~87bcb699d507368ee3966cd03ee6d7736ffc55dde8c0f0e16b14866334ac504a (Org-Id: AutoF1377358917, User-Id: user2)"
  }
]
burnNFT
元のメソッド名: burnNFT
このPOSTメソッドは、指定された非代替トークンを非アクティブ化(バーン)し、トークン・オブジェクトおよびトークン履歴を返します。バーナー・ロールを持つすべてのユーザーがこのメソッドをコールできます。
ペイロード:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "tokenId": "{{bc-token-id}}",
 "sameOrgEndorser": true
}
パラメータ:
  • orgId: string – 現在の組織のメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザー名または電子メールID。
  • tokenId: string – バーンする非代替トークンのID
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値:
  • 成功すると、書込み操作に関するメッセージを含むJSON配列。
戻り値の例:
{
    "msg": "Successfully burned NFT token: 'art' from Account-Id: oaccount~76cb672eeb1bd535899562a840d0c15a356db89e24bc8b43ac1dba845a4282c6 (Org-Id: appdev, User-Id: user2)"
  }
createAccount
元のメソッド名: createAccount
このPOSTメソッドは、指定されたユーザーおよび関連するトークン・アカウントのアカウントを、代替可能トークンまたは非代替トークンに対して作成します。任意の時点でトークンを持つすべてのユーザーに対してアカウントを作成する必要があります。ユーザー・アカウントは、ユーザーが保持するNFTアカウントおよび代替可能トークン・アカウントを追跡します。ユーザーは、トークン関連の操作を完了するためにネットワーク内にアカウントを持っている必要があります。このメソッドは、チェーンコードのToken Adminのみがコールできます。

ユーザー・アカウントには、orgIdパラメータおよびuserIdパラメータのSHA-256ハッシュによって形成される一意のIDがあります。

ユーザーは、一意のアカウントIDを持つ複数の代替可能トークン・アカウントを持つことができます。代替可能トークン・アカウントIDは、orgIdパラメータ、userIdパラメータ、チルダ記号(~)で区切られた定数文字列ft、およびチルダ記号(~)で区切られた作成中の代替可能アカウントの索引を示すカウンタ番号のSHA-256ハッシュによって形成されます。

ユーザーが所有できる非代替トークン・アカウントは1つのみです。非代替トークン・アカウントIDは一意であり、orgIdパラメータ、userIdパラメータおよびチルダ記号(~)で区切られた定数文字列nftのSHA-256ハッシュによって形成されます。ユーザーが所有するすべての非代替トークン(ホールまたはフラクショナル)は、このアカウントにリンクされます。

ユーザー・アカウントIDはouaccount~で始まります。トークン・アカウントIDはoaccount~で始まります。

ペイロード:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "ftAccount": true,
 "nftAccount": true,
 "endorsers": {{endorsers}}
}
パラメータ:
  • orgId: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザーのユーザー名または電子メールID。
  • ftAccount: boolean – trueの場合、代替可能トークン・アカウントが作成され、ユーザー・アカウントに関連付けられます。
  • nftAccount: boolean–trueの場合、非代替トークン・アカウントが作成され、ユーザー・アカウントに関連付けられます。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
  "assetType": "ouaccount",
  "accountId": "ouaccount~cf20877546f52687f387e7c91d88b9722c97e1a456cc0484f40c747f7804feae",
  "userId": "user1",
  "orgId": "appdev",
  "totalAccounts": 2,
  "totalFtAccounts": 1,
  "associatedFtAccounts": [
    {
      "accountId": "oaccount~60bb20c14a83f6e426e1437c479c5891e1c6477dfd7ad18b73acac5d80bc504b",
      "tokenId": ""
    }
  ],
  "associatedNftAccount": "oaccount~73c3e835dac6d0a56ca9d8def08269f83cefd59b9d297fe2cdc5a9083828fa58"
}
createArtCollectionToken
元のメソッド名: createArtCollectionToken
このPOSTメソッドは、NFTを作成(分)します。アセットおよび関連するプロパティは、状態データベースに保存されます。このトランザクションのコール元にはトークン・アカウントが必要です。このトランザクションのコール元がNFTの所有者になります。トークン仕様ファイルでbehaviorsにrolesセクションが含まれ、rolesにminter_role_nameプロパティが含まれている場合、トランザクションのコール元にミンター・ロールが必要です。それ以外の場合、どのコール元もNFTをミントできます。
ペイロード:
{
 "tokenAsset": "{\"tokenId\":\"{{bc-token-id}}\",\"tokenDesc\":\"tokenDesc value\",\"tokenUri\":\"tokenUri value\",\"tokenMetadata\":{\"Painting_Name\":\"Painting_Name value\",\"Description\":\"Description value\",\"Painter_Name\":\"Painter_Name value\"},\"Price\":999,\"On_Sale_Flag\":true}",
 "quantity": 1,
 "sameOrgEndorser": true
}
パラメータ:
  • tokenAsset: <Token Class> – ミントするトークン・アセット。トークン・アセットのプロパティの詳細は、入力仕様ファイルを参照してください。
  • quantity: number – ミントするトークンの合計数。このパラメータでサポートされている値は、1のみです。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値の例:
{
            "tokenMetadata": {
                "ISIN": "ISIN value",
                "Segment": "Segment value",
                "Issuer": "Issuer value",
                "FaceValue": 999,
                "IssueSize": 999,
                "CouponRate": 999,
                "InterestPaymentType": "simple",
                "InterestFrequency": "monthly",
                "IssueDate": "2023-03-28T15:16:36.000Z",
                "MaturityDate": "2023-03-28T15:16:36.000Z"
            },
            "assetType": "otoken",
            "events": false,
            "tokenId": "token2",
            "tokenName": "bond",
            "tokenDesc": "tokenDesc value",
            "tokenStandard": "erc1155+",
            "tokenType": "nonfungible",
            "tokenUnit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner"
            },
            "mintable": {
                "max_mint_quantity": 0
            },
            "quantity": 10,
            "createdBy": "oaccount~85dfd98d1b99e5b8891e0a0fdcd7d2e07fc5d37958f5d2a5796290b6a9204a43",
            "creationDate": "2024-12-03T12:07:24.000Z",
            "divisible": {
                "decimal": 0
            },
            "isBurned": false,
            "isLocked": false,
            "tokenUri": "tokenUri value",
            "status": "created"
}
createLoyaltyToken
元のメソッド名: createLoyaltyToken
このPOSTメソッドはトークンを作成します。定義されているすべてのトークンには、独自の作成メソッドがあります。このメソッドは、チェーンコードのToken Adminのみがコールできます。
ペイロード:
{
 "tokenAsset": "{\"tokenId\":\"{{bc-token-id}}\",\"tokenDesc\":\"tokenDesc value\",\"Token_Name\":\"Token_Name value\",\"Token_to_Currency_Ratio\":999}",
 "sameOrgEndorser": true
}
パラメータ:
  • tokenAsset: <Token Class> – トークン・アセット。アセットのプロパティは、モデル・ファイルで定義されます。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値の例:
{
            "assetType": "otoken",
            "events": false,
            "tokenId": "token2",
            "tokenName": "loyalty",
            "tokenDesc": "tokenDesc value",
            "tokenStandard": "erc1155+",
            "tokenType": "fungible",
            "tokenUnit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner"
            },
            "mintable": {
                "max_mint_quantity": 0
            },
            "quantity": 10,
            "createdBy": "oaccount~85dfd98d1b99e5b8891e0a0fdcd7d2e07fc5d37958f5d2a5796290b6a9204a43",
            "creationDate": "2024-12-03T12:07:24.000Z",
            "divisible": {
                "decimal": 0
            },
            "isBurned": false,
            "isLocked": false,
            "tokenUri": "tokenUri value",
            "status": "created"
}
createTokenAccount
元のメソッド名: createTokenAccount
このPOSTメソッドは、ユーザー・アカウントに関連付ける代替可能または非代替トークン・アカウントを作成します。

ユーザーは、一意のアカウントIDを持つ複数の代替可能トークン・アカウントを持つことができます。代替可能トークン・アカウントIDは、orgIdパラメータ、userIdパラメータ、チルダ記号(~)で区切られた定数文字列ft、およびチルダ記号(~)で区切られた作成中の代替可能アカウントの索引を示すカウンタ番号のSHA-256ハッシュによって形成されます。

ユーザーが所有できる非代替トークン・アカウントは1つのみです。非代替トークン・アカウントIDは一意であり、orgIdパラメータ、userIdパラメータおよびチルダ記号(~)で区切られた定数文字列nftのSHA-256ハッシュによって形成されます。ユーザーが所有するすべての非代替トークン(ホールまたはフラクショナル)は、このアカウントにリンクされます。

このメソッドは、チェーンコードのToken Adminのみがコールできます。

ペイロード:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "tokenType": "nonfungible",
 "endorsers": {{endorsers}}
}
パラメータ:
  • orgId: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザーのユーザー名または電子メールID。
  • tokenType: TokenType – 作成するトークン・アカウントのタイプ。サポートされているトークン・タイプは、nonfungibleおよびfungibleのみです。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値:
  • 成功の場合、作成されたトークン・アカウントのJSONオブジェクト。
戻り値の例:
{
  "assetType": "ouaccount",
  "accountId": "ouaccount~24ffd4d32a028a85b4b960f5d55536c837b5429bc7f346150adfa904ec2937cc",
  "userId": "user2",
  "orgId": "appdev",
  "totalAccounts": 1,
  "totalFtAccounts": 1,
  "associatedFtAccounts": [
    {
      "accountId": "oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a",
      "tokenId": ""
    }
  ],
  "associatedNftAccount": "oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a"
}
createUserAccount
元のメソッド名: createUserAccount
このPOSTメソッドは、指定されたユーザーのアカウントを作成します。任意の時点でトークンを持つすべてのユーザーに対してアカウントを作成する必要があります。ユーザー・アカウントは、ユーザーが保持するNFTアカウントおよび代替可能トークン・アカウントを追跡します。ユーザーは、トークン関連の操作を完了するためにネットワーク内にアカウントを持っている必要があります。

アカウントIDは、orgIdパラメータおよびuserIdパラメータのSHA-256ハッシュです。このメソッドは、チェーンコードのToken Adminのみがコールできます。

ペイロード:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "endorsers": {{endorsers}}
}
パラメータ:
  • orgId: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザーのユーザー名または電子メールID。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値:
  • 成功の場合、作成されたユーザー・アカウントのJSONオブジェクト。
戻り値の例:
{
  "assetType": "ouaccount",
  "accountId": "ouaccount~24ffd4d32a028a85b4b960f5d55536c837b5429bc7f346150adfa904ec2937cc",
  "userId": "user2",
  "orgId": "appdev",
  "totalAccounts": 0,
  "totalFtAccounts": 0,
  "associatedFtAccounts": [],
  "associatedNftAccount": ""
}
deleteAccount
元のメソッド名: deleteAccount
このPOSTメソッドは、トークン・アカウントを削除します。アカウントを削除すると、アカウントは最終状態になり、他の状態に更新または変更できなくなります。アカウントを削除するには、アカウント残高がゼロである必要があります。このメソッドは、チェーンコードのToken Adminのみがコールできます。
ペイロード:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "endorsers": {{endorsers}}
}
パラメータ:
  • orgId: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザーのユーザー名または電子メールID。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値:
  • 成功の場合、トークン・アカウント・ステータスのJSON表現。
戻り値の例:
{
  "assetType": "oaccountStatus",
  "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
  "status": "deleted"
}
exchangeToken
元のメソッド名: exchangeToken
このメソッドは、指定されたアカウント間でトークンを交換します。この方メソッドは、NFTと代替可能トークン、または代替可能トークンとNFTとの間の交換のみをサポートします。NFTはホールまたはフラクショナルにできます。このメソッドは、アカウント所有者のみがコールできます。
ペイロード:
{
 "fromTokenId": "fromTokenId value",
 "fromOrgId": "fromOrgId value",
 "fromUserId": "fromUserId value",
 "fromTokenQuantity": 1,
 "toTokenId": "toTokenId value",
 "toOrgId": "toOrgId value",
 "toUserId": "toUserId value",
 "toTokenQuantity": 1,
 "endorsers": {{endorsers}}
}
パラメータ:
  • fromTokenId: string – 送信者が所有するトークンのID。
  • fromOrgId: string – 現在の組織内の送信者のメンバーシップ・サービス・プロバイダ(MSP) ID。
  • fromUserId: string – 送信者のユーザー名または電子メールID。
  • fromTokenQuantity: number – 受信者と交換する送信者からのトークンの数量。
  • toTokenId: string – 受信者が所有するトークンのID。
  • toOrgId: string – 現在の組織内の受信者のメンバーシップ・サービス・プロバイダ(MSP) ID。
  • toUserId: string – 受信者のユーザー名または電子メールID。
  • toTokenQuantity: number – 送信者と交換する受信者からのトークンの数量。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値:
  • 成功の場合、トークン交換の詳細を含むメッセージ。
戻り値の例:
{
    "msg": "Succesfully exchanged 10 tokens of type nonfungible with tokenId: [r1] from Account oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371 (OrgId: AppBldFFFFMay22, UserId: user2) to 10 tokens of type fungible with tokenId: [loy1] from Account oaccount~1089ee5122f367ee0ca38c6660298f4b81f199627e4f67f3691c0f628237974c (OrgId: AppBldFFFFMay22, UserId: example_minter)"
}
getAccount
元のメソッド名: getAccount
このGETメソッドは、指定されたユーザーのトークン・アカウント詳細を返します。このメソッドは、チェーンコードのToken AdminまたはアカウントのAccount Ownerのみがコールできます。
Query:
/getAccount?orgId={{bc-org-id}}&userId={{bc-user-id}}
パラメータ:
  • orgId: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザーのユーザー名または電子メールID。
戻り値:
  • 成功の場合、トークン・アカウントの詳細を含むJSONオブジェクト。
戻り値の例
{
    "assetType": "oaccount",
    "accountId": "oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371",
    "userId": "user2",
    "orgId": "AppBldFFFFMay22",
    "tokenType": "nonfungible",
    "noOfNfts": 3
}
getAccountDetailsByUser
元のメソッド名: getAccountDetailsByUser
このGETメソッドは、指定されたユーザーのアカウント詳細を返します。このメソッドは、チェーンコードのToken AdminまたはアカウントのAccount Ownerのみがコールできます。
Query:
/getAccountDetailsByUser?orgId={{bc-org-id}}&userId={{bc-user-id}}
パラメータ:
  • orgId: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザーのユーザー名または電子メールID。
戻り値の例:
{
    "userAccountId": "ouaccount~412de5e3998dcd100973e1bad6e8729fddc1c7ff610beab8376d733a35c51f38",
    "associatedFTAccounts": [
        {
            "accountId": "oaccount~21206f309941a2a23c4f158a0fe1b8f12bb8e2b0c9a2e1358f5efebc0c7d410e",
            "tokenId": "FT",
            "balance": 50
        }
    ],
    "associatedNFTAccount": {
        "accountId": "oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371",
        "associatedNFTs": [
            {
                "nftTokenId": "FNFT",
                "tokenShare": 100
            },
            {
                "nftTokenId": "FNFT2",
                "tokenShare": 110
            },
            {
                "nftTokenId": "NFT"
            }
        ]
    }
}
getAccountHistory
元のメソッド名: getAccountHistory
このGETメソッドは、指定されたトークン・アカウントのアカウント履歴を返します。NFTアカウントの場合、tokenIdパラメータは空である必要があります。このメソッドは、チェーンコードのToken Adminまたはアカウント所有者のみがコールできます。
Query:
/getAccountHistory?orgId={{bc-org-id}}&userId={{bc-user-id}}&tokenId={{bc-token-id}}
パラメータ:
  • orgId: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザーのユーザー名または電子メールID。
  • tokenId: string– 代替可能トークンのID。
戻り値の例:
[
    {
        "trxId": "a2cfc6fc064334d6b9931cdf67193711ec2ff5c50a4714f11855fe7384f00e35",
        "timeStamp": "2023-06-06T14:44:31.000Z",
        "value": {
            "accountId": "oaccount~21206f309941a2a23c4f158a0fe1b8f12bb8e2b0c9a2e1358f5efebc0c7d410e",
            "assetType": "oaccount",
            "balance": 100,
            "orgId": "AppBldFFFFMay22",
            "tokenId": "loy1",
            "tokenName": "loyalty",
            "tokenType": "fungible",
            "userId": "user2"
        }
    },
    {
        "trxId": "de483cf7505ae4e7018c4b604c3ab9327c2fb1f802d9408e22735667c1d6997f",
        "timeStamp": "2023-06-06T14:43:23.000Z",
        "value": {
            "assetType": "oaccount",
            "accountId": "oaccount~21206f309941a2a23c4f158a0fe1b8f12bb8e2b0c9a2e1358f5efebc0c7d410e",
            "userId": "user2",
            "orgId": "AppBldFFFFMay22",
            "tokenType": "fungible",
            "tokenId": "loy1",
            "tokenName": "loyalty",
            "balance": 0
        }
    },
    {
        "trxId": "db053e653d3ad9aa5b7b6e04b7cd51aacfbb413272d857a155b60d2a6a12bf4d",
        "timeStamp": "2023-06-05T16:59:08.000Z",
        "value": {
            "assetType": "oaccount",
            "accountId": "oaccount~21206f309941a2a23c4f158a0fe1b8f12bb8e2b0c9a2e1358f5efebc0c7d410e",
            "userId": "user2",
            "orgId": "AppBldFFFFMay22",
            "tokenType": "fungible",
            "tokenId": "",
            "balance": 0
        }
    }
]
getAccountStatus
元のメソッド名: getAccountStatus
このGETメソッドは、トークン・アカウントの現在のステータスを取得します。このメソッドは、チェーンコードのToken Adminまたはトークン・アカウント所有者がコールできます。
Query:
/getAccountStatus?orgId={{bc-org-id}}&userId={{bc-user-id}}
パラメータ:
  • orgId: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザーのユーザー名または電子メールID。
戻り値:
  • 成功の場合、トークン・アカウント・ステータスのJSON表現。
戻り値の例:
{
    "assetType": "oaccountStatus",
    "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
    "status": "active"
}
getAccountStatusHistory
元のメソッド名: getAccountStatusHistory
このGETメソッドは、アカウント・ステータスの履歴を取得します。このメソッドは、チェーンコードのToken Adminまたはトークン・アカウント所有者がコールできます。
Query:
/getAccountStatusHistory?orgId={{bc-org-id}}&userId={{bc-user-id}}
パラメータ:
  • orgId: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザーのユーザー名または電子メールID。
戻り値:
  • 成功の場合、JSON形式のアカウント・ステータス履歴。
戻り値の例:
[
  {
    "trxId": "d5c6d6f601257ba9b6edaf5b7660f00adc13c37d5321b8f7d3a35afab2e93e63",
    "timeStamp": "2022-12-02T10:39:14.000Z",
    "value": {
      "assetType": "oaccountStatus",
      "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
      "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
      "status": "suspended"
    }
  },
  {
    "trxId": "e6c850cfa084dc20ad95fb2bb8165eef3a3bd62a0ac867cccee57c2003125183",
    "timeStamp": "2022-12-02T10:37:50.000Z",
    "value": {
      "assetType": "oaccountStatus",
      "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
      "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
      "status": "active"
    }
  }
]
getAccountTransactionHistory
元のメソッド名: getAccountTransactionHistory
このGETメソッドは、勘定科目トランザクション履歴を返します。このメソッドは、チェーンコードのToken Adminまたはアカウント所有者のみがコールできます。
Query:
/getAccountTransactionHistory?orgId={{bc-org-id}}&userId={{bc-user-id}}
パラメータ:
  • orgId: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザーのユーザー名または電子メールID。
戻り値の例:
[
    {
        "transactionId": "otransaction~3a6b23c3003626f3947e990eddbd7ac23398d2200e2eb3eac745e6ddfae140bc~7c88c736df38d5622512f1e8dcdd50710eb47c953f1ecb24ac44790a9e2f475b",
        "timestamp": "2023-06-06T14:48:08.000Z",
        "tokenId": "FNFT",
        "transactedAmount": 10,
        "triggeredByUserAccountId": "ouaccount~412de5e3998dcd100973e1bad6e8729fddc1c7ff610beab8376d733a35c51f38",
        "transactedAccount": "oaccount~dcee860665db8740cb77b846e823752185a1e9a185814d0acb305890f5903446",
        "transactionType": "DEBIT",
        "balance": 90
    },
    {
        "transactionId": "otransaction~3a6b23c3003626f3947e990eddbd7ac23398d2200e2eb3eac745e6ddfae140bc~178e3730bc5bee50d02f1464a4eebf733a051905f651e5789039adb4a3edc114",
        "timestamp": "2023-06-06T14:48:08.000Z",
        "tokenId": "NFT",
        "triggeredByUserAccountId": "ouaccount~412de5e3998dcd100973e1bad6e8729fddc1c7ff610beab8376d733a35c51f38",
        "transactedAccount": "oaccount~dcee860665db8740cb77b846e823752185a1e9a185814d0acb305890f5903446",
        "transactionType": "DEBIT"
    },
    {
        "transactionId": "otransaction~c369929e28e78de06c72d020f1418c9a154a7dd280b2e22ebb4ea4485e249124~a7cefb22ff39ee7e36967be71de27da6798548c872061a62dabc56d88d50b930",
        "timestamp": "2023-06-06T14:47:08.000Z",
        "tokenId": "NFT",
        "triggeredByUserAccountId": "ouaccount~412de5e3998dcd100973e1bad6e8729fddc1c7ff610beab8376d733a35c51f38",
        "transactedAccount": "oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371",
        "transactionType": "MINT"
    },
    {
        "transactionId": "otransaction~114a1bc78d04be48ee6dc140c32c042ee9481cb118959626f090eec744522422~e4eb15d9354f694230df8835ade012100d82aa43672896a2c7125a86e3048f9f",
        "timestamp": "2023-06-05T17:17:57.000Z",
        "tokenId": "FNFT",
        "transactedAmount": 100,
        "triggeredByUserAccountId": "ouaccount~412de5e3998dcd100973e1bad6e8729fddc1c7ff610beab8376d733a35c51f38",
        "transactedAccount": "oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371",
        "transactionType": "MINT",
        "balance": 100
    }
]
getAccountsByRole
元のメソッド名: getAccountsByRole
このメソッドは、指定されたロールのすべてのアカウントIDのリストを返します。このメソッドは、チェーンコードのToken Adminのみがコールできます。
Query:
/getAccountsByRole?role=role value (for example minter / burner)&tokenDetail={"tokenName":"tokenName value"}
パラメータ:
  • role: string – 検索するロールの名前。
  • tokenDetails: TokenDetail – トークンを指定する詳細。代替可能トークンの場合は、次の形式を使用します:
    {"tokenId":"token1"}
    非代替トークンの場合は、次の形式を使用します:
    {"tokenName":"artCollection"}
戻り値の例:
{
  "accounts": [
    "oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a",
    "oaccount~60bb20c14a83f6e426e1437c479c5891e1c6477dfd7ad18b73acac5d80bc504b"
  ]
}
getAllAccounts
元のメソッド名: getAllAccounts
このGETメソッドは、すべてのユーザー・アカウントの詳細を返します。このメソッドは、チェーンコードのToken Adminのみがコールできます。
Query:
/getAllAccounts
パラメータ:
  • なし
戻り値:
  • 成功の場合、すべてのアカウントのJSON配列。
戻り値の例:
[
        {
            "assetType": "ouaccount",
            "accountId": "ouaccount~412de5e3998dcd100973e1bad6e8729fddc1c7ff610beab8376d733a35c51f38",
            "userId": "user2",
            "orgId": "AppBldFFFFMay22",
            "totalAccounts": 2,
            "totalFtAccounts": 1,
            "associatedFtAccounts": [
                {
                    "accountId": "oaccount~21206f309941a2a23c4f158a0fe1b8f12bb8e2b0c9a2e1358f5efebc0c7d410e",
                    "tokenId": "loy1"
                }
            ],
            "associatedNftAccount": "oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371"
        },
        {
            "assetType": "ouaccount",
            "accountId": "ouaccount~9501bb774c156eb8354dfe489250ea91f757523d70f08ee494bda98bb352003b",
            "userId": "example_minter",
            "orgId": "AppBldFFFFMay22",
            "totalAccounts": 2,
            "totalFtAccounts": 1,
            "associatedFtAccounts": [
                {
                    "accountId": "oaccount~1089ee5122f367ee0ca38c6660298f4b81f199627e4f67f3691c0f628237974c",
                    "tokenId": "loy1"
                }
            ],
            "associatedNftAccount": "oaccount~dcee860665db8740cb77b846e823752185a1e9a185814d0acb305890f5903446"
        },
    ]
getAllTokenAdmins
元のメソッド名: getAllTokenAdmins
このGETメソッドは、チェーンコードのToken Adminであるすべてのユーザーのリストを返します。このメソッドは、チェーンコードのToken Adminのみがコールできます。
Query:
/getAllTokenAdmins
パラメータ:
  • なし
戻り値:
  • 成功の場合、orgIdおよびuserIdオブジェクトを含むJSON形式のadmins配列。
戻り値の例:
{
  "admins": [
    {
      "orgId": "appdev",
      "userId": "user2"
    },
    {
      "orgId": "appdev",
      "userId": "user1"
    }
  ]
}
getAllTokens
元のメソッド名: getAllTokens
このGETメソッドは、状態データベースに保存されているすべてのトークン・アセットを返します。このメソッドは、チェーンコードのToken Adminのみがコールできます。このメソッドでは、Berkeley DB SQLリッチ問合せが使用され、リモートOracle Blockchain Platformネットワークに接続されている場合にのみコールできます。
Query:
/getAllTokens
パラメータ:
  • なし
戻り値の例:
[{
            "tokenMetadata": {
                "ISIN": "ISIN value",
                "Segment": "Segment value",
                "Issuer": "Issuer value",
                "FaceValue": 999,
                "IssueSize": 999,
                "CouponRate": 999,
                "InterestPaymentType": "simple",
                "InterestFrequency": "monthly",
                "IssueDate": "2023-03-28T15:16:36.000Z",
                "MaturityDate": "2023-03-28T15:16:36.000Z"
            },
            "assetType": "otoken",
            "events": false,
            "tokenId": "token2",
            "tokenName": "bond",
            "tokenDesc": "tokenDesc value",
            "tokenStandard": "erc1155+",
            "tokenType": "nonfungible",
            "tokenUnit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner"
            },
            "mintable": {
                "max_mint_quantity": 0
            },
            "quantity": 10,
            "createdBy": "oaccount~85dfd98d1b99e5b8891e0a0fdcd7d2e07fc5d37958f5d2a5796290b6a9204a43",
            "creationDate": "2024-12-03T12:07:24.000Z",
            "divisible": {
                "decimal": 0
            },
            "isBurned": false,
            "isLocked": false,
            "tokenUri": "tokenUri value",
            "status": "status value"
}]
getAllTokensByUser
元のメソッド名: getAllTokensByUser
このGETメソッドは、指定されたユーザーが所有するすべてのトークンアセットを返します。このメソッドでは、Berkeley DB SQLリッチ問合せが使用され、リモートOracle Blockchain Platformネットワークに接続されている場合にのみコールできます。このメソッドは、チェーンコードのToken Adminまたはアカウント所有者のみがコールできます。
Query:
/getAllTokensByUser?orgId={{bc-org-id}}&userId={{bc-user-id}}
パラメータ:
  • org_id: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • user_id: string – ユーザーのユーザー名または電子メールID。
戻り値の例:
[{
            "tokenMetadata": {
                "ISIN": "ISIN value",
                "Segment": "Segment value",
                "Issuer": "Issuer value",
                "FaceValue": 999,
                "IssueSize": 999,
                "CouponRate": 999,
                "InterestPaymentType": "simple",
                "InterestFrequency": "monthly",
                "IssueDate": "2023-03-28T15:16:36.000Z",
                "MaturityDate": "2023-03-28T15:16:36.000Z"
            },
            "assetType": "otoken",
            "events": false,
            "tokenId": "token2",
            "tokenName": "bond",
            "tokenDesc": "tokenDesc value",
            "tokenStandard": "erc1155+",
            "tokenType": "nonfungible",
            "tokenUnit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner"
            },
            "mintable": {
                "max_mint_quantity": 0
            },
            "quantity": 10,
            "createdBy": "oaccount~85dfd98d1b99e5b8891e0a0fdcd7d2e07fc5d37958f5d2a5796290b6a9204a43",
            "creationDate": "2024-12-03T12:07:24.000Z",
            "divisible": {
                "decimal": 0
            },
            "isBurned": false,
            "isLocked": false,
            "tokenUri": "tokenUri value",
            "status": "status value"
}]
getTokenById
元のメソッド名: getTokenById
このGETメソッドは、トークンが状態データベースに存在する場合、トークン・オブジェクトを返します。このメソッドは、チェーンコードのToken Adminまたはトークン所有者のみがコールできます。小数NFTの場合、レスポンスにはトークン所有者のリストが含まれます。
Query:
/getTokenById?tokenId={{bc-token-id}}
パラメータ:
  • tokenId: string – 取得するトークンのID。
戻り値の例:
[{
            "tokenMetadata":{
               "ISIN":"ISIN value",
               "Segment":"Segment value",
               "Issuer":"Issuer value",
               "FaceValue":10,
               "IssueSize":999,
               "CouponRate":10,
               "InterestPaymentType":"simple",
               "InterestFrequency":"monthly",
               "IssueDate":"2023-03-28T15:16:36.000Z",
               "MaturityDate":"2023-03-28T15:16:36.000Z"
            },
            "assetType":"otoken",
            "events":true,
            "tokenId":"bond1",
            "tokenName":"bond",
            "tokenDesc":"tokenDesc value",
            "tokenStandard":"erc1155+",
            "tokenType":"nonfungible",
            "tokenUnit":"fractional",
            "behaviors":[
               "divisible",
               "mintable",
               "transferable",
               "burnable",
               "roles"
            ],
            "roles":{
               "minter_role_name":"minter",
               "burner_role_name":"burner"
            },
            "mintable":{
               "max_mint_quantity":0
            },
            "quantity":100,
            "createdBy":"oaccount~276bcf1324b1ad1e493e22432db3b39f7a4b9bb17b8525c0391ea3ba36138e00",
            "creationDate":"2024-12-02T12:42:09.000Z",
            "divisible":{
               "decimal":0
            },
            "isBurned":false,
            "isLocked":false,
            "tokenUri":"tokenUri value",
            "status":"posted"
         }
]
getTokenDecimal
元のメソッド名: getTokenDecimal
このメソッドは、指定されたトークンの小数点以下の桁数を返します。このメソッドは、チェーンコードのToken Adminのみがコールできます。
Query:
/getTokenDecimal?tokenId={{bc-token-id}}
パラメータ:
  • tokenId: string – トークンのID。
戻り値の例:
{
    "msg": "Token Id: tokenOne has 2 decimal places."
}
getTokenHistory
元のメソッド名: getTokenHistory
このGETメソッドは、指定されたトークンIDの履歴を返します。だれでもこのメソッドをコールできます。
/getTokenHistory?tokenId={{bc-token-id}}
パラメータ:
  • tokenId: string – トークンのID。
戻り値の例:
[{
            "tokenMetadata":{
               "ISIN":"ISIN value",
               "Segment":"Segment value",
               "Issuer":"Issuer value",
               "FaceValue":10,
               "IssueSize":999,
               "CouponRate":10,
               "InterestPaymentType":"simple",
               "InterestFrequency":"monthly",
               "IssueDate":"2023-03-28T15:16:36.000Z",
               "MaturityDate":"2023-03-28T15:16:36.000Z"
            },
            "assetType":"otoken",
            "events":true,
            "tokenId":"bond1",
            "tokenName":"bond",
            "tokenDesc":"tokenDesc value",
            "tokenStandard":"erc1155+",
            "tokenType":"nonfungible",
            "tokenUnit":"fractional",
            "behaviors":[
               "divisible",
               "mintable",
               "transferable",
               "burnable",
               "roles"
            ],
            "roles":{
               "minter_role_name":"minter",
               "burner_role_name":"burner"
            },
            "mintable":{
               "max_mint_quantity":0
            },
            "quantity":100,
            "createdBy":"oaccount~276bcf1324b1ad1e493e22432db3b39f7a4b9bb17b8525c0391ea3ba36138e00",
            "creationDate":"2024-12-02T12:42:09.000Z",
            "divisible":{
               "decimal":0
            },
            "isBurned":false,
            "isLocked":false,
            "tokenUri":"tokenUri value",
            "status":"posted"
         }
]
getTokensByName
元のメソッド名: getTokensByName
このGETメソッドは、指定されたトークン名のすべてのトークン・アセットを返します。このメソッドでは、Berkeley DB SQLリッチ問合せが使用され、リモートOracle Blockchain Platformネットワークに接続されている場合にのみコールできます。このメソッドは、チェーンコードのToken Adminのみがコールできます。
Query:
/getTokensByName?tokenName=tokenName value
パラメータ:
  • tokenName: string – トークンの名前。
戻り値の例:
[
  {
    "key": "tokenOne",
    "valueJson": {
      "assetType": "otoken",
      "tokenId": "tokenOne",
      "tokenName": "moneytok",
      "tokenStandard": "erc1155+",
      "tokenType": "fungible",
      "tokenUnit": "fractional",
      "behaviors": [
        "divisible",
        "mintable",
        "transferable",
        "roles"
      ],
      "roles": {
        "minter_role_name": "minter",
        "burner_role_name": "burner"
      },
      "mintable": {
        "max_mint_quantity": 1000
      },
      "divisible": {
        "decimal": 2
      }
    }
  },
  {
    "key": "tokenTwo",
    "valueJson": {
      "assetType": "otoken",
      "tokenId": "tokenTwo",
      "tokenName": "moneytok",
      "tokenStandard": "erc1155+",
      "tokenType": "fungible",
      "tokenUnit": "fractional",
      "behaviors": [
        "divisible",
        "mintable",
        "transferable",
        "roles"
      ],
      "roles": {
        "minter_role_name": "minter",
        "burner_role_name": "burner"
      },
      "mintable": {
        "max_mint_quantity": 1000
      },
      "divisible": {
        "decimal": 2
      }
    }
  }
]
getTransactionById
元のメソッド名: getTransactionById
このGETメソッドは、指定されたトランザクションIDのトランザクション履歴を返します。これは非同期メソッドです。このメソッドは、どのユーザーでもコールできます。
Query:
/getTransactionById?transactionId=transactionId value
パラメータ:
  • transactionId: string – トランザクションのID。接頭辞otransaction~の後に16進形式の64ビット・ハッシュが続きます。
戻り値の例:
{
  "transactionId": "otransaction~9ea7b05ab099f7ff4db8342b8c3609031f1d54f11205906e7f1fe88661fe3cbe~33b59ce0c89e96c1e16449f24301581e8e71954f38ad977c7eb6f065e87f2a53",
  "history": [
    {
      "trxId": "9ea7b05ab099f7ff4db8342b8c3609031f1d54f11205906e7f1fe88661fe3cbe",
      "timeStamp": "2022-12-08T09:01:28.000Z",
      "value": {
        "assetType": "otransaction",
        "transactionId": "otransaction~9ea7b05ab099f7ff4db8342b8c3609031f1d54f11205906e7f1fe88661fe3cbe~33b59ce0c89e96c1e16449f24301581e8e71954f38ad977c7eb6f065e87f2a53",
        "tokenId": "tokenOne",
        "fromAccountId": "oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a",
        "toAccountId": "",
        "transactionType": "BURN",
        "amount": 5,
        "timestamp": "2022-12-08T09:01:28.000Z",
        "triggeredByUserAccountId": "ouaccount~24ffd4d32a028a85b4b960f5d55536c837b5429bc7f346150adfa904ec2937cc"
      }
    }
  ]
}
getUserByAccountId
元のメソッド名: getUserByAccountId
このGETメソッドは、指定されたアカウントIDの組織IDおよびユーザーIDを返します。
Query:
/getUserByAccountId?accountId=accountId value
パラメータ:
  • accountId: string – アカウントのID。
戻り値の例:
{
    "orgId": "AppBldFFFFMay22",
    "userId": "user2"
}
getUsersByRole
元のメソッド名: getUsersByRole
このGETメソッドは、指定されたロールのすべてのユーザーのリストを返します。
Query:
/getUsersByRole?role=role value (for example minter / burner)&tokenDetail={"tokenName":"tokenName value"}
パラメータ:
  • role: string – 検索するロールの名前。
  • tokenDetail: TokenDetail– トークンを指定する詳細。代替可能トークンの場合は、次の形式を使用します:
    {"tokenId":"token1"}
    非代替トークンの場合は、次の形式を使用します:
    {"tokenName":"artCollection"}
戻り値の例:
{
    "users": [
        {
            "accountId": "oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a",
            "orgId": "appdev",
            "userId": "user2"
        },
        {
            "accountId": "oaccount~60bb20c14a83f6e426e1437c479c5891e1c6477dfd7ad18b73acac5d80bc504b",
            "orgId": "appdev",
            "userId": "user1"
        }
    ]
}
init
元のメソッド名: init
このPOSTメソッドは、チェーンコードがデプロイされるときにコールされます。ユーザー情報は、チェーンコードのToken Adminとして保存されます。
ペイロード:
{
 "adminList": "[{\"orgId\":\"{{bc-org-id}}\",\"userId\":\"{{bc-user-id}}\"}]"
}
パラメータ:
  • adminList array – トークン管理者のリストを指定する{user_id, org_id}情報の配列。adminList配列は必須パラメータです。
戻り値:
  • 成功の場合、ペイロードのないメッセージ。
戻り値の例:
{

}
isInRole
元のメソッド名: isInRole
このGETメソッドは、ユーザーに指定されたロールがあるかどうかを示すブール値を返します。このメソッドは、チェーンコードのToken AdminまたはアカウントのAccount Ownerのみがコールできます。
Query:
/isInRole?orgId={{bc-org-id}}&userId={{bc-user-id}}&role=role value (for example minter / burner)&tokenDetail={"tokenName":"tokenName value"}
パラメータ:
  • orgId: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザーのユーザー名または電子メールID。
  • role: string – 検索するロールの名前。
  • tokenDetail: TokenDetail– トークンを指定する詳細。代替可能トークンの場合は、次の形式を使用します:
    {"tokenId":"token1"}
    非代替トークンの場合は、次の形式を使用します:
    {"tokenName":"artCollection"}
戻り値の例:
{
    "result": true,
    "msg": "Account Id oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a (Org-Id: appdev, User-Id: user2) has minter role"
}
isTokenAdmin
元のメソッド名: isTokenAdmin
このGETメソッドは、関数のコール元がToken Adminの場合はブール値trueを返し、それ以外の場合はfalseを返します。このメソッドは、チェーンコードのToken Adminのみがコールできます。
Query:
/isTokenAdmin?orgId={{bc-org-id}}&userId={{bc-user-id}}
パラメータ:
  • orgId: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザーのユーザー名または電子メールID。
戻り値:
  • コール元がToken Adminの場合はtrueを返し、そうでない場合はfalseを返します。
戻り値の例:
{
  "result": true
}
mintBatch
元のメソッド名: mintBatch
このPOSTメソッドは、バッチ操作で複数のトークンを作成(ミント)します。このメソッドは、代替可能トークンまたはフラクショナル非代替トークンのみを作成します。

代替可能トークンの場合、ミンター・ロールが仕様ファイルに定義されていれば、ミンター・ロールを持つすべてのユーザーがこのメソッドをコールできます。そうでない場合は、どのユーザーもこのメソッドを使用してトークンをミントできます。トークンの作成または更新時にトークンのmax_mint_quantityプロパティが指定されていた場合、このプロパティを超えるミントはできません。

非代替トークンの場合、ミンター・ロールが仕様ファイルに定義されていれば、ミンター・ロールを持つすべてのユーザーがこのメソッドをコールできます。そうでない場合は、どのユーザーもこのメソッドを使用してトークンをミントできます。また、コール元はトークンの作成者でもある必要があります。ミントできるフラクショナル非代替トークンの数量に上限はありません。

このメソッドを使用して、ホール非代替トークンをミントすることはできません。

ペイロード:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "tokenIds": "[\"{{bc-token-id}}\"]",
 "quantity": "[quantity value]",
 "sameOrgEndorser": true
}
パラメータ:
  • orgId: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザーのユーザー名または電子メールID。
  • tokenIds: string[] – トークンをミントするトークンIDのリスト。
  • quantity: number[] – ミントするトークンの数量のリストで、トークンID配列に対応します。
  • sameOrgEndorser: boolean– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値:
  • 成功の場合、ミントされたトークンの詳細を含むJSONオブジェクト。
戻り値の例:
{
    "msg": "Successfully minted batch of tokens for User-Account-Id ouaccount~412de5e3998dcd100973e1bad6e8729fddc1c7ff610beab8376d733a35c51f38 (Org-Id: AppBldFFFFMay22, User-Id: user2).",
    "details": [
        {
            "msg": "Successfully minted 100 tokens of fractional tokenId: plot55 to Org-Id: AppBldFFFFMay22, User-Id: user2"
        },
        {
            "msg": "Successfully minted 100 tokens of tokenId: loyalty to Token-Account-Id oaccount~21206f309941a2a23c4f158a0fe1b8f12bb8e2b0c9a2e1358f5efebc0c7d410e"
        }
    ]
}
name
元のメソッド名: name
このGETメソッドは、トークン・クラスの名前を返します。だれでもこのメソッドをコールできます。
Query:
/name?tokenId={{bc-token-id}}
パラメータ:
  • tokenId: string – トークンのID。
戻り値の例:
{
    "tokenName": "artcollection"
}
ownerOf
元のメソッド名: ownerOf
このGETメソッドは、指定されたトークンIDの所有者のアカウントIDを返します。だれでもこのメソッドをコールできます。
Query:
/ownerOf?tokenId={{bc-token-id}}
パラメータ:
  • tokenId: string – トークンのID。
戻り値:
  • 所有者のアカウントIDのJSONオブジェクト。
戻り値の例:
[
    {
        "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
        "orgId": "Org1MSP",
        "userId": "admin"
    },
    {
        "accountId": "oaccount~74108eca702bab6d8548e740254f2cc7955d886885251d52d065042172a59db0",
        "orgId": "Org1MSP",
        "userId": "user"
    }
]
post
元のメソッド名: post
このPOSTメソッドは、指定された価格で販売するトークンをポストします。
ペイロード:
{
 "tokenId": "{{bc-token-id}}",
 "sellingPrice": 1,
 "endorsers": {{endorsers}}
}
パラメータ:
  • tokenId: string – トークンのID。
  • sellingPrice: number– トークンの価格。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
  "msg": "Token ID : 'artCollection1' has been posted for selling in the marketplace"          
}
removeRole
元のメソッド名: removeRole
このメソッドは、指定されたユーザーからロールを削除します。このメソッドは、チェーンコードのToken Adminのみがコールできます。
ペイロード:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "role": "role value (for example minter / burner)",
 "tokenDetail": "{\"tokenName\":\"tokenName value\"}",
 "endorsers": {{endorsers}}
}
パラメータ:
  • orgId: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザーのユーザー名または電子メールID。
  • role: string – 指定したユーザーから削除するロールの名前。
  • tokenDetail: TokenDetail– トークンを指定する詳細。代替可能トークンの場合は、次の形式を使用します:
    {"tokenId":"token1"}
    非代替トークンの場合は、次の形式を使用します:
    {"tokenName":"artCollection"}
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
  "msg": "Successfully removed role 'minter' from Account Id: oaccount~60bb20c14a83f6e426e1437c479c5891e1c6477dfd7ad18b73acac5d80bc504b (Org-Id: appdev, User-Id: user1)"
}
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– トランザクション・エンドースメントがリクエスタと同じ組織からのものである必要があるかどうかを示すブール値。
戻り値の例:
{
  "msg": "Successfully removed Admin (OrgId: appDev, UserId: user1)"
}
safeBatchTransferFrom
元のメソッド名: safeBatchTransferFrom
このPOSTメソッドは、指定されたトークンの所有権をコール元から別のアカウントに転送します。このメソッドのコール元はトークンの送信者で、指定されたトークンを所有している必要があります。小数NFTの場合、ユーザーがすべてのシェアを別のユーザーに転送すると、トークンの所有権が失われます。
ペイロード:
{
 "fromOrgId": "fromOrgId value",
 "fromUserId": "fromUserId value",
 "toOrgId": "toOrgId value",
 "toUserId": "toUserId value",
 "tokenIds": "[\"{{bc-token-id}}\"]",
 "quantity": "[quantity value]",
 "endorsers": {{endorsers}}
}
パラメータ:
  • fromOrgId: string – 現在の組織内の送信者およびトークン所有者のメンバーシップ・サービス・プロバイダ(MSP) ID。
  • fromUserId: string – 送信者およびトークン所有者のユーザー名または電子メールID。
  • toOrgId: string – 現在の組織内の受信者のメンバーシップ・サービス・プロバイダ(MSP) ID。
  • toUserId: string – 受信者のユーザー名または電子メールID。
  • tokenIds: string[]– 転送するトークンのIDの配列。
  • quantity: number[] – 転送するトークンの数量のリストで、トークンID配列に対応します。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
[
    {
        "msg": "Successfully transferred NFT token: 'FNFT' of '10' quantity from Account-Id: oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371 (Org-Id: AppBldFFFFMay22, User-Id: user2) to Account-Id: oaccount~dcee860665db8740cb77b846e823752185a1e9a185814d0acb305890f5903446 (Org-Id: AppBldFFFFMay22, User-Id: example_minter)"
    },
    {
        "msg": "Successfully transferred 10 FT token: 'FT' from Account-Id: oaccount~21206f309941a2a23c4f158a0fe1b8f12bb8e2b0c9a2e1358f5efebc0c7d410e (Org-Id: AppBldFFFFMay22, User-Id: user2) to Account-Id: oaccount~1089ee5122f367ee0ca38c6660298f4b81f199627e4f67f3691c0f628237974c (Org-Id: AppBldFFFFMay22, User-Id: example_minter)"
    },
    {
        "msg": "Successfully transferred NFT token: 'NFT' from Account-Id: oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371 (Org-Id: AppBldFFFFMay22, User-Id: user2) to Account-Id: oaccount~dcee860665db8740cb77b846e823752185a1e9a185814d0acb305890f5903446 (Org-Id: AppBldFFFFMay22, User-Id: example_minter)"
    }
]
suspendAccount
元のメソッド名: suspendAccount
このPOSTメソッドは、真菌可能なトークン・アカウントを一時停止します。accountStatus値がレジャーで見つからない場合、エラーがスローされます。このメソッドは、チェーンコードのToken Adminのみがコールできます。
ペイロード:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
パラメータ:
  • orgId: string – 現在の組織内のユーザーのメンバーシップ・サービス・プロバイダ(MSP) ID。
  • userId: string – ユーザーのユーザー名または電子メールID。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
    "assetType": "oaccountStatus",
    "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
    "status": "suspended"
}
totalNetSupply
元のメソッド名: totalNetSupply
このGETメソッドは、ミントされたトークンの合計数からバーンされたトークンの数を引いた数を返します。このメソッドは、チェーンコードのToken Adminのみがコールできます。
問合せ(代替トークン):
/totalNetSupply?tokenDetail={"tokenId":"{{bc-token-id}}"}
問合せ(非代替トークン):
/totalNetSupply?tokenDetail={"tokenName":"tokenName value"}
パラメータ:
  • tokenDetail: TokenDetail– トークンを指定する詳細。代替可能トークンの場合は、次の形式を使用します:
    {"tokenId":"token1"}
    非代替トークンの場合は、次の形式を使用します:
    {"tokenName":"artCollection"}
戻り値の例:
{
    "totalNetSupply": 105
}
totalSupply
元のメソッド名: totalSupply
このGETメソッドは、ミントされたトークンの合計数を返します。このメソッドは、チェーンコードのToken Adminのみがコールできます。
問合せ(代替トークン):
/totalSupply?tokenDetail={"tokenId":"{{bc-token-id}}"}
問合せ(非代替トークン):
/totalSupply?tokenDetail={"tokenName":"tokenName value"}
パラメータ:
  • tokenDetail: TokenDetail– トークンを指定する詳細。代替可能トークンの場合は、次の形式を使用します:
    {"tokenId":"token1"}
    非代替トークンの場合は、次の形式を使用します:
    {"tokenName":"artCollection"}
戻り値の例:
{
    "totalSupply": 110
}
updateArtCollectionToken
元のメソッド名: updateArtCollectionToken
このPOSTメソッドは、トークン・プロパティを更新します。このメソッドをコールできるのはトークン所有者のみです。NFTの場合、トークン・メタデータおよびトークンURIは、トークンのミント後に更新できません。
ペイロード:
{
 "tokenAsset": "{\"tokenId\":\"{{bc-token-id}}\",\"tokenDesc\":\"tokenDesc value\",\"tokenUri\":\"tokenUri value\",\"status\":\"status value\", \"tokenMetadata\":{\"ISIN\":\"ISIN value\",\"Segment\":\"Segment value\",\"Issuer\":\"Issuer value\",\"FaceValue\":999,\"IssueSize\":999,\"CouponRate\":999,\"InterestPaymentType\":\"InterestPaymentType value\",\"InterestFrequency\":\"InterestFrequency value\",\"IssueDate\":\"2023-03-28T15:16:36+00:00\",\"MaturityDate\":\"2023-03-28T15:16:36+00:00\"},\"status\":\"status value\"}",
 "sameOrgEndorser": true
}
パラメータ:
  • tokenAsset: <Token Class> – 更新するトークン・アセット。トークン・アセットのプロパティの詳細は、入力仕様ファイルを参照してください。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
            "tokenMetadata": {
                "ISIN": "ISIN value",
                "Segment": "Segment value",
                "Issuer": "Issuer value",
                "FaceValue": 999,
                "IssueSize": 999,
                "CouponRate": 999,
                "InterestPaymentType": "simple",
                "InterestFrequency": "monthly",
                "IssueDate": "2023-03-28T15:16:36.000Z",
                "MaturityDate": "2023-03-28T15:16:36.000Z"
            },
            "assetType": "otoken",
            "events": false,
            "tokenId": "token2",
            "tokenName": "bond",
            "tokenDesc": "tokenDesc value",
            "tokenStandard": "erc1155+",
            "tokenType": "nonfungible",
            "tokenUnit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner"
            },
            "mintable": {
                "max_mint_quantity": 0
            },
            "quantity": 10,
            "createdBy": "oaccount~85dfd98d1b99e5b8891e0a0fdcd7d2e07fc5d37958f5d2a5796290b6a9204a43",
            "creationDate": "2024-12-03T12:07:24.000Z",
            "divisible": {
                "decimal": 0
            },
            "isBurned": false,
            "isLocked": false,
            "tokenUri": "tokenUri value",
            "status": "created"
}
updateLoyaltyToken
元のメソッド名: updateLoyaltyToken
このPOSTメソッドは、トークン・プロパティを更新します。このメソッドをコールできるのはトークン所有者のみです。NFTの場合、トークン・メタデータおよびトークンURIは、トークンのミント後に更新できません。
ペイロード:
{
 "tokenAsset": "{\"tokenId\":\"{{bc-token-id}}\",\"tokenDesc\":\"tokenDesc value\",\"Token_Name\":\"Token_Name value\",\"Token_to_Currency_Ratio\":999}",
 "sameOrgEndorser": true
}
パラメータ:
  • tokenAsset: <Token Class> – 更新するトークン・アセット。トークン・アセットのプロパティの詳細は、入力仕様ファイルを参照してください。
  • endorsers: string[]– トランザクションを承認する必要があるピアの配列(peer1、peer2など)。
戻り値の例:
{
            "assetType": "otoken",
            "events": false,
            "tokenId": "token2",
            "tokenName": "loyalty",
            "tokenDesc": "tokenDesc value",
            "tokenStandard": "erc1155+",
            "tokenType": "fungible",
            "tokenUnit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner"
            },
            "mintable": {
                "max_mint_quantity": 0
            },
            "quantity": 10,
            "createdBy": "oaccount~85dfd98d1b99e5b8891e0a0fdcd7d2e07fc5d37958f5d2a5796290b6a9204a43",
            "creationDate": "2024-12-03T12:07:24.000Z",
            "divisible": {
                "decimal": 0
            },
            "isBurned": false,
            "isLocked": false,
            "tokenUri": "tokenUri value",
            "status": "created"
}
URI
元のメソッド名: URI
このGETメソッドは、指定されたトークンのURIを返します。このメソッドを呼び出すことができるのはトークン作成者のみです。
問合せ
/URI?tokenId={{bc-token-id}}
パラメータ:
  • tokenId: string – トークンのID。
戻り値の例:
{
    "tokenUri": "example.com"
}