Package API de wrapper Token Framework combiné

Oracle Blockchain Platform Digital Assets Edition inclut un package d'API wrapper qui étend l'API REST pour prendre en charge les opérations propres à un marché NFT à collectionner.

Le package d'API wrapper utilise le service API Gateway et OCI Functions pour déployer des routages d'API spécialement conçus pour l'application Marketplace à collectionner. Le package d'API de wrapper de structure de jetons non fongible peut être téléchargé à partir de la console Oracle Blockchain Platform et inclut les composants suivants.
  • NFTCollectiblesWithERC1155WrapperAPI.zip, fichier d'archive contenant le package d'API de wrapper, y compris les scripts Terraform requis pour le déploiement. Vous déployez ce fichier vers une pile Resource Manager sur Oracle Cloud Infrastructure (OCI) afin de créer les ressources Oracle nécessaires pour les API de wrapper.
  • NFTCollectiblesWithERC1155_WrapperAPI.postman_collection.json, collection Postman qui vous permet de tester les API de wrapper déployées. La collection inclut des demandes préconfigurées avec des adresses et des charges utiles correspondant aux API définies dans le package d'API de wrapper.

API de wrapper

activateAccount
Nom de la méthode d'origine : activateAccount
Cette méthode POST active un compte de jeton. Cette méthode ne peut être appelée que par un administrateur ou un propriétaire de compte. Pour les comptes existants pour lesquels accountStatus est introuvable dans le livre, la méthode renvoie un objet accountStatus avec le statut défini sur active.
Charge utile:
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
Paramètres :
  • tokenId: string : ID du jeton.
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
Renvoie :
  • En cas de succès, représentation JSON de l'objet de statut de compte mis à jour pour le compte de jeton fongible.
Exemple de valeur renvoyée :
{
  "assetType": "oaccountStatus",
  "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
  "status": "active"
}
addTokenAdmin
Nom de la méthode d'origine : addTokenAdmin
Cette méthode POST ajoute un utilisateur en tant que Token Admin du code chaîne. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.
Charge utile:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
Renvoie :
  • En cas de succès, message qui inclut les détails de l'utilisateur ajouté en tant que Token Admin du code chaîne.
Exemple de valeur renvoyée :
{
  "msg": "Successfully added Admin (OrgId: appDev, UserId: user1)"
}
addRole
Nom de la méthode d'origine : addRole
Cette méthode POST ajoute le rôle à l'utilisateur et au jeton spécifiés. Cette méthode ne peut être appelée que par un Token Admin du code chaîne. Les jetons fongibles du paramètre tokenDetails nécessitent la valeur tokenId comme entrée. Les jetons non fongibles nécessitent l'entrée tokenName pour que nous utilisions le paramètre tokenDetail afin de spécifier différemment les détails des jetons fongibles et non fongibles.
Charge utile:
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "role": "role minter/burner"
    "tokenDetails": "{"tokenName": "token name value"}"
    "endorsers": {{endorsers}}
}
Paramètres :
  • tokenId: string : ID du jeton.
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
  • role: string : nom du rôle à ajouter à l'utilisateur spécifié.
  • tokenDetails: TokenDetail : détails qui spécifient le jeton. Pour les jetons fongibles, utilisez le format suivant :
    {"tokenId":"token1"}
    Pour les jetons non fongibles, utilisez le format suivant :
    {"tokenName":"artCollection"}
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
Exemple de valeur renvoyée :
{
  "msg": "Successfully added role 'minter' to Account Id: oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a 
(Org-Id: appdev, User-Id: user2)"
}
associateFungibleTokenToAccount
Nom de la méthode d'origine : associateFungibleTokenToAccount
Cette méthode POST associe le compte de jeton fongible d'un utilisateur à un jeton spécifié.
Charge utile:
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
Paramètres :
  • tokenId: string : ID du jeton.
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
Exemple de valeur renvoyée :
{
  "assetType": "ouaccount",
  "accountId": "ouaccount~24ffd4d32a028a85b4b960f5d55536c837b5429bc7f346150adfa904ec2937cc",
  "userId": "user2",
  "orgId": "appdev",
  "totalAccounts": 1,
  "totalFtAccounts": 1,
  "associatedFtAccounts": [
    {
      "accountId": "oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a",
      "tokenId": "tokenOne"
    }
  ],
  "associatedNftAccount": ""
}
buyWithEthCoin
Nom de la méthode d'origine : buyWithEthCoin
Tout titulaire de compte peut utiliser cette méthode POST pour acheter un NFT en utilisant Ethereum et pour transférer des jetons de fidélité en points de récompense.
Charge utile:
{
   "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"}}
}
Paramètres :
  • fromOrgId: string – ID du fournisseur de services d'adhésion de l'expéditeur (propriétaire) dans l'organisation actuelle.
  • fromUserId: string : nom d'utilisateur ou ID courriel de l'expéditeur (propriétaire).
  • toOrgId: string : ID du fournisseur de services d'adhésion du destinataire dans l'organisation actuelle.
  • toUserId: string : nom d'utilisateur ou ID courriel du destinataire.
  • nftId: string : ID du jeton à acheter.
  • loyaltyId: string : ID du jeton fongible qui représente les points de fidélité.
  • ethQty: number : prix du jeton dans Ethereum.
  • loyaltyRewardQuantity: string – La quantité de points de fidélité à transférer.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
Exemple de valeur renvoyée :
{
  "msg": "Token ID : 'artcollection1' has been successfully transferred to UserID : 'user1'"
}
balanceOfBatch
Nom de la méthode d'origine : balanceOfBatch
Cette méthode GET termine une opération par lots qui obtient les soldes des comptes de jetons. Cette méthode peut être appelée uniquement par un élément Token Admin du code chaîne ou par le propriétaire du compte.
Interroger :
/balanceOfBatch?orgIds=["{{bc-org-id}}"]&userIds=["{{bc-user-id}}"]&tokenIds=["{{bc-token-id}}"]
Paramètres :
  • orgIds: string[] : liste des ID de fournisseur de services d'adhésion dans l'organisation actuelle.
  • userIds: string[] : liste du nom d'utilisateur ou des ID de courriel.
  • tokenIds: string[] : liste des ID de jeton.
Exemple de valeur renvoyée :
[
    {
        "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
Nom de la méthode d'origine : batchTransferFrom
Cette méthode POST termine une opération par lots qui transfère les jetons spécifiés dans une liste d'ID de jeton d'un utilisateur à un autre. Cette méthode peut être appelée par n'importe quel utilisateur.
Charge utile:
{
 "fromOrgId": "fromOrgId value",
 "fromUserId": "fromUserId value",
 "toOrgId": "toOrgId value",
 "toUserId": "toUserId value",
 "tokenIds": "[\"{{bc-token-id}}\"]",
 "quantity": "[quantity value]",
 "endorsers": {{endorsers}}
}
Paramètres :
  • fromOrgId: string : ID du fournisseur de services d'adhésion de l'expéditeur.
  • fromUserId: string : ID utilisateur de l'expéditeur.
  • toOrgId: string : ID du fournisseur de services d'adhésion du destinataire.
  • toUserId: string : ID utilisateur du récepteur.
  • tokenIds: string[] : liste des ID de jeton pour les jetons à transférer.
  • quantity: number[] : liste des quantités de jetons à transférer, correspondant au tableau d'ID de jeton.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
Renvoie :
  • En cas de succès, un message contenant les détails de chaque transfert de jeton.
Exemple de valeur renvoyée :
[
    {
        "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
Nom de la méthode d'origine : burnBatch
Cette méthode POST désactive ou brûle les jetons fongibles et non fongibles spécifiés. Tout utilisateur doté du rôle de brûleur peut appeler cette méthode.
Charge utile:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "tokenIds": "[\"{{bc-token-id}}\"]",
 "quantity": "[quantity value]",
 "sameOrgEndorser": true
}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel.
  • tokenIds: string[] : liste des ID de jeton à graver
  • quantity: number[] : liste des quantités de jetons à graver, correspondant au tableau d'ID de jeton.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations de transaction doivent provenir de la même organisation que le demandeur.
Renvoie :
  • En cas de succès, message contenant des détails sur les opérations de gravure.
Exemple de valeur renvoyée :
[
  {
    "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
Nom de la méthode d'origine : burnNFT
Cette méthode POST désactive ou brûle le jeton non fongible spécifié et renvoie un objet de jeton et un historique de jeton. Tout utilisateur doté du rôle de brûleur peut appeler cette méthode.
Charge utile:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "tokenId": "{{bc-token-id}}",
 "sameOrgEndorser": true
}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel.
  • tokenId: string : ID du jeton non fongible à graver
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations de transaction doivent provenir de la même organisation que le demandeur.
Renvoie :
  • En cas de succès, tableau JSON contenant un message sur l'opération de gravure.
Exemple de valeur renvoyée :
{
    "msg": "Successfully burned NFT token: 'art' from Account-Id: oaccount~76cb672eeb1bd535899562a840d0c15a356db89e24bc8b43ac1dba845a4282c6 (Org-Id: appdev, User-Id: user2)"
  }
createAccount
Nom de la méthode d'origine : createAccount
Cette méthode POST crée un compte pour un utilisateur spécifié et les comptes de jetons associés pour les jetons fongibles ou non fongibles. Un compte doit être créé pour tout utilisateur qui aura des jetons à tout moment. Le compte utilisateur assure le suivi du compte NFT et des comptes de jetons fongibles qu'un utilisateur détient. Les utilisateurs doivent disposer de comptes sur le réseau pour effectuer les opérations liées aux jetons. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.

Un compte utilisateur possède un ID unique, formé par un hachage SHA-256 du paramètre orgId et du paramètre userId.

Un utilisateur peut avoir plusieurs comptes de jeton fongibles avec des ID de compte uniques. Les ID de compte de jeton fongibles sont formés par un hachage SHA-256 du paramètre orgId, le paramètre userId, la chaîne constante ft séparée par le symbole tilde (~) et un nombre de compteur qui signifie l'index du compte fongible créé séparé par le symbole tilde (~).

Un utilisateur ne peut avoir qu'un seul compte de jeton non fongible. Les ID de compte de jeton non fongibles sont uniques et sont formés par un hachage SHA-256 du paramètre orgId, du paramètre userId et de la chaîne constante nft séparés par le symbole tilde (~). Tous les jetons non fongibles qu'un utilisateur possède, qu'ils soient entiers ou fractionnaires, sont liés à ce compte.

Les ID de compte utilisateur commencent par ouaccount~. Les ID de compte de jeton commencent par oaccount~.

Charge utile:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "ftAccount": true,
 "nftAccount": true,
 "endorsers": {{endorsers}}
}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
  • ftAccount: boolean : si la valeur est True, un compte de jeton fongible est créé et associé au compte utilisateur.
  • nftAccount: boolean : si la valeur est True, un compte de jeton non fongible est créé et associé au compte utilisateur.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
Exemple de valeur renvoyée :
{
  "assetType": "ouaccount",
  "accountId": "ouaccount~cf20877546f52687f387e7c91d88b9722c97e1a456cc0484f40c747f7804feae",
  "userId": "user1",
  "orgId": "appdev",
  "totalAccounts": 2,
  "totalFtAccounts": 1,
  "associatedFtAccounts": [
    {
      "accountId": "oaccount~60bb20c14a83f6e426e1437c479c5891e1c6477dfd7ad18b73acac5d80bc504b",
      "tokenId": ""
    }
  ],
  "associatedNftAccount": "oaccount~73c3e835dac6d0a56ca9d8def08269f83cefd59b9d297fe2cdc5a9083828fa58"
}
createArtCollectionToken
Nom de la méthode d'origine : createArtCollectionToken
Cette méthode POST crée (affecte) un NFT. La ressource et les propriétés associées sont enregistrées dans la base de données d'état. L'appelant de cette transaction doit avoir un compte de jeton. L'appelant de cette transaction devient le propriétaire du NFT. Si le fichier de spécification de jeton inclut la section roles pour behaviors et la propriété minter_role_name pour roles, l'appelant de la transaction doit avoir le rôle minter. Dans le cas contraire, tout appelant peut frapper les NFT.
Charge utile:
{
 "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
}
Paramètres :
  • tokenAsset: <Token Class> : ressource de jeton à mint. Pour plus d'informations sur les propriétés de la ressource de jeton, reportez-vous au fichier de spécification d'entrée.
  • quantity: number : nombre de jetons à menthe. La seule valeur prise en charge pour ce paramètre est 1.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations de transaction doivent provenir de la même organisation que le demandeur.
Exemple de valeur renvoyée :
{
            "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
Nom de la méthode d'origine : createLoyaltyToken
Cette méthode POST crée des jetons. Chaque jeton défini possède sa propre méthode de création. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.
Charge utile:
{
 "tokenAsset": "{\"tokenId\":\"{{bc-token-id}}\",\"tokenDesc\":\"tokenDesc value\",\"Token_Name\":\"Token_Name value\",\"Token_to_Currency_Ratio\":999}",
 "sameOrgEndorser": true
}
Paramètres :
  • tokenAsset: <Token Class> : ressource de jeton. Les propriétés de la ressource sont définies dans le fichier de modèle.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations de transaction doivent provenir de la même organisation que le demandeur.
Exemple de valeur renvoyée :
{
            "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
Nom de la méthode d'origine : createTokenAccount
Cette méthode POST crée un compte de jeton fongible ou non fongible à associer à un compte utilisateur.

Un utilisateur peut avoir plusieurs comptes de jeton fongibles avec des ID de compte uniques. Les ID de compte de jeton fongibles sont formés par un hachage SHA-256 du paramètre orgId, le paramètre userId, la chaîne constante ft séparée par le symbole tilde (~) et un nombre de compteur qui signifie l'index du compte fongible créé séparé par le symbole tilde (~).

Un utilisateur ne peut avoir qu'un seul compte de jeton non fongible. Les ID de compte de jeton non fongibles sont uniques et sont formés par un hachage SHA-256 du paramètre orgId, du paramètre userId et de la chaîne constante nft séparés par le symbole tilde (~). Tous les jetons non fongibles qu'un utilisateur possède, qu'ils soient entiers ou fractionnaires, sont liés à ce compte.

Cette méthode ne peut être appelée que par un Token Admin du code chaîne.

Charge utile:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "tokenType": "nonfungible",
 "endorsers": {{endorsers}}
}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
  • tokenType: TokenType : type de compte de jeton à créer. Les seuls types de jeton pris en charge sont nonfungible et fungible.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
Renvoie :
  • En cas de succès, objet JSON du compte de jeton créé.
Exemple de valeur renvoyée :
{
  "assetType": "ouaccount",
  "accountId": "ouaccount~24ffd4d32a028a85b4b960f5d55536c837b5429bc7f346150adfa904ec2937cc",
  "userId": "user2",
  "orgId": "appdev",
  "totalAccounts": 1,
  "totalFtAccounts": 1,
  "associatedFtAccounts": [
    {
      "accountId": "oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a",
      "tokenId": ""
    }
  ],
  "associatedNftAccount": "oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a"
}
createUserAccount
Nom de la méthode d'origine : createUserAccount
Cette méthode POST crée un compte pour un utilisateur spécifié. Un compte doit être créé pour tout utilisateur qui aura des jetons à tout moment. Le compte utilisateur assure le suivi du compte NFT et des comptes de jetons fongibles dont dispose un utilisateur. Les utilisateurs doivent disposer de comptes sur le réseau pour effectuer les opérations liées aux jetons.

Un ID de compte est un hachage SHA-256 du paramètre orgId et du paramètre userId. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.

Charge utile:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "endorsers": {{endorsers}}
}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
Renvoie :
  • En cas de succès, objet JSON du compte utilisateur créé.
Exemple de valeur renvoyée :
{
  "assetType": "ouaccount",
  "accountId": "ouaccount~24ffd4d32a028a85b4b960f5d55536c837b5429bc7f346150adfa904ec2937cc",
  "userId": "user2",
  "orgId": "appdev",
  "totalAccounts": 0,
  "totalFtAccounts": 0,
  "associatedFtAccounts": [],
  "associatedNftAccount": ""
}
deleteAccount
Nom de la méthode d'origine : deleteAccount
Cette méthode POST supprime un compte de jeton. Une fois le compte supprimé, il passe à l'état final et ne peut pas être mis à jour ou remplacé par un autre état. Pour supprimer un compte, le solde du compte doit être égal à zéro. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.
Charge utile:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "endorsers": {{endorsers}}
}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
Renvoie :
  • En cas de succès, représentation JSON du statut du compte de jeton.
Exemple de valeur renvoyée :
{
  "assetType": "oaccountStatus",
  "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
  "status": "deleted"
}
exchangeToken
Nom de la méthode d'origine : exchangeToken
Cette méthode échange des jetons entre des comptes spécifiés. Cette méthode prend uniquement en charge l'échange entre un NFT et un jeton fongible ou un jeton fongible et un NFT. Le NFT peut être entier ou fractionnaire. Cette méthode ne peut être appelée que par le propriétaire du compte.
Charge utile:
{
 "fromTokenId": "fromTokenId value",
 "fromOrgId": "fromOrgId value",
 "fromUserId": "fromUserId value",
 "fromTokenQuantity": 1,
 "toTokenId": "toTokenId value",
 "toOrgId": "toOrgId value",
 "toUserId": "toUserId value",
 "toTokenQuantity": 1,
 "endorsers": {{endorsers}}
}
Paramètres :
  • fromTokenId: string : ID du jeton appartenant à l'expéditeur.
  • fromOrgId: string : ID du fournisseur de services d'adhésion de l'expéditeur dans l'organisation actuelle.
  • fromUserId: string : nom d'utilisateur ou ID courriel de l'expéditeur.
  • fromTokenQuantity: number : quantité de jetons de l'expéditeur à échanger avec le destinataire.
  • toTokenId: string : ID du jeton appartenant au récepteur.
  • toOrgId: string : ID du fournisseur de services d'adhésion du destinataire dans l'organisation actuelle.
  • toUserId: string : nom d'utilisateur ou ID courriel du destinataire.
  • toTokenQuantity: number : quantité de jetons du récepteur à échanger avec l'expéditeur.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
Renvoie :
  • En cas de succès, message avec les détails de l'échange de jetons.
Exemple de valeur renvoyée :
{
    "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
Nom de la méthode d'origine : getAccount
Cette méthode GET renvoie les détails du compte de jeton pour un utilisateur spécifié. Cette méthode peut uniquement être appelée par Token Admin du code chaîne ou par Account Owner du compte.
Interroger :
/getAccount?orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
Renvoie :
  • En cas de succès, objet JSON qui inclut les détails du compte de jeton.
Exemple de valeur renvoyée
{
    "assetType": "oaccount",
    "accountId": "oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371",
    "userId": "user2",
    "orgId": "AppBldFFFFMay22",
    "tokenType": "nonfungible",
    "noOfNfts": 3
}
getAccountDetailsByUser
Nom de la méthode d'origine : getAccountDetailsByUser
Cette méthode GET renvoie les détails du compte pour un utilisateur spécifié. Cette méthode peut uniquement être appelée par Token Admin du code chaîne ou par Account Owner du compte.
Interroger :
/getAccountDetailsByUser?orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
Exemple de valeur renvoyée :
{
    "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
Nom de la méthode d'origine : getAccountHistory
Cette méthode GET renvoie l'historique du compte pour un compte de jeton spécifié. Pour les comptes NFT, le paramètre tokenId doit être vide. Cette méthode peut uniquement être appelée par Token Admin du code chaîne ou par le propriétaire du compte.
Interroger :
/getAccountHistory?orgId={{bc-org-id}}&userId={{bc-user-id}}&tokenId={{bc-token-id}}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
  • tokenId: string : ID du jeton fongible.
Exemple de valeur renvoyée :
[
    {
        "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
Nom de la méthode d'origine : getAccountStatus
Cette méthode GET extrait l'état actuel du compte de jeton. Cette méthode peut être appelée par Token Admin du code chaîne ou par le propriétaire du compte de jeton.
Interroger :
/getAccountStatus?orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
Renvoie :
  • En cas de succès, représentation JSON du statut du compte de jeton.
Exemple de valeur renvoyée :
{
    "assetType": "oaccountStatus",
    "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
    "status": "active"
}
getAccountStatusHistory
Nom de la méthode d'origine : getAccountStatusHistory
Cette méthode GET extrait l'historique du statut du compte. Cette méthode peut être appelée par Token Admin du code chaîne ou par le propriétaire du compte de jeton.
Interroger :
/getAccountStatusHistory?orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
Renvoie :
  • En cas de succès, historique du statut du compte au format JSON.
Exemple de valeur renvoyée :
[
  {
    "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
Nom de la méthode d'origine : getAccountTransactionHistory
Cette méthode GET renvoie l'historique des transactions du compte. Cette méthode peut être appelée uniquement par un élément Token Admin du code chaîne ou par le propriétaire du compte.
Interroger :
/getAccountTransactionHistory?orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
Exemple de valeur renvoyée :
[
    {
        "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
Nom de la méthode d'origine : getAccountsByRole
Cette méthode renvoie la liste de tous les ID de compte pour un rôle donné. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.
Interroger :
/getAccountsByRole?role=role value (for example minter / burner)&tokenDetail={"tokenName":"tokenName value"}
Paramètres :
  • role: string : nom du rôle à rechercher.
  • tokenDetails: TokenDetail : détails qui spécifient le jeton. Pour les jetons fongibles, utilisez le format suivant :
    {"tokenId":"token1"}
    Pour les jetons non fongibles, utilisez le format suivant :
    {"tokenName":"artCollection"}
Exemple de valeur renvoyée :
{
  "accounts": [
    "oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a",
    "oaccount~60bb20c14a83f6e426e1437c479c5891e1c6477dfd7ad18b73acac5d80bc504b"
  ]
}
getAllAccounts
Nom de la méthode d'origine : getAllAccounts
Cette méthode GET renvoie les détails de tous les comptes utilisateur. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.
Interroger :
/getAllAccounts
Paramètres :
  • Aucun élément
Renvoie :
  • En cas de succès, tableau JSON de tous les comptes.
Exemple de valeur renvoyée :
[
        {
            "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
Nom de la méthode d'origine : getAllTokenAdmins
Cette méthode GET renvoie la liste de tous les utilisateurs qui sont un Token Admin du code chaîne. Cette méthode ne peut être appelée que par Token Admin du code chaîne.
Interroger :
/getAllTokenAdmins
Paramètres :
  • Aucun élément
Renvoie :
  • En cas de succès, tableau admins au format JSON contenant les objets orgId et userId.
Exemple de valeur renvoyée :
{
  "admins": [
    {
      "orgId": "appdev",
      "userId": "user2"
    },
    {
      "orgId": "appdev",
      "userId": "user1"
    }
  ]
}
getAllTokens
Nom de la méthode d'origine : getAllTokens
Cette méthode GET renvoie toutes les ressources de jeton enregistrées dans la base de données d'état. Cette méthode ne peut être appelée que par un Token Admin du code chaîne. Cette méthode utilise des requêtes Berkeley DB SQL riches et ne peut être appelée que lorsqu'elle est connectée au réseau Oracle Blockchain Platform distant.
Interroger :
/getAllTokens
Paramètres :
  • Aucun élément
Exemple de valeur renvoyée :
[{
            "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
Nom de la méthode d'origine : getAllTokensByUser
Cette méthode GET renvoie toutes les ressources de jeton appartenant à un utilisateur spécifié. Cette méthode utilise des requêtes Berkeley DB SQL riches et ne peut être appelée que lorsqu'elle est connectée au réseau Oracle Blockchain Platform distant. Cette méthode peut être appelée uniquement par un élément Token Admin du code chaîne ou par le propriétaire du compte.
Interroger :
/getAllTokensByUser?orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • org_id: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • user_id: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
Exemple de valeur renvoyée :
[{
            "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
Nom de la méthode d'origine : getTokenById
Cette méthode GET renvoie un objet de jeton si le jeton est présent dans la base de données d'état. Cette méthode peut uniquement être appelée par Token Admin du code chaîne ou par le propriétaire du jeton. Pour les NFT fractionnaires, la réponse inclut la liste des propriétaires de jetons.
Interroger :
/getTokenById?tokenId={{bc-token-id}}
Paramètres :
  • tokenId: string : ID du jeton à obtenir.
Exemple de valeur renvoyée :
[{
            "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
Nom de la méthode d'origine : getTokenDecimal
Cette méthode renvoie le nombre de décimales pour un jeton spécifié. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.
Interroger :
/getTokenDecimal?tokenId={{bc-token-id}}
Paramètres :
  • tokenId: string : ID du jeton.
Exemple de valeur renvoyée :
{
    "msg": "Token Id: tokenOne has 2 decimal places."
}
getTokenHistory
Nom de la méthode d'origine : getTokenHistory
Cette méthode GET renvoie l'historique d'un ID de jeton spécifié. N'importe qui peut appeler cette méthode.
/getTokenHistory?tokenId={{bc-token-id}}
Paramètres :
  • tokenId: string : ID du jeton.
Exemple de valeur renvoyée :
[{
            "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
Nom de la méthode d'origine : getTokensByName
Cette méthode GET renvoie toutes les ressources de jeton pour un nom de jeton spécifié. Cette méthode utilise des requêtes Berkeley DB SQL riches et ne peut être appelée que lorsqu'elle est connectée au réseau Oracle Blockchain Platform distant. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.
Interroger :
/getTokensByName?tokenName=tokenName value
Paramètres :
  • tokenName: string : nom du jeton.
Exemple de valeur renvoyée :
[
  {
    "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
Nom de la méthode d'origine : getTransactionById
Cette méthode GET renvoie l'historique des transactions pour un ID de transaction spécifié. Il s'agit d'une méthode asynchrone. Cette méthode peut être appelée par n'importe quel utilisateur.
Interroger :
/getTransactionById?transactionId=transactionId value
Paramètres :
  • transactionId: string : ID de la transaction, qui est le préfixe otransaction~ suivi du hachage 64 bits au format hexadécimal.
Exemple de valeur renvoyée :
{
  "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
Nom de la méthode d'origine : getUserByAccountId
Cette méthode GET renvoie l'ID organisation et l'ID utilisateur pour un ID compte spécifié.
Interroger :
/getUserByAccountId?accountId=accountId value
Paramètres :
  • accountId: string : ID du compte.
Exemple de valeur renvoyée :
{
    "orgId": "AppBldFFFFMay22",
    "userId": "user2"
}
getUsersByRole
Nom de la méthode d'origine : getUsersByRole
Cette méthode GET renvoie la liste de tous les utilisateurs pour un rôle spécifié.
Interroger :
/getUsersByRole?role=role value (for example minter / burner)&tokenDetail={"tokenName":"tokenName value"}
Paramètres :
  • role: string : nom du rôle à rechercher.
  • tokenDetail: TokenDetail : détails qui spécifient le jeton. Pour les jetons fongibles, utilisez le format suivant :
    {"tokenId":"token1"}
    Pour les jetons non fongibles, utilisez le format suivant :
    {"tokenName":"artCollection"}
Exemple de valeur renvoyée :
{
    "users": [
        {
            "accountId": "oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a",
            "orgId": "appdev",
            "userId": "user2"
        },
        {
            "accountId": "oaccount~60bb20c14a83f6e426e1437c479c5891e1c6477dfd7ad18b73acac5d80bc504b",
            "orgId": "appdev",
            "userId": "user1"
        }
    ]
}
init
Nom de la méthode d'origine : init
Cette méthode POST est appelée lorsque le code chaîne est déployé. Les informations utilisateur sont enregistrées en tant que Token Admin du code chaîne.
Charge utile:
{
 "adminList": "[{\"orgId\":\"{{bc-org-id}}\",\"userId\":\"{{bc-user-id}}\"}]"
}
Paramètres :
  • adminList array : tableau d'informations {user_id, org_id} qui indique la liste des administrateurs de jeton. Le tableau adminList est un paramètre obligatoire.
Renvoie :
  • En cas de succès, message sans charge utile.
Exemple de valeur renvoyée :
{

}
isInRole
Nom de la méthode d'origine : isInRole
Cette méthode GET renvoie une valeur booléenne pour indiquer si un utilisateur a un rôle spécifié. Cette méthode peut uniquement être appelée par Token Admin du code chaîne ou par Account Owner du compte.
Interroger :
/isInRole?orgId={{bc-org-id}}&userId={{bc-user-id}}&role=role value (for example minter / burner)&tokenDetail={"tokenName":"tokenName value"}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
  • role: string : nom du rôle à rechercher.
  • tokenDetail: TokenDetail : détails qui spécifient le jeton. Pour les jetons fongibles, utilisez le format suivant :
    {"tokenId":"token1"}
    Pour les jetons non fongibles, utilisez le format suivant :
    {"tokenName":"artCollection"}
Exemple de valeur renvoyée :
{
    "result": true,
    "msg": "Account Id oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a (Org-Id: appdev, User-Id: user2) has minter role"
}
isTokenAdmin
Nom de la méthode d'origine : isTokenAdmin
Cette méthode GET renvoie la valeur booléenne true si l'appelant de la fonction est Token Admin, sinon elle renvoie false. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.
Interroger :
/isTokenAdmin?orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
Renvoie :
  • La méthode renvoie true si l'appelant est Token Admin, sinon elle renvoie false.
Exemple de valeur renvoyée :
{
  "result": true
}
mintBatch
Nom de la méthode d'origine : mintBatch
Cette méthode POST crée (affecte) plusieurs jetons dans une opération par lots. Cette méthode crée uniquement des jetons fongibles ou des jetons non fongibles fractionnaires.

Pour les jetons fongibles, si le rôle minter est défini dans le fichier de spécification, tout utilisateur disposant du rôle minter peut appeler cette méthode. Sinon, n'importe quel utilisateur peut utiliser cette méthode pour frapper des jetons. Vous ne pouvez pas dépasser la propriété max_mint_quantity du jeton si cette propriété a été spécifiée lors de la création ou de la mise à jour du jeton.

Pour les jetons non fongibles, si le rôle minter est défini dans le fichier de spécification, tout utilisateur disposant du rôle minter peut appeler cette méthode. Sinon, n'importe quel utilisateur peut utiliser cette méthode pour frapper des jetons. En outre, l'appelant doit également être le créateur du jeton. Il n'y a pas de limite supérieure à la quantité de jetons fractionnaires non fongibles qui peuvent être frappés.

Vous ne pouvez pas utiliser cette méthode pour frapper un jeton non fongible entier.

Charge utile:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "tokenIds": "[\"{{bc-token-id}}\"]",
 "quantity": "[quantity value]",
 "sameOrgEndorser": true
}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
  • tokenIds: string[] : liste des ID de jeton pour lesquels les jetons ment.
  • quantity: number[] : liste des quantités de jetons à menthe, correspondant au tableau d'ID de jeton.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations de transaction doivent provenir de la même organisation que le demandeur.
Renvoie :
  • En cas de succès, objet JSON qui inclut des détails sur les jetons extraits.
Exemple de valeur renvoyée :
{
    "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
Nom de la méthode d'origine : name
Cette méthode GET renvoie le nom de la classe de jeton. N'importe qui peut appeler cette méthode.
Interroger :
/name?tokenId={{bc-token-id}}
Paramètres :
  • tokenId: string : ID du jeton.
Exemple de valeur renvoyée :
{
    "tokenName": "artcollection"
}
ownerOf
Nom de la méthode d'origine : ownerOf
Cette méthode GET renvoie l'ID de compte des propriétaires de l'ID de jeton spécifié. N'importe qui peut appeler cette méthode.
Interroger :
/ownerOf?tokenId={{bc-token-id}}
Paramètres :
  • tokenId: string : ID du jeton.
Renvoie :
  • Objet JSON des ID de compte des propriétaires.
Exemple de valeur renvoyée :
[
    {
        "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
        "orgId": "Org1MSP",
        "userId": "admin"
    },
    {
        "accountId": "oaccount~74108eca702bab6d8548e740254f2cc7955d886885251d52d065042172a59db0",
        "orgId": "Org1MSP",
        "userId": "user"
    }
]
post
Nom de la méthode d'origine : post
Cette méthode POST publie un jeton à vendre pour un prix spécifié.
Charge utile:
{
 "tokenId": "{{bc-token-id}}",
 "sellingPrice": 1,
 "endorsers": {{endorsers}}
}
Paramètres :
  • tokenId: string : ID du jeton.
  • sellingPrice: number : prix du jeton.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
Exemple de valeur renvoyée :
{
  "msg": "Token ID : 'artCollection1' has been posted for selling in the marketplace"          
}
removeRole
Nom de la méthode d'origine : removeRole
Cette méthode supprime un rôle d'un utilisateur spécifié. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.
Charge utile:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "role": "role value (for example minter / burner)",
 "tokenDetail": "{\"tokenName\":\"tokenName value\"}",
 "endorsers": {{endorsers}}
}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
  • role: string : nom du rôle à enlever de l'utilisateur spécifié.
  • tokenDetail: TokenDetail : détails qui spécifient le jeton. Pour les jetons fongibles, utilisez le format suivant :
    {"tokenId":"token1"}
    Pour les jetons non fongibles, utilisez le format suivant :
    {"tokenName":"artCollection"}
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
Exemple de valeur renvoyée :
{
  "msg": "Successfully removed role 'minter' from Account Id: oaccount~60bb20c14a83f6e426e1437c479c5891e1c6477dfd7ad18b73acac5d80bc504b (Org-Id: appdev, User-Id: user1)"
}
removeTokenAdmin
Nom de la méthode d'origine : removeTokenAdmin
Cette méthode POST supprime un utilisateur en tant que Token Admin du code chaîne. Cette méthode ne peut être appelée que par un Token Admin du code chaîne. Un administrateur ne peut pas se retirer lui-même.
Charge utile:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "sameOrgEndorser": true
}
Paramètres :
  • org_id: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • user_id: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
  • sameOrgEndorser: boolean : valeur booléenne qui indique si les approbations de transaction doivent provenir de la même organisation que le demandeur.
Exemple de valeur renvoyée :
{
  "msg": "Successfully removed Admin (OrgId: appDev, UserId: user1)"
}
safeBatchTransferFrom
Nom de la méthode d'origine : safeBatchTransferFrom
Cette méthode POST transfère la propriété des jetons spécifiés de l'appelant vers un autre compte. L'appelant de cette méthode doit être l'expéditeur des jetons et doit être propriétaire des jetons spécifiés. Pour les NFT fractionnaires, si un utilisateur transfère la totalité de ses parts à un autre utilisateur, il perd la propriété du jeton.
Charge utile:
{
 "fromOrgId": "fromOrgId value",
 "fromUserId": "fromUserId value",
 "toOrgId": "toOrgId value",
 "toUserId": "toUserId value",
 "tokenIds": "[\"{{bc-token-id}}\"]",
 "quantity": "[quantity value]",
 "endorsers": {{endorsers}}
}
Paramètres :
  • fromOrgId: string : ID du fournisseur de services d'adhésion de l'expéditeur et du propriétaire du jeton dans l'organisation actuelle.
  • fromUserId: string : nom d'utilisateur ou ID de courriel de l'expéditeur et du propriétaire du jeton.
  • toOrgId: string : ID du fournisseur de services d'adhésion du destinataire dans l'organisation actuelle.
  • toUserId: string : nom d'utilisateur ou ID courriel du destinataire.
  • tokenIds: string[] : tableau des ID des jetons à transférer.
  • quantity: number[] : liste des quantités de jetons à transférer, correspondant au tableau d'ID de jeton.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
Exemple de valeur renvoyée :
[
    {
        "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
Nom de la méthode d'origine : suspendAccount
Cette méthode POST suspend un compte de jeton fongible. Il génère une erreur si aucune valeur accountStatus n'est trouvée dans le livre. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.
Charge utile:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
Paramètres :
  • orgId: string : ID du fournisseur de services d'adhésion de l'utilisateur dans l'organisation actuelle.
  • userId: string : nom d'utilisateur ou ID de courriel de l'utilisateur.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
Exemple de valeur renvoyée :
{
    "assetType": "oaccountStatus",
    "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
    "status": "suspended"
}
totalNetSupply
Nom de la méthode d'origine : totalNetSupply
Cette méthode GET renvoie le nombre total de jetons frappés moins le nombre de jetons brûlés. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.
Requête (jetons fongibles) :
/totalNetSupply?tokenDetail={"tokenId":"{{bc-token-id}}"}
Requête (jetons non fongibles) :
/totalNetSupply?tokenDetail={"tokenName":"tokenName value"}
Paramètres :
  • tokenDetail: TokenDetail : détails qui spécifient le jeton. Pour les jetons fongibles, utilisez le format suivant :
    {"tokenId":"token1"}
    Pour les jetons non fongibles, utilisez le format suivant :
    {"tokenName":"artCollection"}
Exemple de valeur renvoyée :
{
    "totalNetSupply": 105
}
totalSupply
Nom de la méthode d'origine : totalSupply
Cette méthode GET renvoie le nombre total de jetons extraits. Cette méthode ne peut être appelée que par un Token Admin du code chaîne.
Requête (jetons fongibles) :
/totalSupply?tokenDetail={"tokenId":"{{bc-token-id}}"}
Requête (jetons non fongibles) :
/totalSupply?tokenDetail={"tokenName":"tokenName value"}
Paramètres :
  • tokenDetail: TokenDetail : détails qui spécifient le jeton. Pour les jetons fongibles, utilisez le format suivant :
    {"tokenId":"token1"}
    Pour les jetons non fongibles, utilisez le format suivant :
    {"tokenName":"artCollection"}
Exemple de valeur renvoyée :
{
    "totalSupply": 110
}
updateArtCollectionToken
Nom de la méthode d'origine : updateArtCollectionToken
Cette méthode POST met à jour les propriétés du jeton. Seul le propriétaire du jeton peut appeler cette méthode. Pour les NFT, les métadonnées de jeton et l'URI de jeton ne peuvent pas être mis à jour une fois le jeton extrait.
Charge utile:
{
 "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
}
Paramètres :
  • tokenAsset: <Token Class> : ressource de jeton à mettre à jour. Pour plus d'informations sur les propriétés de la ressource de jeton, reportez-vous au fichier de spécification d'entrée.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
Exemple de valeur renvoyée :
{
            "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
Nom de la méthode d'origine : updateLoyaltyToken
Cette méthode POST met à jour les propriétés du jeton. Seul le propriétaire du jeton peut appeler cette méthode. Pour les NFT, les métadonnées de jeton et l'URI de jeton ne peuvent pas être mis à jour une fois le jeton extrait.
Charge utile:
{
 "tokenAsset": "{\"tokenId\":\"{{bc-token-id}}\",\"tokenDesc\":\"tokenDesc value\",\"Token_Name\":\"Token_Name value\",\"Token_to_Currency_Ratio\":999}",
 "sameOrgEndorser": true
}
Paramètres :
  • tokenAsset: <Token Class> : ressource de jeton à mettre à jour. Pour plus d'informations sur les propriétés de la ressource de jeton, reportez-vous au fichier de spécification d'entrée.
  • endorsers: string[] : tableau des homologues (par exemple, peer1, peer2) qui doit approuver la transaction.
Exemple de valeur renvoyée :
{
            "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
Nom de la méthode d'origine : URI
Cette méthode GET renvoie l'URI d'un jeton spécifié. Seul le créateur du jeton peut appeler cette méthode.
Requête
/URI?tokenId={{bc-token-id}}
Paramètres :
  • tokenId: string : ID du jeton.
Exemple de valeur renvoyée :
{
    "tokenUri": "example.com"
}