Ensemble d'API d'encapsuleur de cadre de jeton combiné

Oracle Blockchain Platform Digital Assets Edition comprend un ensemble d'API wrapper qui étend l'API REST afin de prendre en charge des opérations propres à un marché NFT de collection.

L'ensemble d'API wrapper utilise le service de passerelle d'API et le service des fonctions pour OCI pour déployer des routes d'API spécialement conçues pour l'application Marketplace de collection. L'ensemble d'API d'encapsulation de cadre de jeton non fongible peut être téléchargé à partir de la console Oracle Blockchain Platform et comprend les composants suivants.
  • NFTCollectiblesWithERC1155WrapperAPI.zip, un fichier d'archives contenant l'ensemble d'API d'encapsuleur, y compris les scripts Terraform requis pour le déploiement. Vous déployez ce fichier dans une pile du gestionnaire de ressources sur Oracle Cloud Infrastructure (OCI) pour créer les ressources Oracle nécessaires pour les API Wrapper.
  • NFTCollectiblesWithERC1155_WrapperAPI.postman_collection.json, une collection Postman qui vous permet de tester les API d'encapsuleur déployées. La collection comprend des demandes préconfigurées avec des points d'extrémité et des données utiles qui correspondent aux API définies dans l'ensemble d'API wrapper.

API d'encapsulation

activateAccount
Nom de la méthode initiale : activateAccount
Cette méthode POST active un compte de jeton. Cette méthode ne peut être appelée que par un administrateur ou un responsable de compte. Pour les comptes existants où accountStatus est introuvable dans le livre, la méthode retourne un objet accountStatus avec le statut réglé à active.
Données utiles :
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
Paramètres :
  • tokenId: string - ID du jeton.
  • orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
  • endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.
Retours :
  • En cas de succès, une représentation JSON de l'objet de statut de compte mis à jour pour le compte de jeton fongible.
Exemple de valeur de retour :
{
  "assetType": "oaccountStatus",
  "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
  "status": "active"
}
addTokenAdmin
Nom de la méthode initiale : addTokenAdmin
Cette méthode POST ajoute un utilisateur en tant que Token Admin du code de chaîne. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.
Données utiles :
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
Paramètres :
  • orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
  • endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.
Retours :
  • Au succès, un message comprend les détails de l'utilisateur qui a été ajouté comme Token Admin du code de chaîne.
Exemple de valeur de retour :
{
  "msg": "Successfully added Admin (OrgId: appDev, UserId: user1)"
}
addRole
Nom de la méthode initiale : 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 élément Token Admin du code de chaîne. Les jetons fongibles du paramètre tokenDetails nécessitent la valeur tokenId comme entrée. Les jetons non fongibles nécessitent tokenName comme entrée, pour que nous utilisions le paramètre tokenDetail pour spécifier les détails des jetons fongibles et non fongibles différemment.
Données utiles :
{
    "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 fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID 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 pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.
Exemple de valeur de retour :
{
  "msg": "Successfully added role 'minter' to Account Id: oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a 
(Org-Id: appdev, User-Id: user2)"
}
associateFungibleTokenToAccount
Nom de la méthode initiale : associateFungibleTokenToAccount
Cette méthode POST associe le compte de jeton fongible d'un utilisateur à un jeton spécifié.
Données utiles :
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
Paramètres :
  • tokenId: string - ID du jeton.
  • orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
  • endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.
Exemple de valeur de retour :
{
  "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 initiale : buyWithEthCoin
Tout propriétaire de compte peut utiliser cette méthode POST pour acheter un NFT en utilisant Ethereum et transférer des jetons de fidélité en tant que points de récompense.
Données utiles :
{
   "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 fournisseur de services d'adhésion (MSP) de l'expéditeur (propriétaire) dans l'organisation courante.
  • fromUserId: string - Nom d'utilisateur ou ID courriel de l'expéditeur (responsable).
  • toOrgId: string - ID fournisseur de services d'adhésion (MSP) du destinataire dans l'organisation courante.
  • 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 pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.
Exemple de valeur de retour :
{
  "msg": "Token ID : 'artcollection1' has been successfully transferred to UserID : 'user1'"
}
balanceOfBatch
Nom de la méthode initiale : balanceOfBatch
Cette méthode GET termine une opération par lots qui extrait les soldes des comptes de jetons. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne ou par le responsable du compte.
Interrogation :
/balanceOfBatch?orgIds=["{{bc-org-id}}"]&userIds=["{{bc-user-id}}"]&tokenIds=["{{bc-token-id}}"]
Paramètres :
  • orgIds: string[] - Liste des ID fournisseur de services d'adhésion (MSP) dans l'organisation courante.
  • userIds: string[] - Liste du nom d'utilisateur ou des ID courriel.
  • tokenIds: string[] - Liste des ID jetons.
Exemple de valeur de retour :
[
    {
        "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 initiale : batchTransferFrom
Cette méthode POST termine une opération par lots qui transfère les jetons spécifiés dans une liste d'ID jeton d'un utilisateur à un autre. Cette méthode peut être appelée par n'importe quel utilisateur.
Données utiles :
{
 "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 fournisseur de services d'adhésion de l'expéditeur.
  • fromUserId: string - ID utilisateur de l'expéditeur.
  • toOrgId: string - ID fournisseur de services d'adhésion (MSP) du destinataire.
  • toUserId: string - ID utilisateur du destinataire.
  • tokenIds: string[] - Liste des ID jetons pour les jetons à transférer.
  • quantity: number[] - Liste des quantités de jetons à transférer, correspondant au tableau d'ID jeton.
  • endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.
Retours :
  • En cas de succès, un message contenant les détails de chaque transfert de jeton.
Exemple de valeur de retour :
[
    {
        "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 initiale : burnBatch
Cette méthode POST désactive ou brûle les jetons fongibles et non fongibles spécifiés. Tout utilisateur ayant le rôle de brûleur peut appeler cette méthode.
Données utiles :
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "tokenIds": "[\"{{bc-token-id}}\"]",
 "quantity": "[quantity value]",
 "sameOrgEndorser": true
}
Paramètres :
  • orgId: string - ID fournisseur de services d'adhésion (MSP) dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID courriel.
  • tokenIds: string[] - Liste des ID jetons à graver
  • quantity: number[] - Liste des quantités de jetons à graver, correspondant au tableau d'ID jeton.
  • sameOrgEndorser: boolean - Valeur booléenne indiquant si les endossements de transaction doivent provenir de la même organisation que le demandeur.
Retours :
  • En cas de succès, un message contenant des détails sur les opérations de gravure.
Exemple de valeur de retour :
[
  {
    "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 initiale : burnNFT
Cette méthode POST désactive ou grave le jeton non fongible spécifié et retourne un objet de jeton et un historique de jeton. Tout utilisateur ayant le rôle de brûleur peut appeler cette méthode.
Données utiles :
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "tokenId": "{{bc-token-id}}",
 "sameOrgEndorser": true
}
Paramètres :
  • orgId: string - ID fournisseur de services d'adhésion (MSP) dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID courriel.
  • tokenId: string - ID du jeton non fongible à brûler
  • sameOrgEndorser: boolean - Valeur booléenne indiquant si les endossements de transaction doivent provenir de la même organisation que le demandeur.
Retours :
  • En cas de succès, un tableau JSON contenant un message sur l'opération de gravure.
Exemple de valeur de retour :
{
    "msg": "Successfully burned NFT token: 'art' from Account-Id: oaccount~76cb672eeb1bd535899562a840d0c15a356db89e24bc8b43ac1dba845a4282c6 (Org-Id: appdev, User-Id: user2)"
  }
createAccount
Nom de la méthode initiale : createAccount
Cette méthode POST crée un compte pour un utilisateur spécifié et les comptes de jeton 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 suit le compte NFT et les comptes jetons fongibles qu'un utilisateur détient. Les utilisateurs doivent avoir des comptes dans le réseau pour effectuer les opérations liées aux jetons. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

Un compte d'utilisateur a un ID unique, qui est 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 compte de jeton fongible sont formés par un hachage SHA-256 du paramètre orgId, du paramètre userId, de la chaîne constante ft séparée par le symbole tilde (~), et d'un numéro de compteur qui signifie l'index du compte fongible en cours de création séparé par le symbole tilde (~).

Un utilisateur ne peut avoir qu'un seul compte de jeton non fongible. Les ID 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 compte d'utilisateur commencent par ouaccount~. Les ID compte de jeton commencent par oaccount~.

Données utiles :
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "ftAccount": true,
 "nftAccount": true,
 "endorsers": {{endorsers}}
}
Paramètres :
  • orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
  • ftAccount: boolean - Si la valeur est Vrai, un compte de jeton fongible est créé et associé au compte d'utilisateur.
  • nftAccount: boolean - Si la valeur est Vrai, un compte de jeton non fongible est créé et associé au compte d'utilisateur.
  • endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.
Exemple de valeur de retour :
{
  "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 initiale : createArtCollectionToken
Cette méthode POST crée (mints) 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 de la 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 de filtre. Sinon, n'importe quel appelant peut extraire des NFT.
Données utiles :
{
 "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 à extraire. Pour plus d'informations sur les propriétés de la ressource de jeton, voir le 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 indiquant si les endossements de transaction doivent provenir de la même organisation que le demandeur.
Exemple de valeur de retour :
{
            "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 initiale : createLoyaltyToken
Cette méthode POST crée des jetons. Chaque jeton défini a sa propre méthode de création. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.
Données utiles :
{
 "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 indiquant si les endossements de transaction doivent provenir de la même organisation que le demandeur.
Exemple de valeur de retour :
{
            "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 initiale : createTokenAccount
Cette méthode POST crée un compte de jeton fongible ou non fongible à associer à un compte d'utilisateur.

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

Un utilisateur ne peut avoir qu'un seul compte de jeton non fongible. Les ID 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 élément Token Admin du code de chaîne.

Données utiles :
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "tokenType": "nonfungible",
 "endorsers": {{endorsers}}
}
Paramètres :
  • orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID 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 pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.
Retours :
  • En cas de réussite, un objet JSON du compte de jeton créé.
Exemple de valeur de retour :
{
  "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 initiale : 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 suit le compte NFT et les comptes jetons fongibles qu'un utilisateur possède. Les utilisateurs doivent avoir des comptes dans le réseau pour effectuer les opérations liées aux jetons.

Un ID 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 élément Token Admin du code de chaîne.

Données utiles :
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "endorsers": {{endorsers}}
}
Paramètres :
  • orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
  • endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.
Retours :
  • En cas de réussite, un objet JSON du compte d'utilisateur qui a été créé.
Exemple de valeur de retour :
{
  "assetType": "ouaccount",
  "accountId": "ouaccount~24ffd4d32a028a85b4b960f5d55536c837b5429bc7f346150adfa904ec2937cc",
  "userId": "user2",
  "orgId": "appdev",
  "totalAccounts": 0,
  "totalFtAccounts": 0,
  "associatedFtAccounts": [],
  "associatedNftAccount": ""
}
deleteAccount
Nom de la méthode initiale : deleteAccount
Cette méthode POST supprime un compte de jeton. Après la suppression d'un compte, celui-ci est à l'état final et ne peut pas être mis à jour ni modifié à un autre état. Pour supprimer un compte, le solde doit être égal à zéro. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.
Données utiles :
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "endorsers": {{endorsers}}
}
Paramètres :
  • orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
  • endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.
Retours :
  • En cas de succès, une représentation JSON du statut du compte de jeton.
Exemple de valeur de retour :
{
  "assetType": "oaccountStatus",
  "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
  "status": "deleted"
}
exchangeToken
Nom de la méthode initiale : exchangeToken
Cette méthode échange des jetons entre les comptes spécifiés. Cette méthode ne prend en charge que 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 responsable du compte.
Données utiles :
{
 "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 dont l'expéditeur est responsable.
  • fromOrgId: string - ID fournisseur de services d'adhésion (MSP) de l'expéditeur dans l'organisation courante.
  • 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 dont le destinataire est responsable.
  • toOrgId: string - ID fournisseur de services d'adhésion (MSP) du destinataire dans l'organisation courante.
  • 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 pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.
Retours :
  • En cas de succès, un message contenant les détails de l'échange de jeton.
Exemple de valeur de retour :
{
    "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 initiale : getAccount
Cette méthode GET retourne les détails du compte de jeton pour un utilisateur spécifié. Cette méthode ne peut être appelée que par Token Admin du code de chaîne ou par Account Owner du compte.
Interrogation :
/getAccount?orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
Retours :
  • En cas de réussite, un objet JSON qui inclut les détails du compte de jeton.
Exemple de valeur de retour
{
    "assetType": "oaccount",
    "accountId": "oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371",
    "userId": "user2",
    "orgId": "AppBldFFFFMay22",
    "tokenType": "nonfungible",
    "noOfNfts": 3
}
getAccountDetailsByUser
Nom de la méthode initiale : getAccountDetailsByUser
Cette méthode GET retourne les détails du compte pour un utilisateur spécifié. Cette méthode ne peut être appelée que par Token Admin du code de chaîne ou par Account Owner du compte.
Interrogation :
/getAccountDetailsByUser?orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
Exemple de valeur de retour :
{
    "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 initiale : getAccountHistory
Cette méthode GET retourne 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 ne peut être appelée que par la chaîne Token Admin du code de chaîne ou par le responsable du compte.
Interrogation :
/getAccountHistory?orgId={{bc-org-id}}&userId={{bc-user-id}}&tokenId={{bc-token-id}}
Paramètres :
  • orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
  • tokenId: string - ID du jeton fongible.
Exemple de valeur de retour :
[
    {
        "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 initiale : getAccountStatus
Cette méthode GET extrait le statut courant du compte de jeton. Cette méthode peut être appelée par la chaîne Token Admin du code de chaîne ou par le responsable du compte de jeton.
Interrogation :
/getAccountStatus?orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
Retours :
  • En cas de succès, une représentation JSON du statut du compte de jeton.
Exemple de valeur de retour :
{
    "assetType": "oaccountStatus",
    "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
    "status": "active"
}
getAccountStatusHistory
Nom de la méthode initiale : getAccountStatusHistory
Cette méthode GET extrait l'historique du statut du compte. Cette méthode peut être appelée par la chaîne Token Admin du code de chaîne ou par le responsable du compte de jeton.
Interrogation :
/getAccountStatusHistory?orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
Retours :
  • En cas de succès, l'historique des statuts de compte au format JSON.
Exemple de valeur de retour :
[
  {
    "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 initiale : getAccountTransactionHistory
Cette méthode GET retourne l'historique des transactions de compte. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne ou par le responsable du compte.
Interrogation :
/getAccountTransactionHistory?orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
Exemple de valeur de retour :
[
    {
        "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 initiale : getAccountsByRole
Cette méthode retourne une liste de tous les ID compte pour un rôle spécifié. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.
Interrogation :
/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 de retour :
{
  "accounts": [
    "oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a",
    "oaccount~60bb20c14a83f6e426e1437c479c5891e1c6477dfd7ad18b73acac5d80bc504b"
  ]
}
getAllAccounts
Nom de la méthode initiale : getAllAccounts
Cette méthode GET retourne les détails de tous les comptes d'utilisateur. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.
Interrogation :
/getAllAccounts
Paramètres :
  • aucune
Retours :
  • En cas de succès, un tableau JSON de tous les comptes.
Exemple de valeur de retour :
[
        {
            "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 initiale : getAllTokenAdmins
Cette méthode GET retourne une liste de tous les utilisateurs qui sont un Token Admin du code de chaîne. Cette méthode ne peut être appelée que par la chaîne Token Admin du code de chaîne.
Interrogation :
/getAllTokenAdmins
Paramètres :
  • aucune
Retours :
  • En cas de succès, un tableau admins au format JSON contenant les objets orgId et userId.
Exemple de valeur de retour :
{
  "admins": [
    {
      "orgId": "appdev",
      "userId": "user2"
    },
    {
      "orgId": "appdev",
      "userId": "user1"
    }
  ]
}
getAllTokens
Nom de la méthode initiale : getAllTokens
Cette méthode GET retourne 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 élément Token Admin du code de chaîne. Cette méthode utilise des interrogations SQL enrichies Berkeley DB et ne peut être appelée que lorsqu'elle est connectée au réseau Oracle Blockchain Platform distant.
Interrogation :
/getAllTokens
Paramètres :
  • aucune
Exemple de valeur de retour :
[{
            "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 initiale : getAllTokensByUser
Cette méthode GET retourne toutes les ressources de jeton appartenant à un utilisateur spécifié. Cette méthode utilise des interrogations SQL enrichies Berkeley DB 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 élément Token Admin du code de chaîne ou par le responsable du compte.
Interrogation :
/getAllTokensByUser?orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
Exemple de valeur de retour :
[{
            "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 initiale : getTokenById
Cette méthode GET retourne un objet de jeton si le jeton est présent dans la base de données d'état. Cette méthode ne peut être appelée que par Token Admin du code de chaîne ou du responsable du jeton. Pour les NFT fractionnaires, la réponse inclut la liste des propriétaires de jeton.
Interrogation :
/getTokenById?tokenId={{bc-token-id}}
Paramètres :
  • tokenId: string - ID du jeton à obtenir.
Exemple de valeur de retour :
[{
            "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 initiale : getTokenDecimal
Cette méthode retourne le nombre de décimales pour un jeton spécifié. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.
Interrogation :
/getTokenDecimal?tokenId={{bc-token-id}}
Paramètres :
  • tokenId: string - ID du jeton.
Exemple de valeur de retour :
{
    "msg": "Token Id: tokenOne has 2 decimal places."
}
getTokenHistory
Nom de la méthode initiale : getTokenHistory
Cette méthode GET retourne l'historique pour un ID jeton spécifié. Tout le monde peut appeler cette méthode.
/getTokenHistory?tokenId={{bc-token-id}}
Paramètres :
  • tokenId: string - ID du jeton.
Exemple de valeur de retour :
[{
            "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 initiale : getTokensByName
Cette méthode GET retourne toutes les ressources de jeton pour un nom de jeton spécifié. Cette méthode utilise des interrogations SQL enrichies Berkeley DB 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 élément Token Admin du code de chaîne.
Interrogation :
/getTokensByName?tokenName=tokenName value
Paramètres :
  • tokenName: string - Nom du jeton.
Exemple de valeur de retour :
[
  {
    "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 initiale : getTransactionById
Cette méthode GET retourne l'historique des transactions pour un ID transaction spécifié. Il s'agit d'une méthode asynchrone. Cette méthode peut être appelée par n'importe quel utilisateur.
Interrogation :
/getTransactionById?transactionId=transactionId value
Paramètres :
  • transactionId: string - ID de la transaction, qui est le préfixe otransaction~ suivi du code de hachage à 64 bits au format hexadécimal.
Exemple de valeur de retour :
{
  "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 initiale : getUserByAccountId
Cette méthode GET retourne l'ID organisation et l'ID utilisateur pour un ID compte spécifié.
Interrogation :
/getUserByAccountId?accountId=accountId value
Paramètres :
  • accountId: string - ID du compte.
Exemple de valeur de retour :
{
    "orgId": "AppBldFFFFMay22",
    "userId": "user2"
}
getUsersByRole
Nom de la méthode initiale : getUsersByRole
Cette méthode GET retourne une liste de tous les utilisateurs pour un rôle spécifié.
Interrogation :
/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 de retour :
{
    "users": [
        {
            "accountId": "oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a",
            "orgId": "appdev",
            "userId": "user2"
        },
        {
            "accountId": "oaccount~60bb20c14a83f6e426e1437c479c5891e1c6477dfd7ad18b73acac5d80bc504b",
            "orgId": "appdev",
            "userId": "user1"
        }
    ]
}
init
Nom de la méthode initiale : init
Cette méthode POST est appelée lorsque le code de chaîne est déployé. Les informations sur l'utilisateur sont enregistrées en tant que Token Admin du code de chaîne.
Données utiles :
{
 "adminList": "[{\"orgId\":\"{{bc-org-id}}\",\"userId\":\"{{bc-user-id}}\"}]"
}
Paramètres :
  • adminList array - Tableau d'informations {user_id, org_id} qui spécifie la liste des administrateurs de jetons. Le tableau adminList est un paramètre obligatoire.
Retours :
  • En cas de succès, un message sans données utiles.
Exemple de valeur de retour :
{

}
isInRole
Nom de la méthode initiale : isInRole
Cette méthode GET retourne une valeur booléenne pour indiquer si un utilisateur a un rôle spécifié. Cette méthode ne peut être appelée que par Token Admin du code de chaîne ou par Account Owner du compte.
Interrogation :
/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 fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID 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 de retour :
{
    "result": true,
    "msg": "Account Id oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a (Org-Id: appdev, User-Id: user2) has minter role"
}
isTokenAdmin
Nom de la méthode initiale : isTokenAdmin
Cette méthode GET retourne la valeur booléenne true si l'appelant de la fonction est Token Admin, sinon elle retourne false. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.
Interrogation :
/isTokenAdmin?orgId={{bc-org-id}}&userId={{bc-user-id}}
Paramètres :
  • orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
Retours :
  • La méthode retourne true si l'appelant est un Token Admin, sinon elle retourne false.
Exemple de valeur de retour :
{
  "result": true
}
mintBatch
Nom de la méthode initiale : mintBatch
Cette méthode POST crée (mine) plusieurs jetons dans une opération par lots. Cette méthode ne crée que des jetons fongibles ou des jetons fractionnaires non fongibles.

Pour les jetons fongibles, si le rôle de mineur est défini dans le fichier de spécification, tout utilisateur doté du rôle de mineur peut appeler cette méthode. Sinon, n'importe quel utilisateur peut utiliser cette méthode pour mentonner des jetons. Vous ne pouvez pas extraire plus de 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 de mineur est défini dans le fichier de spécification, tout utilisateur doté du rôle de mineur peut appeler cette méthode. Sinon, n'importe quel utilisateur peut utiliser cette méthode pour mentonner 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 extraire un jeton non fongible entier.

Données utiles :
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "tokenIds": "[\"{{bc-token-id}}\"]",
 "quantity": "[quantity value]",
 "sameOrgEndorser": true
}
Paramètres :
  • orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
  • tokenIds: string[] - Liste des ID jetons pour lesquels créer des jetons.
  • quantity: number[] - Liste des quantités de jetons à menthe, correspondant au tableau d'ID jeton.
  • sameOrgEndorser: boolean - Valeur booléenne indiquant si les endossements de transaction doivent provenir de la même organisation que le demandeur.
Retours :
  • En cas de réussite, un objet JSON qui inclut les détails sur les jetons frappés.
Exemple de valeur de retour :
{
    "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 initiale : name
Cette méthode GET retourne le nom de la classe de jeton. Tout le monde peut appeler cette méthode.
Interrogation :
/name?tokenId={{bc-token-id}}
Paramètres :
  • tokenId: string - ID du jeton.
Exemple de valeur de retour :
{
    "tokenName": "artcollection"
}
ownerOf
Nom de la méthode initiale : ownerOf
Cette méthode GET retourne l'ID compte des responsables de l'ID jeton spécifié. Tout le monde peut appeler cette méthode.
Interrogation :
/ownerOf?tokenId={{bc-token-id}}
Paramètres :
  • tokenId: string - ID du jeton.
Retours :
  • Objet JSON des ID compte des responsables.
Exemple de valeur de retour :
[
    {
        "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
        "orgId": "Org1MSP",
        "userId": "admin"
    },
    {
        "accountId": "oaccount~74108eca702bab6d8548e740254f2cc7955d886885251d52d065042172a59db0",
        "orgId": "Org1MSP",
        "userId": "user"
    }
]
post
Nom de la méthode initiale : post
Cette méthode POST publie un jeton à vendre pour un prix spécifié.
Données utiles :
{
 "tokenId": "{{bc-token-id}}",
 "sellingPrice": 1,
 "endorsers": {{endorsers}}
}
Paramètres :
  • tokenId: string - ID du jeton.
  • sellingPrice: number - Prix du jeton.
  • endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.
Exemple de valeur de retour :
{
  "msg": "Token ID : 'artCollection1' has been posted for selling in the marketplace"          
}
removeRole
Nom de la méthode initiale : removeRole
Cette méthode supprime un rôle d'un utilisateur spécifié. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.
Données utiles :
{
 "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 fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
  • role: string - Nom du rôle à supprimer 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 pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.
Exemple de valeur de retour :
{
  "msg": "Successfully removed role 'minter' from Account Id: oaccount~60bb20c14a83f6e426e1437c479c5891e1c6477dfd7ad18b73acac5d80bc504b (Org-Id: appdev, User-Id: user1)"
}
removeTokenAdmin
Nom de la méthode initiale : removeTokenAdmin
Cette méthode POST supprime un utilisateur en tant que Token Admin du code de chaîne. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne. Un administrateur ne peut pas se supprimer lui-même.
Données utiles :
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "sameOrgEndorser": true
}
Paramètres :
  • org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
  • sameOrgEndorser: boolean - Valeur booléenne indiquant si les endossements de transaction doivent provenir de la même organisation que le demandeur.
Exemple de valeur de retour :
{
  "msg": "Successfully removed Admin (OrgId: appDev, UserId: user1)"
}
safeBatchTransferFrom
Nom de la méthode initiale : safeBatchTransferFrom
Cette méthode POST transfère la propriété des jetons spécifiés de l'appelant à un autre compte. L'appelant de cette méthode doit être l'expéditeur des jetons et posséder les jetons spécifiés. Pour les NFT fractionnaires, si un utilisateur transfère toutes ses actions à un autre utilisateur, il perd la propriété du jeton.
Données utiles :
{
 "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 fournisseur de services d'adhésion (MSP) de l'expéditeur et du responsable du jeton dans l'organisation courante.
  • fromUserId: string - Nom d'utilisateur ou ID courriel de l'expéditeur et du responsable du jeton.
  • toOrgId: string - ID fournisseur de services d'adhésion (MSP) du destinataire dans l'organisation courante.
  • 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 jeton.
  • endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.
Exemple de valeur de retour :
[
    {
        "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 initiale : suspendAccount
Cette méthode POST suspend un compte de jeton fongible. Une erreur est générée si aucune valeur accountStatus n'est trouvée dans le livre. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.
Données utiles :
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
Paramètres :
  • orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
  • userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
  • endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.
Exemple de valeur de retour :
{
    "assetType": "oaccountStatus",
    "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
    "status": "suspended"
}
totalNetSupply
Nom de la méthode initiale : totalNetSupply
Cette méthode GET retourne 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 élément Token Admin du code de chaîne.
Interrogation (jetons fongibles) :
/totalNetSupply?tokenDetail={"tokenId":"{{bc-token-id}}"}
Interrogation (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 de retour :
{
    "totalNetSupply": 105
}
totalSupply
Nom de la méthode initiale : totalSupply
Cette méthode GET retourne le nombre total de jetons frappés. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.
Interrogation (jetons fongibles) :
/totalSupply?tokenDetail={"tokenId":"{{bc-token-id}}"}
Interrogation (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 de retour :
{
    "totalSupply": 110
}
updateArtCollectionToken
Nom de la méthode initiale : 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 tables de transfert de fichiers, les métadonnées et l'URI du jeton ne peuvent pas être mis à jour une fois le jeton pointé.
Données utiles :
{
 "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, voir le fichier de spécification d'entrée.
  • endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.
Exemple de valeur de retour :
{
            "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 initiale : 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 tables de transfert de fichiers, les métadonnées et l'URI du jeton ne peuvent pas être mis à jour une fois le jeton pointé.
Données utiles :
{
 "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, voir le fichier de spécification d'entrée.
  • endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.
Exemple de valeur de retour :
{
            "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 initiale : URI
Cette méthode GET retourne l'URI d'un jeton spécifié. Seul le créateur du jeton peut appeler cette méthode.
Interrogation
/URI?tokenId={{bc-token-id}}
Paramètres :
  • tokenId: string - ID du jeton.
Exemple de valeur de retour :
{
    "tokenUri": "example.com"
}