결합된 토큰 프레임워크 래퍼 API 패키지

Oracle Blockchain Platform Digital Assets Edition에는 REST API를 확장하여 수집 가능한 NFT 마켓플레이스와 관련된 작업을 지원하는 래퍼 API 패키지가 포함되어 있습니다.

래퍼 API 패키지는 API 게이트웨이 서비스 및 OCI 함수를 사용하여 수집 가능한 마켓플레이스 애플리케이션용으로 특별히 설계된 API 경로를 배치합니다. 고정 불가능한 토큰 프레임워크 래퍼 API 패키지는 Oracle Blockchain Platform 콘솔에서 다운로드할 수 있으며 다음 구성 요소를 포함합니다.
  • NFTCollectiblesWithERC1155WrapperAPI.zip - 배치에 필요한 Terraform 스크립트를 포함하여 래퍼 API 패키지를 포함하는 아카이브 파일입니다. 이 파일을 OCI(Oracle Cloud Infrastructure)의 리소스 관리자 스택에 배치하여 래퍼 API에 필요한 Oracle 리소스를 생성합니다.
  • NFTCollectiblesWithERC1155_WrapperAPI.postman_collection.json - 배치된 래퍼 API를 테스트할 수 있는 Postman 모음입니다. 컬렉션에는 래퍼 API 패키지에 정의된 API에 해당하는 끝점 및 페이로드가 포함된 미리 구성된 요청이 포함됩니다.

래퍼 API

registerOrg
원래 메소드 이름: registerOrg
이 POST 메소드는 시스템에 조직을 등록합니다. 이 메소드는 토큰 관리자만 호출할 수 있습니다.
페이로드:
{
    "orgId": "{{bc-org-id}}",
    "orgName": "org_name value",
    "endorsers": {{endorsers}}
}
매개변수:
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • orgName: string – (선택 사항) 조직의 이름입니다.
  • endorsers: string[] – 트랜잭션을 보증해야 하는 피어의 배열(예: peer1, peer2)입니다.
반환 값 예제:
{
    "assetType": "oorgregistry",
    "org_registry_id": "orgregistry",
    "registered_orgs": [
        {
            "org_id": "Org1MSP",
            "org_name": "Organization name"
        }
    ]
}
getAllRegisteredOrgs
원래 메소드 이름: getAllRegisteredOrgs
이 GET 방법은 등록된 모든 조직의 세부정보를 검색합니다. 이 메소드는 토큰 관리자만 호출할 수 있습니다.
질의:
/getAllRegisteredOrgs
매개변수:
  • 없음
반환 값 예제:
[
    {
        "org_id": "Org1MSP",
        "org_name": "Organization name"
    }
]
activateAccount
원래 메소드 이름: activateAccount
이 POST 메소드는 토큰 계정을 활성화합니다. 이 메소드는 관리자 또는 계정 소유자만 호출할 수 있습니다. 원장에서 accountStatus를 찾을 수 없는 기존 계정의 경우 이 메소드는 상태가 active로 설정된 accountStatus 객체를 반환합니다.
페이로드:
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
매개변수:
  • tokenId: string – 토큰 ID입니다.
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • userId: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
  • endorsers: string[] – 트랜잭션을 보증해야 하는 피어의 배열(예: peer1, peer2)입니다.
반환값:
  • 성공 시 대체 가능한 토큰 계정에 대한 업데이트된 계정 상태 객체의 JSON 표현입니다.
반환 값 예제:
{
  "assetType": "oaccountStatus",
  "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
  "status": "active"
}
addTokenAdmin
원래 메소드 이름: addTokenAdmin
이 POST 메소드는 사용자를 체인 코드의 Token Admin로 추가합니다. 이 메소드는 체인 코드의 Token Admin에 의해서만 호출될 수 있습니다.
페이로드:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
매개변수:
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • userId: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
  • endorsers: string[] – 트랜잭션을 보증해야 하는 피어의 배열(예: peer1, peer2)입니다.
반환값:
  • 성공 시 체인 코드의 Token Admin로 추가된 사용자의 세부정보를 포함하는 메시지입니다.
반환 값 예제:
{
  "msg": "Successfully added Admin (OrgId: appDev, UserId: user1)"
}
addRole
원래 메소드 이름: addRole
이 POST 메소드는 지정된 사용자 및 토큰에 역할을 추가합니다. 이 메소드는 체인 코드의 Token Admin에 의해서만 호출될 수 있습니다. tokenDetails 매개변수 Fungible 토큰의 경우 tokenId 값이 입력으로 필요합니다. 불가능한 토큰은 tokenName를 입력으로 요구하므로 tokenDetail 매개변수를 사용하여 대체 가능 토큰과 대체 불가능 토큰의 세부정보를 다르게 지정합니다.
페이로드:
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "role": "role minter/burner"
    "tokenDetails": "{"tokenName": "token name value"}"
    "endorsers": {{endorsers}}
}
매개변수:
  • tokenId: string – 토큰 ID입니다.
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • userId: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
  • role: string – 지정된 사용자에 추가할 역할의 이름입니다.
  • tokenDetails: TokenDetail – 토큰을 지정하는 세부정보입니다. 대체 가능한 토큰의 경우 다음 형식을 사용합니다.
    {"tokenId":"token1"}
    사용할 수 없는 토큰의 경우 다음 형식을 사용합니다.
    {"tokenName":"artCollection"}
  • endorsers: string[] – 트랜잭션을 보증해야 하는 피어의 배열(예: peer1, peer2)입니다.
반환 값 예제:
{
  "msg": "Successfully added role 'minter' to Account Id: oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a 
(Org-Id: appdev, User-Id: user2)"
}
associateFungibleTokenToAccount
원래 메소드 이름: associateFungibleTokenToAccount
이 POST 메소드는 사용자의 대체 가능한 토큰 계정을 지정된 토큰과 연관시킵니다.
페이로드:
{
    "tokenId": "{{bc-token-id}}",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
매개변수:
  • tokenId: string – 토큰 ID입니다.
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • userId: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
  • endorsers: string[] – 트랜잭션을 보증해야 하는 피어의 배열(예: peer1, peer2)입니다.
반환 값 예제:
{
  "assetType": "ouaccount",
  "accountId": "ouaccount~24ffd4d32a028a85b4b960f5d55536c837b5429bc7f346150adfa904ec2937cc",
  "userId": "user2",
  "orgId": "appdev",
  "totalAccounts": 1,
  "totalFtAccounts": 1,
  "associatedFtAccounts": [
    {
      "accountId": "oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a",
      "tokenId": "tokenOne"
    }
  ],
  "associatedNftAccount": ""
}
buyWithEthCoin
원래 메소드 이름: buyWithEthCoin
모든 계정 소유자는 이 POST 방법을 사용하여 Ethereum을 사용하여 NFT를 구매하고 로열티 토큰을 보상 포인트로 전송할 수 있습니다.
페이로드:
{
   "fromOrgId":"from_org_id value",
   "fromUserId":"from_user_id value",
   "toOrgId":"to_org_id value",
   "toUserId":"to_user_id value",
   "nftId":"[\"nft_id value\"]",
   "loyaltyId":"[\"loyalty_id value\"]",
   "ethQty":"[eth_qty value]",
   "loyaltyRewardQuantity":"[loyalty_reward_quantity value]",
   "endorsers":{{"endorsers"}}
}
매개변수:
  • fromOrgId: string – 현재 조직에 있는 발신자(소유자)의 MSP(멤버쉽 서비스 제공자) ID입니다.
  • fromUserId: string – 발신자(소유자)의 사용자 이름 또는 전자메일 ID입니다.
  • toOrgId: string – 현재 조직에서 수신자의 MSP(멤버쉽 서비스 제공자) ID입니다.
  • toUserId: string – 수신자의 사용자 이름 또는 전자 메일 ID입니다.
  • nftId: string – 구매할 토큰의 ID입니다.
  • loyaltyId: string – 로열티 포인트를 나타내는 대체 가능한 토큰의 ID입니다.
  • ethQty: number – 이더리움에서 토큰의 가격.
  • loyaltyRewardQuantity: string – 이전할 로열티 포인트 수입니다.
  • endorsers: string[] – 트랜잭션을 보증해야 하는 피어의 배열(예: peer1, peer2)입니다.
반환 값 예제:
{
  "msg": "Token ID : 'artcollection1' has been successfully transferred to UserID : 'user1'"
}
balanceOfBatch
원래 메소드 이름: balanceOfBatch
이 GET 방법은 토큰 계정의 잔액을 가져오는 뱃치 작업을 완료합니다. 이 메소드는 체인 코드의 Token Admin 또는 계정 소유자에 의해서만 호출될 수 있습니다.
질의:
/balanceOfBatch?orgIds=["{{bc-org-id}}"]&userIds=["{{bc-user-id}}"]&tokenIds=["{{bc-token-id}}"]
매개변수:
  • orgIds: string[] – 현재 조직의 MSP(멤버쉽 서비스 제공자) ID 목록입니다.
  • userIds: string[] – 사용자 이름 또는 전자 메일 ID 목록입니다.
  • tokenIds: string[] – 토큰 ID 목록입니다.
반환 값 예제:
[
    {
        "orgId": "AppBldFFFFMay22",
        "userId": "user2",
        "userAccountId": "ouaccount~412de5e3998dcd100973e1bad6e8729fddc1c7ff610beab8376d733a35c51f38",
        "tokenAccountId": "oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371",
        "tokenId": "FNFT",
        "balance": 100
    },
    {
        "orgId": "AppBldFFFFMay22",
        "userId": "user2",
        "userAccountId": "ouaccount~412de5e3998dcd100973e1bad6e8729fddc1c7ff610beab8376d733a35c51f38",
        "tokenAccountId": "oaccount~21206f309941a2a23c4f158a0fe1b8f12bb8e2b0c9a2e1358f5efebc0c7d410e",
        "tokenId": "FT",
        "balance": 50
    },
    {
        "orgId": "AppBldFFFFMay22",
        "userId": "example_minter",
        "userAccountId": "ouaccount~9501bb774c156eb8354dfe489250ea91f757523d70f08ee494bda98bb352003b",
        "tokenAccountId": "oaccount~dcee860665db8740cb77b846e823752185a1e9a185814d0acb305890f5903446",
        "tokenId": "FNFT",
        "balance": 10
    }
]
batchTransferFrom
원래 메소드 이름: batchTransferFrom
이 POST 메소드는 한 사용자에서 다른 사용자로 토큰 ID 목록에 지정된 토큰을 전송하는 일괄 처리 작업을 완료합니다. 이 메소드는 모든 유저가 호출할 수 있습니다.
페이로드:
{
 "fromOrgId": "fromOrgId value",
 "fromUserId": "fromUserId value",
 "toOrgId": "toOrgId value",
 "toUserId": "toUserId value",
 "tokenIds": "[\"{{bc-token-id}}\"]",
 "quantity": "[quantity value]",
 "endorsers": {{endorsers}}
}
매개변수:
  • fromOrgId: string – 발신자의 MSP(멤버쉽 서비스 제공자) ID입니다.
  • fromUserId: string – 발신자의 사용자 ID입니다.
  • toOrgId: string – 수신자의 MSP(멤버쉽 서비스 제공자) ID입니다.
  • toUserId: string – 수신기의 사용자 ID입니다.
  • tokenIds: string[] – 전송할 토큰에 대한 토큰 ID 목록입니다.
  • quantity: number[] – 토큰 ID 배열에 해당하는 전송할 토큰의 수량 목록입니다.
  • endorsers: string[] – 트랜잭션을 보증해야 하는 피어의 배열(예: peer1, peer2)입니다.
반환값:
  • 성공 시 각 토큰 전송에 대한 세부정보가 포함된 메시지입니다.
반환 값 예제:
[
    {
        "msg": "Successfully transferred NFT token: 'FNFT' of '10' quantity from Account-Id: oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371 (Org-Id: AppBldFFFFMay22, User-Id: user2) to Account-Id: oaccount~dcee860665db8740cb77b846e823752185a1e9a185814d0acb305890f5903446 (Org-Id: AppBldFFFFMay22, User-Id: example_minter)"
    },
    {
        "msg": "Successfully transferred 10 FT token: 'FT' from Account-Id: oaccount~21206f309941a2a23c4f158a0fe1b8f12bb8e2b0c9a2e1358f5efebc0c7d410e (Org-Id: AppBldFFFFMay22, User-Id: user2) to Account-Id: oaccount~1089ee5122f367ee0ca38c6660298f4b81f199627e4f67f3691c0f628237974c (Org-Id: AppBldFFFFMay22, User-Id: example_minter)"
    },
    {
        "msg": "Successfully transferred NFT token: 'NFT' from Account-Id: oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371 (Org-Id: AppBldFFFFMay22, User-Id: user2) to Account-Id: oaccount~dcee860665db8740cb77b846e823752185a1e9a185814d0acb305890f5903446 (Org-Id: AppBldFFFFMay22, User-Id: example_minter)"
    }
]
burnBatch
원래 메소드 이름: burnBatch
이 POST 메소드는 지정된 대체 가능 및 실행 불가능 토큰을 비활성화하거나 레코딩합니다. Burner 롤을 가진 유저는 이 메소드를 호출할 수 있습니다.
페이로드:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "tokenIds": "[\"{{bc-token-id}}\"]",
 "quantity": "[quantity value]",
 "sameOrgEndorser": true
}
매개변수:
  • orgId: string – 현재 조직의 MSP(멤버쉽 서비스 제공자) ID입니다.
  • userId: string – 사용자 이름 또는 전자메일 ID입니다.
  • tokenIds: string[] – 레코딩할 토큰 ID 목록
  • quantity: number[] – 토큰 ID 배열에 해당하는 레코딩할 토큰의 수량 목록입니다.
  • sameOrgEndorser: boolean – 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
반환값:
  • 성공 시 레코딩 작업에 대한 세부정보가 포함된 메시지입니다.
반환 값 예제:
[
  {
    "msg": "Successfully burned NFT token: 'art' from Account-Id: oaccount~76cb672eeb1bd535899562a840d0c15a356db89e24bc8b43ac1dba845a4282c6 (Org-Id: appdev, User-Id: user2)"
  },
  {
    "msg": "Successfully burned 5 tokens of tokenId: tokenOne from Account-ID oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a (Org-Id: appdev, User-Id: user2)"
  },
  {
    "msg": "Successfully burned 2 token share of tokenId: FNFT from Account-ID oaccount~87bcb699d507368ee3966cd03ee6d7736ffc55dde8c0f0e16b14866334ac504a (Org-Id: AutoF1377358917, User-Id: user2)"
  }
]
burnNFT
원래 메소드 이름: burnNFT
이 POST 메소드는 지정된 대체 불가능 토큰을 비활성화 또는 레코딩하고 토큰 객체 및 토큰 기록을 반환합니다. Burner 롤을 가진 유저는 이 메소드를 호출할 수 있습니다.
페이로드:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "tokenId": "{{bc-token-id}}",
 "sameOrgEndorser": true
}
매개변수:
  • orgId: string – 현재 조직의 MSP(멤버쉽 서비스 제공자) ID입니다.
  • userId: string – 사용자 이름 또는 전자메일 ID입니다.
  • tokenId: string – 레코딩할 수 없는 토큰의 ID
  • sameOrgEndorser: boolean – 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
반환값:
  • 성공 시 레코딩 작업에 대한 메시지가 포함된 JSON 배열입니다.
반환 값 예제:
{
    "msg": "Successfully burned NFT token: 'art' from Account-Id: oaccount~76cb672eeb1bd535899562a840d0c15a356db89e24bc8b43ac1dba845a4282c6 (Org-Id: appdev, User-Id: user2)"
  }
createAccount
원래 메소드 이름: createAccount
이 POST 메소드는 실행 가능한 토큰 또는 실행 불가능 토큰에 대해 지정된 사용자 및 연관된 토큰 계정에 대한 계정을 만듭니다. 언제든지 토큰을 가질 사용자에 대해 계정을 만들어야 합니다. 사용자 계정은 사용자가 보유한 대체 가능한 토큰 계정 및 NFT 계정을 추적합니다. 토큰 관련 작업을 완료하려면 네트워크에 계정이 있어야 합니다. 이 메소드는 체인 코드의 Token Admin에 의해서만 호출될 수 있습니다.

사용자 계정에는 orgId 매개변수와 userId 매개변수의 SHA-256 해시로 구성된 고유 ID가 있습니다.

사용자는 고유한 계정 ID를 가진 여러 대체 가능한 토큰 계정을 가질 수 있습니다. 고정 토큰 계정 ID는 orgId 매개변수의 SHA-256 해시, userId 매개변수, 틸드 기호(~)로 구분된 상수 문자열 ft 및 틸드 기호(~)로 구분된 생성 중인 대체 가능 계정의 인덱스를 나타내는 카운터 번호로 구성됩니다.

사용자는 수정할 수 없는 토큰 계정을 하나만 가질 수 있습니다. 고정 불가능 토큰 계정 ID는 고유하며 orgId 매개변수의 SHA-256 해시, userId 매개변수 및 틸드 기호(~)로 구분된 상수 문자열 nft에 의해 형성됩니다. 사용자가 소유하는 모든 실행 불가능 토큰(전체 또는 소수)은 이 계정에 연결됩니다.

사용자 계정 ID는 ouaccount~로 시작합니다. 토큰 계정 ID는 oaccount~로 시작합니다.

페이로드:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "ftAccount": true,
 "nftAccount": true,
 "endorsers": {{endorsers}}
}
매개변수:
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • userId: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
  • ftAccount: boolean – true인 경우 대체 가능한 토큰 계정이 만들어지고 사용자 계정과 연관됩니다.
  • nftAccount: boolean – true인 경우 사용할 수 없는 토큰 계정이 만들어지고 사용자 계정과 연관됩니다.
  • endorsers: string[] – 트랜잭션을 보증해야 하는 피어의 배열(예: peer1, peer2)입니다.
반환 값 예제:
{
  "assetType": "ouaccount",
  "accountId": "ouaccount~cf20877546f52687f387e7c91d88b9722c97e1a456cc0484f40c747f7804feae",
  "userId": "user1",
  "orgId": "appdev",
  "totalAccounts": 2,
  "totalFtAccounts": 1,
  "associatedFtAccounts": [
    {
      "accountId": "oaccount~60bb20c14a83f6e426e1437c479c5891e1c6477dfd7ad18b73acac5d80bc504b",
      "tokenId": ""
    }
  ],
  "associatedNftAccount": "oaccount~73c3e835dac6d0a56ca9d8def08269f83cefd59b9d297fe2cdc5a9083828fa58"
}
createArtCollectionToken
원래 메소드 이름: createArtCollectionToken
이 POST 메소드는 NFT를 생성(민트)합니다. 자산 및 연관된 속성은 상태 데이터베이스에 저장됩니다. 이 트랜잭션의 호출자는 토큰 계정을 가져야 합니다. 이 트랜잭션의 호출자가 NFT의 소유자가 됩니다. 토큰 사양 파일에 behaviors에 대한 roles 섹션과 roles에 대한 minter_role_name 속성이 포함된 경우 트랜잭션 호출자가 minter 롤을 가져야 합니다. 그렇지 않으면 호출자가 NFT를 민트할 수 있습니다.
페이로드:
{
 "tokenAsset": "{\"tokenId\":\"{{bc-token-id}}\",\"tokenDesc\":\"tokenDesc value\",\"tokenUri\":\"tokenUri value\",\"tokenMetadata\":{\"Painting_Name\":\"Painting_Name value\",\"Description\":\"Description value\",\"Painter_Name\":\"Painter_Name value\"},\"Price\":999,\"On_Sale_Flag\":true}",
 "quantity": 1,
 "sameOrgEndorser": true
}
매개변수:
  • tokenAsset: <Token Class> – 민트할 토큰 자산입니다. 토큰 자산의 속성에 대한 자세한 내용은 입력 사양 파일을 참조하십시오.
  • quantity: number – 민트할 토큰 수입니다. 이 매개변수에 대해 지원되는 값은 1뿐입니다.
  • sameOrgEndorser: boolean – 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
반환 값 예제:
{
            "tokenMetadata": {
                "ISIN": "ISIN value",
                "Segment": "Segment value",
                "Issuer": "Issuer value",
                "FaceValue": 999,
                "IssueSize": 999,
                "CouponRate": 999,
                "InterestPaymentType": "simple",
                "InterestFrequency": "monthly",
                "IssueDate": "2023-03-28T15:16:36.000Z",
                "MaturityDate": "2023-03-28T15:16:36.000Z"
            },
            "assetType": "otoken",
            "events": false,
            "tokenId": "token2",
            "tokenName": "bond",
            "tokenDesc": "tokenDesc value",
            "tokenStandard": "erc1155+",
            "tokenType": "nonfungible",
            "tokenUnit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner"
            },
            "mintable": {
                "max_mint_quantity": 0
            },
            "quantity": 10,
            "createdBy": "oaccount~85dfd98d1b99e5b8891e0a0fdcd7d2e07fc5d37958f5d2a5796290b6a9204a43",
            "creationDate": "2024-12-03T12:07:24.000Z",
            "divisible": {
                "decimal": 0
            },
            "isBurned": false,
            "isLocked": false,
            "tokenUri": "tokenUri value",
            "status": "created"
}
createLoyaltyToken
원래 메소드 이름: createLoyaltyToken
이 POST 메소드는 토큰을 만듭니다. 정의된 모든 토큰에는 고유한 생성 메소드가 있습니다. 이 메소드는 체인 코드의 Token Admin에 의해서만 호출될 수 있습니다.
페이로드:
{
 "tokenAsset": "{\"tokenId\":\"{{bc-token-id}}\",\"tokenDesc\":\"tokenDesc value\",\"Token_Name\":\"Token_Name value\",\"Token_to_Currency_Ratio\":999}",
 "sameOrgEndorser": true
}
매개변수:
  • tokenAsset: <Token Class> – 토큰 자산입니다. 자산의 특성은 모델 파일에서 정의됩니다.
  • sameOrgEndorser: boolean – 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
반환 값 예제:
{
            "assetType": "otoken",
            "events": false,
            "tokenId": "token2",
            "tokenName": "loyalty",
            "tokenDesc": "tokenDesc value",
            "tokenStandard": "erc1155+",
            "tokenType": "fungible",
            "tokenUnit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner"
            },
            "mintable": {
                "max_mint_quantity": 0
            },
            "quantity": 10,
            "createdBy": "oaccount~85dfd98d1b99e5b8891e0a0fdcd7d2e07fc5d37958f5d2a5796290b6a9204a43",
            "creationDate": "2024-12-03T12:07:24.000Z",
            "divisible": {
                "decimal": 0
            },
            "isBurned": false,
            "isLocked": false,
            "tokenUri": "tokenUri value",
            "status": "created"
}
createTokenAccount
원래 메소드 이름: createTokenAccount
이 POST 메소드는 사용자 계정과 연관시킬 대체 가능 또는 대체 불가능 토큰 계정을 만듭니다.

사용자는 고유한 계정 ID를 가진 여러 대체 가능한 토큰 계정을 가질 수 있습니다. 고정 토큰 계정 ID는 orgId 매개변수의 SHA-256 해시, userId 매개변수, 틸드 기호(~)로 구분된 상수 문자열 ft 및 틸드 기호(~)로 구분된 생성 중인 대체 가능 계정의 인덱스를 나타내는 카운터 번호로 구성됩니다.

사용자는 수정할 수 없는 토큰 계정을 하나만 가질 수 있습니다. 고정 불가능 토큰 계정 ID는 고유하며 orgId 매개변수의 SHA-256 해시, userId 매개변수 및 틸드 기호(~)로 구분된 상수 문자열 nft에 의해 형성됩니다. 사용자가 소유하는 모든 실행 불가능 토큰(전체 또는 소수)은 이 계정에 연결됩니다.

이 메소드는 체인 코드의 Token Admin에 의해서만 호출될 수 있습니다.

페이로드:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "tokenType": "nonfungible",
 "endorsers": {{endorsers}}
}
매개변수:
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • userId: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
  • tokenType: TokenType – 만들 토큰 계정의 유형입니다. 지원되는 토큰 유형은 nonfungible 및 fungible뿐입니다.
  • endorsers: string[] – 트랜잭션을 보증해야 하는 피어의 배열(예: peer1, peer2)입니다.
반환값:
  • 성공 시 생성된 토큰 계정의 JSON 객체입니다.
반환 값 예제:
{
  "assetType": "ouaccount",
  "accountId": "ouaccount~24ffd4d32a028a85b4b960f5d55536c837b5429bc7f346150adfa904ec2937cc",
  "userId": "user2",
  "orgId": "appdev",
  "totalAccounts": 1,
  "totalFtAccounts": 1,
  "associatedFtAccounts": [
    {
      "accountId": "oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a",
      "tokenId": ""
    }
  ],
  "associatedNftAccount": "oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a"
}
createUserAccount
원래 메소드 이름: createUserAccount
이 POST 메소드는 지정된 사용자의 계정을 만듭니다. 언제든지 토큰을 가질 사용자에 대해 계정을 만들어야 합니다. 사용자 계정은 사용자가 가지고 있는 NFT 계정 및 대체 가능한 토큰 계정을 추적합니다. 토큰 관련 작업을 완료하려면 네트워크에 계정이 있어야 합니다.

계정 ID는 orgId 매개변수와 userId 매개변수의 SHA-256 해시입니다. 이 메소드는 체인 코드의 Token Admin에 의해서만 호출될 수 있습니다.

페이로드:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "endorsers": {{endorsers}}
}
매개변수:
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • userId: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
  • endorsers: string[] – 트랜잭션을 보증해야 하는 피어의 배열(예: peer1, peer2)입니다.
반환값:
  • 성공 시 생성된 사용자 계정의 JSON 객체입니다.
반환 값 예제:
{
  "assetType": "ouaccount",
  "accountId": "ouaccount~24ffd4d32a028a85b4b960f5d55536c837b5429bc7f346150adfa904ec2937cc",
  "userId": "user2",
  "orgId": "appdev",
  "totalAccounts": 0,
  "totalFtAccounts": 0,
  "associatedFtAccounts": [],
  "associatedNftAccount": ""
}
deleteAccount
원래 메소드 이름: deleteAccount
이 POST 메소드는 토큰 계정을 삭제합니다. 계정이 삭제된 후에는 계정이 최종 상태이며 다른 상태로 업데이트하거나 변경할 수 없습니다. 계정을 삭제하려면 계정 잔액이 0이어야 합니다. 이 메소드는 체인 코드의 Token Admin에 의해서만 호출될 수 있습니다.
페이로드:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "endorsers": {{endorsers}}
}
매개변수:
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • userId: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
  • endorsers: string[] – 트랜잭션을 보증해야 하는 피어의 배열(예: peer1, peer2)입니다.
반환값:
  • 성공 시 토큰 계정 상태의 JSON 표현입니다.
반환 값 예제:
{
  "assetType": "oaccountStatus",
  "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
  "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
  "status": "deleted"
}
exchangeToken
원래 메소드 이름: exchangeToken
이 방법은 지정된 계정 간에 토큰을 교환합니다. 이 방법은 NFT와 대체 가능한 토큰 또는 대체 가능한 토큰과 NFT 간의 교환만 지원합니다. NFT는 전체 또는 소수일 수 있습니다. 이 방법은 계정 소유자만 호출할 수 있습니다.
페이로드:
{
 "fromTokenId": "fromTokenId value",
 "fromOrgId": "fromOrgId value",
 "fromUserId": "fromUserId value",
 "fromTokenQuantity": 1,
 "toTokenId": "toTokenId value",
 "toOrgId": "toOrgId value",
 "toUserId": "toUserId value",
 "toTokenQuantity": 1,
 "endorsers": {{endorsers}}
}
매개변수:
  • fromTokenId: string – 발신자가 소유한 토큰의 ID입니다.
  • fromOrgId: string – 현재 조직에 있는 발신자의 MSP(멤버쉽 서비스 제공자) ID입니다.
  • fromUserId: string – 발신자의 사용자 이름 또는 전자메일 ID입니다.
  • fromTokenQuantity: number – 수신기와 교환할 발신기의 토큰 수량입니다.
  • toTokenId: string – 수신자가 소유하는 토큰의 ID입니다.
  • toOrgId: string – 현재 조직에서 수신자의 MSP(멤버쉽 서비스 제공자) ID입니다.
  • toUserId: string – 수신자의 사용자 이름 또는 전자 메일 ID입니다.
  • toTokenQuantity: number – 발신자와 교환할 수신기의 토큰 수량입니다.
  • endorsers: string[] – 트랜잭션을 보증해야 하는 피어의 배열(예: peer1, peer2)입니다.
반환값:
  • 성공 시 토큰 교환 세부정보가 포함된 메시지입니다.
반환 값 예제:
{
    "msg": "Succesfully exchanged 10 tokens of type nonfungible with tokenId: [r1] from Account oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371 (OrgId: AppBldFFFFMay22, UserId: user2) to 10 tokens of type fungible with tokenId: [loy1] from Account oaccount~1089ee5122f367ee0ca38c6660298f4b81f199627e4f67f3691c0f628237974c (OrgId: AppBldFFFFMay22, UserId: example_minter)"
}
getAccount
원래 메소드 이름: getAccount
이 GET 메소드는 지정된 사용자에 대한 토큰 계정 세부정보를 반환합니다. 이 메소드는 체인 코드의 Token Admin 또는 계정의 Account Owner에 의해서만 호출될 수 있습니다.
질의:
/getAccount?orgId={{bc-org-id}}&userId={{bc-user-id}}
매개변수:
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • userId: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
반환값:
  • 성공 시 토큰 계정 세부정보를 포함하는 JSON 객체입니다.
반환 값 예제
{
    "assetType": "oaccount",
    "accountId": "oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371",
    "userId": "user2",
    "orgId": "AppBldFFFFMay22",
    "tokenType": "nonfungible",
    "noOfNfts": 3
}
getAccountDetailsByUser
원래 메소드 이름: getAccountDetailsByUser
이 GET 메소드는 지정된 사용자에 대한 계정 세부정보를 반환합니다. 이 메소드는 체인 코드의 Token Admin 또는 계정의 Account Owner에 의해서만 호출될 수 있습니다.
질의:
/getAccountDetailsByUser?orgId={{bc-org-id}}&userId={{bc-user-id}}
매개변수:
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • userId: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
반환 값 예제:
{
    "userAccountId": "ouaccount~412de5e3998dcd100973e1bad6e8729fddc1c7ff610beab8376d733a35c51f38",
    "associatedFTAccounts": [
        {
            "accountId": "oaccount~21206f309941a2a23c4f158a0fe1b8f12bb8e2b0c9a2e1358f5efebc0c7d410e",
            "tokenId": "FT",
            "balance": 50
        }
    ],
    "associatedNFTAccount": {
        "accountId": "oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371",
        "associatedNFTs": [
            {
                "nftTokenId": "FNFT",
                "tokenShare": 100
            },
            {
                "nftTokenId": "FNFT2",
                "tokenShare": 110
            },
            {
                "nftTokenId": "NFT"
            }
        ]
    }
}
getAccountHistory
원래 메소드 이름: getAccountHistory
이 GET 메서드는 지정된 토큰 계정에 대한 계정 기록을 반환합니다. NFT 계정의 경우 tokenId 매개변수가 비어 있어야 합니다. 이 메소드는 체인 코드의 Token Admin 또는 계정 소유자에 의해서만 호출될 수 있습니다.
질의:
/getAccountHistory?orgId={{bc-org-id}}&userId={{bc-user-id}}&tokenId={{bc-token-id}}
매개변수:
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • userId: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
  • tokenId: string – 대체 가능한 토큰의 ID입니다.
반환 값 예제:
[
    {
        "trxId": "a2cfc6fc064334d6b9931cdf67193711ec2ff5c50a4714f11855fe7384f00e35",
        "timeStamp": "2023-06-06T14:44:31.000Z",
        "value": {
            "accountId": "oaccount~21206f309941a2a23c4f158a0fe1b8f12bb8e2b0c9a2e1358f5efebc0c7d410e",
            "assetType": "oaccount",
            "balance": 100,
            "orgId": "AppBldFFFFMay22",
            "tokenId": "loy1",
            "tokenName": "loyalty",
            "tokenType": "fungible",
            "userId": "user2"
        }
    },
    {
        "trxId": "de483cf7505ae4e7018c4b604c3ab9327c2fb1f802d9408e22735667c1d6997f",
        "timeStamp": "2023-06-06T14:43:23.000Z",
        "value": {
            "assetType": "oaccount",
            "accountId": "oaccount~21206f309941a2a23c4f158a0fe1b8f12bb8e2b0c9a2e1358f5efebc0c7d410e",
            "userId": "user2",
            "orgId": "AppBldFFFFMay22",
            "tokenType": "fungible",
            "tokenId": "loy1",
            "tokenName": "loyalty",
            "balance": 0
        }
    },
    {
        "trxId": "db053e653d3ad9aa5b7b6e04b7cd51aacfbb413272d857a155b60d2a6a12bf4d",
        "timeStamp": "2023-06-05T16:59:08.000Z",
        "value": {
            "assetType": "oaccount",
            "accountId": "oaccount~21206f309941a2a23c4f158a0fe1b8f12bb8e2b0c9a2e1358f5efebc0c7d410e",
            "userId": "user2",
            "orgId": "AppBldFFFFMay22",
            "tokenType": "fungible",
            "tokenId": "",
            "balance": 0
        }
    }
]
getAccountStatus
원래 메소드 이름: getAccountStatus
이 GET 메소드는 토큰 계정의 현재 상태를 검색합니다. 이 메소드는 체인 코드의 Token Admin 또는 토큰 계정 소유자가 호출할 수 있습니다.
질의:
/getAccountStatus?orgId={{bc-org-id}}&userId={{bc-user-id}}
매개변수:
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • userId: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
반환값:
  • 성공 시 토큰 계정 상태의 JSON 표현입니다.
반환 값 예제:
{
    "assetType": "oaccountStatus",
    "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
    "status": "active"
}
getAccountStatusHistory
원래 메소드 이름: getAccountStatusHistory
이 GET 메소드는 계정 상태의 기록을 검색합니다. 이 메소드는 체인 코드의 Token Admin 또는 토큰 계정 소유자가 호출할 수 있습니다.
질의:
/getAccountStatusHistory?orgId={{bc-org-id}}&userId={{bc-user-id}}
매개변수:
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • userId: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
반환값:
  • 성공 시 계정 상태 기록은 JSON 형식입니다.
반환 값 예제:
[
  {
    "trxId": "d5c6d6f601257ba9b6edaf5b7660f00adc13c37d5321b8f7d3a35afab2e93e63",
    "timeStamp": "2022-12-02T10:39:14.000Z",
    "value": {
      "assetType": "oaccountStatus",
      "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
      "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
      "status": "suspended"
    }
  },
  {
    "trxId": "e6c850cfa084dc20ad95fb2bb8165eef3a3bd62a0ac867cccee57c2003125183",
    "timeStamp": "2022-12-02T10:37:50.000Z",
    "value": {
      "assetType": "oaccountStatus",
      "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
      "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
      "status": "active"
    }
  }
]
getAccountTransactionHistory
원래 메소드 이름: getAccountTransactionHistory
이 GET 메소드는 계정 트랜잭션 기록을 반환합니다. 이 메소드는 체인 코드의 Token Admin 또는 계정 소유자에 의해서만 호출될 수 있습니다.
질의:
/getAccountTransactionHistory?orgId={{bc-org-id}}&userId={{bc-user-id}}
매개변수:
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • userId: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
반환 값 예제:
[
    {
        "transactionId": "otransaction~3a6b23c3003626f3947e990eddbd7ac23398d2200e2eb3eac745e6ddfae140bc~7c88c736df38d5622512f1e8dcdd50710eb47c953f1ecb24ac44790a9e2f475b",
        "timestamp": "2023-06-06T14:48:08.000Z",
        "tokenId": "FNFT",
        "transactedAmount": 10,
        "triggeredByUserAccountId": "ouaccount~412de5e3998dcd100973e1bad6e8729fddc1c7ff610beab8376d733a35c51f38",
        "transactedAccount": "oaccount~dcee860665db8740cb77b846e823752185a1e9a185814d0acb305890f5903446",
        "transactionType": "DEBIT",
        "balance": 90
    },
    {
        "transactionId": "otransaction~3a6b23c3003626f3947e990eddbd7ac23398d2200e2eb3eac745e6ddfae140bc~178e3730bc5bee50d02f1464a4eebf733a051905f651e5789039adb4a3edc114",
        "timestamp": "2023-06-06T14:48:08.000Z",
        "tokenId": "NFT",
        "triggeredByUserAccountId": "ouaccount~412de5e3998dcd100973e1bad6e8729fddc1c7ff610beab8376d733a35c51f38",
        "transactedAccount": "oaccount~dcee860665db8740cb77b846e823752185a1e9a185814d0acb305890f5903446",
        "transactionType": "DEBIT"
    },
    {
        "transactionId": "otransaction~c369929e28e78de06c72d020f1418c9a154a7dd280b2e22ebb4ea4485e249124~a7cefb22ff39ee7e36967be71de27da6798548c872061a62dabc56d88d50b930",
        "timestamp": "2023-06-06T14:47:08.000Z",
        "tokenId": "NFT",
        "triggeredByUserAccountId": "ouaccount~412de5e3998dcd100973e1bad6e8729fddc1c7ff610beab8376d733a35c51f38",
        "transactedAccount": "oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371",
        "transactionType": "MINT"
    },
    {
        "transactionId": "otransaction~114a1bc78d04be48ee6dc140c32c042ee9481cb118959626f090eec744522422~e4eb15d9354f694230df8835ade012100d82aa43672896a2c7125a86e3048f9f",
        "timestamp": "2023-06-05T17:17:57.000Z",
        "tokenId": "FNFT",
        "transactedAmount": 100,
        "triggeredByUserAccountId": "ouaccount~412de5e3998dcd100973e1bad6e8729fddc1c7ff610beab8376d733a35c51f38",
        "transactedAccount": "oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371",
        "transactionType": "MINT",
        "balance": 100
    }
]
getAccountsByRole
원래 메소드 이름: getAccountsByRole
이 메소드는 지정된 롤에 대한 모든 계정 ID 목록을 반환합니다. 이 메소드는 체인 코드의 Token Admin에 의해서만 호출될 수 있습니다.
질의:
/getAccountsByRole?role=role value (for example minter / burner)&tokenDetail={"tokenName":"tokenName value"}
매개변수:
  • role: string – 검색할 역할의 이름입니다.
  • tokenDetails: TokenDetail – 토큰을 지정하는 세부정보입니다. 대체 가능한 토큰의 경우 다음 형식을 사용합니다.
    {"tokenId":"token1"}
    사용할 수 없는 토큰의 경우 다음 형식을 사용합니다.
    {"tokenName":"artCollection"}
반환 값 예제:
{
  "accounts": [
    "oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a",
    "oaccount~60bb20c14a83f6e426e1437c479c5891e1c6477dfd7ad18b73acac5d80bc504b"
  ]
}
getAllAccounts
원래 메소드 이름: getAllAccounts
이 GET 메소드는 모든 사용자 계정의 세부정보를 반환합니다. 이 메소드는 체인 코드의 Token Admin에 의해서만 호출될 수 있습니다.
질의:
/getAllAccounts
매개변수:
  • 없음
반환값:
  • 성공 시 모든 계정의 JSON 배열입니다.
반환 값 예제:
[
        {
            "assetType": "ouaccount",
            "accountId": "ouaccount~412de5e3998dcd100973e1bad6e8729fddc1c7ff610beab8376d733a35c51f38",
            "userId": "user2",
            "orgId": "AppBldFFFFMay22",
            "totalAccounts": 2,
            "totalFtAccounts": 1,
            "associatedFtAccounts": [
                {
                    "accountId": "oaccount~21206f309941a2a23c4f158a0fe1b8f12bb8e2b0c9a2e1358f5efebc0c7d410e",
                    "tokenId": "loy1"
                }
            ],
            "associatedNftAccount": "oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371"
        },
        {
            "assetType": "ouaccount",
            "accountId": "ouaccount~9501bb774c156eb8354dfe489250ea91f757523d70f08ee494bda98bb352003b",
            "userId": "example_minter",
            "orgId": "AppBldFFFFMay22",
            "totalAccounts": 2,
            "totalFtAccounts": 1,
            "associatedFtAccounts": [
                {
                    "accountId": "oaccount~1089ee5122f367ee0ca38c6660298f4b81f199627e4f67f3691c0f628237974c",
                    "tokenId": "loy1"
                }
            ],
            "associatedNftAccount": "oaccount~dcee860665db8740cb77b846e823752185a1e9a185814d0acb305890f5903446"
        },
    ]
getAllTokenAdmins
원래 메소드 이름: getAllTokenAdmins
이 GET 메소드는 체인 코드의 Token Admin인 모든 사용자 목록을 반환합니다. 이 메소드는 체인 코드의 Token Admin에 의해서만 호출될 수 있습니다.
질의:
/getAllTokenAdmins
매개변수:
  • 없음
반환값:
  • 성공 시 orgId 및 userId 객체를 포함하는 JSON 형식의 admins 배열입니다.
반환 값 예제:
{
  "admins": [
    {
      "orgId": "appdev",
      "userId": "user2"
    },
    {
      "orgId": "appdev",
      "userId": "user1"
    }
  ]
}
getAllTokens
원래 메소드 이름: getAllTokens
이 GET 메소드는 상태 데이터베이스에 저장된 모든 토큰 자산을 반환합니다. 이 메소드는 체인 코드의 Token Admin에 의해서만 호출될 수 있습니다. 이 방법은 Berkeley DB SQL 리치 쿼리를 사용하며 원격 Oracle Blockchain Platform 네트워크에 연결된 경우에만 호출할 수 있습니다.
질의:
/getAllTokens
매개변수:
  • 없음
반환 값 예제:
[{
            "tokenMetadata": {
                "ISIN": "ISIN value",
                "Segment": "Segment value",
                "Issuer": "Issuer value",
                "FaceValue": 999,
                "IssueSize": 999,
                "CouponRate": 999,
                "InterestPaymentType": "simple",
                "InterestFrequency": "monthly",
                "IssueDate": "2023-03-28T15:16:36.000Z",
                "MaturityDate": "2023-03-28T15:16:36.000Z"
            },
            "assetType": "otoken",
            "events": false,
            "tokenId": "token2",
            "tokenName": "bond",
            "tokenDesc": "tokenDesc value",
            "tokenStandard": "erc1155+",
            "tokenType": "nonfungible",
            "tokenUnit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner"
            },
            "mintable": {
                "max_mint_quantity": 0
            },
            "quantity": 10,
            "createdBy": "oaccount~85dfd98d1b99e5b8891e0a0fdcd7d2e07fc5d37958f5d2a5796290b6a9204a43",
            "creationDate": "2024-12-03T12:07:24.000Z",
            "divisible": {
                "decimal": 0
            },
            "isBurned": false,
            "isLocked": false,
            "tokenUri": "tokenUri value",
            "status": "status value"
}]
getAllTokensByUser
원래 메소드 이름: getAllTokensByUser
이 GET 메소드는 지정된 사용자가 소유한 모든 토큰 자산을 반환합니다. 이 방법은 Berkeley DB SQL 리치 쿼리를 사용하며 원격 Oracle Blockchain Platform 네트워크에 연결된 경우에만 호출할 수 있습니다. 이 메소드는 체인 코드의 Token Admin 또는 계정 소유자에 의해서만 호출될 수 있습니다.
질의:
/getAllTokensByUser?orgId={{bc-org-id}}&userId={{bc-user-id}}
매개변수:
  • org_id: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • user_id: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
반환 값 예제:
[{
            "tokenMetadata": {
                "ISIN": "ISIN value",
                "Segment": "Segment value",
                "Issuer": "Issuer value",
                "FaceValue": 999,
                "IssueSize": 999,
                "CouponRate": 999,
                "InterestPaymentType": "simple",
                "InterestFrequency": "monthly",
                "IssueDate": "2023-03-28T15:16:36.000Z",
                "MaturityDate": "2023-03-28T15:16:36.000Z"
            },
            "assetType": "otoken",
            "events": false,
            "tokenId": "token2",
            "tokenName": "bond",
            "tokenDesc": "tokenDesc value",
            "tokenStandard": "erc1155+",
            "tokenType": "nonfungible",
            "tokenUnit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner"
            },
            "mintable": {
                "max_mint_quantity": 0
            },
            "quantity": 10,
            "createdBy": "oaccount~85dfd98d1b99e5b8891e0a0fdcd7d2e07fc5d37958f5d2a5796290b6a9204a43",
            "creationDate": "2024-12-03T12:07:24.000Z",
            "divisible": {
                "decimal": 0
            },
            "isBurned": false,
            "isLocked": false,
            "tokenUri": "tokenUri value",
            "status": "status value"
}]
getTokenById
원래 메소드 이름: getTokenById
이 GET 메소드는 토큰이 상태 데이터베이스에 있는 경우 토큰 객체를 반환합니다. 이 메소드는 체인 코드의 Token Admin 또는 토큰 소유자에 의해서만 호출될 수 있습니다. 소수 NFT의 경우 응답에는 토큰 소유자 목록이 포함됩니다.
질의:
/getTokenById?tokenId={{bc-token-id}}
매개변수:
  • tokenId: string – 가져올 토큰의 ID입니다.
반환 값 예제:
[{
            "tokenMetadata":{
               "ISIN":"ISIN value",
               "Segment":"Segment value",
               "Issuer":"Issuer value",
               "FaceValue":10,
               "IssueSize":999,
               "CouponRate":10,
               "InterestPaymentType":"simple",
               "InterestFrequency":"monthly",
               "IssueDate":"2023-03-28T15:16:36.000Z",
               "MaturityDate":"2023-03-28T15:16:36.000Z"
            },
            "assetType":"otoken",
            "events":true,
            "tokenId":"bond1",
            "tokenName":"bond",
            "tokenDesc":"tokenDesc value",
            "tokenStandard":"erc1155+",
            "tokenType":"nonfungible",
            "tokenUnit":"fractional",
            "behaviors":[
               "divisible",
               "mintable",
               "transferable",
               "burnable",
               "roles"
            ],
            "roles":{
               "minter_role_name":"minter",
               "burner_role_name":"burner"
            },
            "mintable":{
               "max_mint_quantity":0
            },
            "quantity":100,
            "createdBy":"oaccount~276bcf1324b1ad1e493e22432db3b39f7a4b9bb17b8525c0391ea3ba36138e00",
            "creationDate":"2024-12-02T12:42:09.000Z",
            "divisible":{
               "decimal":0
            },
            "isBurned":false,
            "isLocked":false,
            "tokenUri":"tokenUri value",
            "status":"posted"
         }
]
getTokenDecimal
원래 메소드 이름: getTokenDecimal
이 메소드는 지정된 토큰에 대한 소수점 자릿수를 반환합니다. 이 메소드는 체인 코드의 Token Admin에 의해서만 호출될 수 있습니다.
질의:
/getTokenDecimal?tokenId={{bc-token-id}}
매개변수:
  • tokenId: string – 토큰 ID입니다.
반환 값 예제:
{
    "msg": "Token Id: tokenOne has 2 decimal places."
}
getTokenHistory
원래 메소드 이름: getTokenHistory
이 GET 메소드는 지정된 토큰 ID에 대한 내역을 반환합니다. 누구나 이 메소드를 호출할 수 있습니다.
/getTokenHistory?tokenId={{bc-token-id}}
매개변수:
  • tokenId: string – 토큰 ID입니다.
반환 값 예제:
[{
            "tokenMetadata":{
               "ISIN":"ISIN value",
               "Segment":"Segment value",
               "Issuer":"Issuer value",
               "FaceValue":10,
               "IssueSize":999,
               "CouponRate":10,
               "InterestPaymentType":"simple",
               "InterestFrequency":"monthly",
               "IssueDate":"2023-03-28T15:16:36.000Z",
               "MaturityDate":"2023-03-28T15:16:36.000Z"
            },
            "assetType":"otoken",
            "events":true,
            "tokenId":"bond1",
            "tokenName":"bond",
            "tokenDesc":"tokenDesc value",
            "tokenStandard":"erc1155+",
            "tokenType":"nonfungible",
            "tokenUnit":"fractional",
            "behaviors":[
               "divisible",
               "mintable",
               "transferable",
               "burnable",
               "roles"
            ],
            "roles":{
               "minter_role_name":"minter",
               "burner_role_name":"burner"
            },
            "mintable":{
               "max_mint_quantity":0
            },
            "quantity":100,
            "createdBy":"oaccount~276bcf1324b1ad1e493e22432db3b39f7a4b9bb17b8525c0391ea3ba36138e00",
            "creationDate":"2024-12-02T12:42:09.000Z",
            "divisible":{
               "decimal":0
            },
            "isBurned":false,
            "isLocked":false,
            "tokenUri":"tokenUri value",
            "status":"posted"
         }
]
getTokensByName
원래 메소드 이름: getTokensByName
이 GET 메소드는 지정된 토큰 이름에 대한 모든 토큰 자산을 반환합니다. 이 방법은 Berkeley DB SQL 리치 쿼리를 사용하며 원격 Oracle Blockchain Platform 네트워크에 연결된 경우에만 호출할 수 있습니다. 이 메소드는 체인 코드의 Token Admin에 의해서만 호출될 수 있습니다.
질의:
/getTokensByName?tokenName=tokenName value
매개변수:
  • tokenName: string – 토큰의 이름입니다.
반환 값 예제:
[
  {
    "key": "tokenOne",
    "valueJson": {
      "assetType": "otoken",
      "tokenId": "tokenOne",
      "tokenName": "moneytok",
      "tokenStandard": "erc1155+",
      "tokenType": "fungible",
      "tokenUnit": "fractional",
      "behaviors": [
        "divisible",
        "mintable",
        "transferable",
        "roles"
      ],
      "roles": {
        "minter_role_name": "minter",
        "burner_role_name": "burner"
      },
      "mintable": {
        "max_mint_quantity": 1000
      },
      "divisible": {
        "decimal": 2
      }
    }
  },
  {
    "key": "tokenTwo",
    "valueJson": {
      "assetType": "otoken",
      "tokenId": "tokenTwo",
      "tokenName": "moneytok",
      "tokenStandard": "erc1155+",
      "tokenType": "fungible",
      "tokenUnit": "fractional",
      "behaviors": [
        "divisible",
        "mintable",
        "transferable",
        "roles"
      ],
      "roles": {
        "minter_role_name": "minter",
        "burner_role_name": "burner"
      },
      "mintable": {
        "max_mint_quantity": 1000
      },
      "divisible": {
        "decimal": 2
      }
    }
  }
]
getTransactionById
원래 메소드 이름: getTransactionById
이 GET 메소드는 지정된 트랜잭션 ID에 대한 트랜잭션 내역을 반환합니다. 비동기 방식입니다. 이 메소드는 모든 유저가 호출할 수 있습니다.
질의:
/getTransactionById?transactionId=transactionId value
매개변수:
  • transactionId: string – 트랜잭션의 ID로, 접두어 otransaction~ 뒤에 64비트 해시가 16진수 형식으로 표시됩니다.
반환 값 예제:
{
  "transactionId": "otransaction~9ea7b05ab099f7ff4db8342b8c3609031f1d54f11205906e7f1fe88661fe3cbe~33b59ce0c89e96c1e16449f24301581e8e71954f38ad977c7eb6f065e87f2a53",
  "history": [
    {
      "trxId": "9ea7b05ab099f7ff4db8342b8c3609031f1d54f11205906e7f1fe88661fe3cbe",
      "timeStamp": "2022-12-08T09:01:28.000Z",
      "value": {
        "assetType": "otransaction",
        "transactionId": "otransaction~9ea7b05ab099f7ff4db8342b8c3609031f1d54f11205906e7f1fe88661fe3cbe~33b59ce0c89e96c1e16449f24301581e8e71954f38ad977c7eb6f065e87f2a53",
        "tokenId": "tokenOne",
        "fromAccountId": "oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a",
        "toAccountId": "",
        "transactionType": "BURN",
        "amount": 5,
        "timestamp": "2022-12-08T09:01:28.000Z",
        "triggeredByUserAccountId": "ouaccount~24ffd4d32a028a85b4b960f5d55536c837b5429bc7f346150adfa904ec2937cc"
      }
    }
  ]
}
getUserByAccountId
원래 메소드 이름: getUserByAccountId
이 GET 메소드는 지정된 계정 ID에 대한 조직 ID 및 사용자 ID를 반환합니다.
질의:
/getUserByAccountId?accountId=accountId value
매개변수:
  • accountId: string – 계정의 ID입니다.
반환 값 예제:
{
    "orgId": "AppBldFFFFMay22",
    "userId": "user2"
}
getUsersByRole
원래 메소드 이름: getUsersByRole
이 GET 메소드는 지정된 롤에 대한 모든 사용자 목록을 반환합니다.
질의:
/getUsersByRole?role=role value (for example minter / burner)&tokenDetail={"tokenName":"tokenName value"}
매개변수:
  • role: string – 검색할 역할의 이름입니다.
  • tokenDetail: TokenDetail – 토큰을 지정하는 세부정보입니다. 대체 가능한 토큰의 경우 다음 형식을 사용합니다.
    {"tokenId":"token1"}
    사용할 수 없는 토큰의 경우 다음 형식을 사용합니다.
    {"tokenName":"artCollection"}
반환 값 예제:
{
    "users": [
        {
            "accountId": "oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a",
            "orgId": "appdev",
            "userId": "user2"
        },
        {
            "accountId": "oaccount~60bb20c14a83f6e426e1437c479c5891e1c6477dfd7ad18b73acac5d80bc504b",
            "orgId": "appdev",
            "userId": "user1"
        }
    ]
}
init
원래 메소드 이름: init
이 POST 메소드는 체인 코드가 배치될 때 호출됩니다. 사용자 정보는 체인 코드의 Token Admin로 저장됩니다.
페이로드:
{
 "adminList": "[{\"orgId\":\"{{bc-org-id}}\",\"userId\":\"{{bc-user-id}}\"}]"
}
매개변수:
  • adminList array – 토큰 관리자 목록을 지정하는 {user_id, org_id} 정보의 배열입니다. adminList 배열은 필수 매개변수입니다.
반환값:
  • 성공 시 페이로드가 없는 메시지입니다.
반환 값 예제:
{

}
isInRole
원래 메소드 이름: isInRole
이 GET 메소드는 사용자에게 지정된 롤이 있는지 여부를 나타내는 부울 값을 반환합니다. 이 메소드는 체인 코드의 Token Admin 또는 계정의 Account Owner에 의해서만 호출될 수 있습니다.
질의:
/isInRole?orgId={{bc-org-id}}&userId={{bc-user-id}}&role=role value (for example minter / burner)&tokenDetail={"tokenName":"tokenName value"}
매개변수:
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • userId: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
  • role: string – 검색할 역할의 이름입니다.
  • tokenDetail: TokenDetail – 토큰을 지정하는 세부정보입니다. 대체 가능한 토큰의 경우 다음 형식을 사용합니다.
    {"tokenId":"token1"}
    사용할 수 없는 토큰의 경우 다음 형식을 사용합니다.
    {"tokenName":"artCollection"}
반환 값 예제:
{
    "result": true,
    "msg": "Account Id oaccount~1422a74d262a3a55a37cd9023ef8836f765d0be7b49d397696b9961d7434d22a (Org-Id: appdev, User-Id: user2) has minter role"
}
isTokenAdmin
원래 메소드 이름: isTokenAdmin
이 GET 메소드는 함수 호출자가 Token Admin인 경우 부울 값 true를 반환하고, 그렇지 않은 경우 false를 반환합니다. 이 메소드는 체인 코드의 Token Admin에 의해서만 호출될 수 있습니다.
질의:
/isTokenAdmin?orgId={{bc-org-id}}&userId={{bc-user-id}}
매개변수:
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • userId: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
반환값:
  • 이 메소드는 호출자가 Token Admin인 경우 true를 반환하고, 그렇지 않은 경우 false를 반환합니다.
반환 값 예제:
{
  "result": true
}
mintBatch
원래 메소드 이름: mintBatch
이 POST 메소드는 일괄 처리 작업에 여러 토큰을 만듭니다(민트). 이 방법은 대체 가능한 토큰 또는 소수가 불가능한 토큰만 만듭니다.

대체 가능한 토큰의 경우 세부 항목 파일에 minter 롤이 정의된 경우 minter 롤을 가진 모든 사용자가 이 메소드를 호출할 수 있습니다. 그렇지 않은 경우 모든 사용자가 이 방법을 사용하여 토큰을 민트할 수 있습니다. 토큰이 생성 또는 업데이트될 때 해당 속성이 지정된 경우 토큰의 max_mint_quantity 속성을 초과하여 민트할 수 없습니다.

불가능한 토큰의 경우 minter 롤이 사양 파일에 정의된 경우 minter 롤을 가진 모든 사용자가 이 메소드를 호출할 수 있습니다. 그렇지 않은 경우 모든 사용자가 이 방법을 사용하여 토큰을 민트할 수 있습니다. 또한 호출자는 토큰의 생성자여야 합니다. 연쇄될 수 있는 소수점 비균형 토큰의 수량에는 상한이 없습니다.

이 메소드를 사용하여 완전하지 않은 토큰을 조율할 수 없습니다.

페이로드:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "tokenIds": "[\"{{bc-token-id}}\"]",
 "quantity": "[quantity value]",
 "sameOrgEndorser": true
}
매개변수:
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • userId: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
  • tokenIds: string[] – 민트 토큰에 대한 토큰 ID 목록입니다.
  • quantity: number[] – 토큰 ID 배열에 해당하는 토큰 대 민트 수량 목록입니다.
  • sameOrgEndorser: boolean – 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
반환값:
  • 성공 시 주조된 토큰에 대한 세부정보를 포함하는 JSON 객체입니다.
반환 값 예제:
{
    "msg": "Successfully minted batch of tokens for User-Account-Id ouaccount~412de5e3998dcd100973e1bad6e8729fddc1c7ff610beab8376d733a35c51f38 (Org-Id: AppBldFFFFMay22, User-Id: user2).",
    "details": [
        {
            "msg": "Successfully minted 100 tokens of fractional tokenId: plot55 to Org-Id: AppBldFFFFMay22, User-Id: user2"
        },
        {
            "msg": "Successfully minted 100 tokens of tokenId: loyalty to Token-Account-Id oaccount~21206f309941a2a23c4f158a0fe1b8f12bb8e2b0c9a2e1358f5efebc0c7d410e"
        }
    ]
}
post
원래 메소드 이름: post
이 POST 메소드는 지정된 가격에 판매할 토큰을 게시합니다.
페이로드:
{
 "tokenId": "{{bc-token-id}}",
 "sellingPrice": 1,
 "endorsers": {{endorsers}}
}
매개변수:
  • tokenId: string – 토큰 ID입니다.
  • sellingPrice: number – 토큰 가격입니다.
  • endorsers: string[] – 트랜잭션을 보증해야 하는 피어의 배열(예: peer1, peer2)입니다.
반환 값 예제:
{
  "msg": "Token ID : 'artCollection1' has been posted for selling in the marketplace"          
}
removeRole
원래 메소드 이름: removeRole
이 방법은 지정된 사용자로부터 역할을 제거합니다. 이 메소드는 체인 코드의 Token Admin에 의해서만 호출될 수 있습니다.
페이로드:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "role": "role value (for example minter / burner)",
 "tokenDetail": "{\"tokenName\":\"tokenName value\"}",
 "endorsers": {{endorsers}}
}
매개변수:
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • userId: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
  • role: string – 지정된 사용자로부터 제거할 역할의 이름입니다.
  • tokenDetail: TokenDetail – 토큰을 지정하는 세부정보입니다. 대체 가능한 토큰의 경우 다음 형식을 사용합니다.
    {"tokenId":"token1"}
    사용할 수 없는 토큰의 경우 다음 형식을 사용합니다.
    {"tokenName":"artCollection"}
  • endorsers: string[] – 트랜잭션을 보증해야 하는 피어의 배열(예: peer1, peer2)입니다.
반환 값 예제:
{
  "msg": "Successfully removed role 'minter' from Account Id: oaccount~60bb20c14a83f6e426e1437c479c5891e1c6477dfd7ad18b73acac5d80bc504b (Org-Id: appdev, User-Id: user1)"
}
removeTokenAdmin
원래 메소드 이름: removeTokenAdmin
이 POST 메소드는 사용자를 체인 코드의 Token Admin로 제거합니다. 이 메소드는 체인 코드의 Token Admin에 의해서만 호출될 수 있습니다. 관리자는 자신을 제거할 수 없습니다.
페이로드:
{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "sameOrgEndorser": true
}
매개변수:
  • org_id: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • user_id: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
  • sameOrgEndorser: boolean – 트랜잭션 보증이 요청자와 동일한 조직에서 온 것인지 여부를 나타내는 부울 값입니다.
반환 값 예제:
{
  "msg": "Successfully removed Admin (OrgId: appDev, UserId: user1)"
}
safeBatchTransferFrom
원래 메소드 이름: safeBatchTransferFrom
이 POST 메소드는 호출자에서 다른 계정으로 지정된 토큰의 소유권을 이전합니다. 이 메소드의 호출자는 토큰의 발신자여야 하며 지정된 토큰을 소유해야 합니다. 소수 NFT의 경우 사용자가 모든 공유를 다른 사용자에게 전송할 경우 토큰 소유권이 손실됩니다.
페이로드:
{
 "fromOrgId": "fromOrgId value",
 "fromUserId": "fromUserId value",
 "toOrgId": "toOrgId value",
 "toUserId": "toUserId value",
 "tokenIds": "[\"{{bc-token-id}}\"]",
 "quantity": "[quantity value]",
 "endorsers": {{endorsers}}
}
매개변수:
  • fromOrgId: string – 현재 조직의 발신자 및 토큰 소유자의 멤버쉽 서비스 제공자(MSP) ID입니다.
  • fromUserId: string – 발신자 및 토큰 소유자의 사용자 이름 또는 전자메일 ID입니다.
  • toOrgId: string – 현재 조직에서 수신자의 MSP(멤버쉽 서비스 제공자) ID입니다.
  • toUserId: string – 수신자의 사용자 이름 또는 전자 메일 ID입니다.
  • tokenIds: string[] – 전송할 토큰의 ID 배열입니다.
  • quantity: number[] – 토큰 ID 배열에 해당하는 전송할 토큰의 수량 목록입니다.
  • endorsers: string[] – 트랜잭션을 보증해야 하는 피어의 배열(예: peer1, peer2)입니다.
반환 값 예제:
[
    {
        "msg": "Successfully transferred NFT token: 'FNFT' of '10' quantity from Account-Id: oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371 (Org-Id: AppBldFFFFMay22, User-Id: user2) to Account-Id: oaccount~dcee860665db8740cb77b846e823752185a1e9a185814d0acb305890f5903446 (Org-Id: AppBldFFFFMay22, User-Id: example_minter)"
    },
    {
        "msg": "Successfully transferred 10 FT token: 'FT' from Account-Id: oaccount~21206f309941a2a23c4f158a0fe1b8f12bb8e2b0c9a2e1358f5efebc0c7d410e (Org-Id: AppBldFFFFMay22, User-Id: user2) to Account-Id: oaccount~1089ee5122f367ee0ca38c6660298f4b81f199627e4f67f3691c0f628237974c (Org-Id: AppBldFFFFMay22, User-Id: example_minter)"
    },
    {
        "msg": "Successfully transferred NFT token: 'NFT' from Account-Id: oaccount~e88276a3be547e31b567346bdddde52d37734da4d5fae83ab2e5c98a10097371 (Org-Id: AppBldFFFFMay22, User-Id: user2) to Account-Id: oaccount~dcee860665db8740cb77b846e823752185a1e9a185814d0acb305890f5903446 (Org-Id: AppBldFFFFMay22, User-Id: example_minter)"
    }
]
suspendAccount
원래 메소드 이름: suspendAccount
이 POST 메소드는 대체 가능한 토큰 계정을 일시 중지합니다. 원장에서 accountStatus 값을 찾을 수 없는 경우 오류가 발생합니다. 이 메소드는 체인 코드의 Token Admin에 의해서만 호출될 수 있습니다.
페이로드:
{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}
매개변수:
  • orgId: string – 현재 조직에 있는 사용자의 멤버쉽 서비스 공급자(MSP) ID입니다.
  • userId: string – 사용자의 사용자 이름 또는 전자메일 ID입니다.
  • endorsers: string[] – 트랜잭션을 보증해야 하는 피어의 배열(예: peer1, peer2)입니다.
반환 값 예제:
{
    "assetType": "oaccountStatus",
    "status_id": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
    "account_id": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
    "status": "suspended"
}
totalNetSupply
원래 메소드 이름: totalNetSupply
이 GET 메소드는 연동된 토큰의 총 수에서 연동된 토큰의 수를 뺀 값을 반환합니다. 이 메소드는 체인 코드의 Token Admin에 의해서만 호출될 수 있습니다.
질의(Fungible Tokens):
/totalNetSupply?tokenDetail={"tokenId":"{{bc-token-id}}"}
쿼리(불가 토큰):
/totalNetSupply?tokenDetail={"tokenName":"tokenName value"}
매개변수:
  • tokenDetail: TokenDetail – 토큰을 지정하는 세부정보입니다. 대체 가능한 토큰의 경우 다음 형식을 사용합니다.
    {"tokenId":"token1"}
    사용할 수 없는 토큰의 경우 다음 형식을 사용합니다.
    {"tokenName":"artCollection"}
반환 값 예제:
{
    "totalNetSupply": 105
}
totalSupply
원래 메소드 이름: totalSupply
이 GET 메소드는 조인된 토큰의 총 수를 반환합니다. 이 메소드는 체인 코드의 Token Admin에 의해서만 호출될 수 있습니다.
질의(Fungible Tokens):
/totalSupply?tokenDetail={"tokenId":"{{bc-token-id}}"}
쿼리(불가 토큰):
/totalSupply?tokenDetail={"tokenName":"tokenName value"}
매개변수:
  • tokenDetail: TokenDetail – 토큰을 지정하는 세부정보입니다. 대체 가능한 토큰의 경우 다음 형식을 사용합니다.
    {"tokenId":"token1"}
    사용할 수 없는 토큰의 경우 다음 형식을 사용합니다.
    {"tokenName":"artCollection"}
반환 값 예제:
{
    "totalSupply": 110
}
updateArtCollectionToken
원래 메소드 이름: updateArtCollectionToken
이 POST 메소드는 토큰 속성을 업데이트합니다. 토큰 소유자만 이 메소드를 호출할 수 있습니다. NFT의 경우 토큰이 민트된 후에는 토큰 메타데이터 및 토큰 URI를 업데이트할 수 없습니다.
페이로드:
{
 "tokenAsset": "{\"tokenId\":\"{{bc-token-id}}\",\"tokenDesc\":\"tokenDesc value\",\"tokenUri\":\"tokenUri value\",\"status\":\"status value\", \"tokenMetadata\":{\"ISIN\":\"ISIN value\",\"Segment\":\"Segment value\",\"Issuer\":\"Issuer value\",\"FaceValue\":999,\"IssueSize\":999,\"CouponRate\":999,\"InterestPaymentType\":\"InterestPaymentType value\",\"InterestFrequency\":\"InterestFrequency value\",\"IssueDate\":\"2023-03-28T15:16:36+00:00\",\"MaturityDate\":\"2023-03-28T15:16:36+00:00\"},\"status\":\"status value\"}",
 "sameOrgEndorser": true
}
매개변수:
  • tokenAsset: <Token Class> – 업데이트할 토큰 자산입니다. 토큰 자산의 속성에 대한 자세한 내용은 입력 사양 파일을 참조하십시오.
  • endorsers: string[] – 트랜잭션을 보증해야 하는 피어의 배열(예: peer1, peer2)입니다.
반환 값 예제:
{
            "tokenMetadata": {
                "ISIN": "ISIN value",
                "Segment": "Segment value",
                "Issuer": "Issuer value",
                "FaceValue": 999,
                "IssueSize": 999,
                "CouponRate": 999,
                "InterestPaymentType": "simple",
                "InterestFrequency": "monthly",
                "IssueDate": "2023-03-28T15:16:36.000Z",
                "MaturityDate": "2023-03-28T15:16:36.000Z"
            },
            "assetType": "otoken",
            "events": false,
            "tokenId": "token2",
            "tokenName": "bond",
            "tokenDesc": "tokenDesc value",
            "tokenStandard": "erc1155+",
            "tokenType": "nonfungible",
            "tokenUnit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner"
            },
            "mintable": {
                "max_mint_quantity": 0
            },
            "quantity": 10,
            "createdBy": "oaccount~85dfd98d1b99e5b8891e0a0fdcd7d2e07fc5d37958f5d2a5796290b6a9204a43",
            "creationDate": "2024-12-03T12:07:24.000Z",
            "divisible": {
                "decimal": 0
            },
            "isBurned": false,
            "isLocked": false,
            "tokenUri": "tokenUri value",
            "status": "created"
}
updateLoyaltyToken
원래 메소드 이름: updateLoyaltyToken
이 POST 메소드는 토큰 속성을 업데이트합니다. 토큰 소유자만 이 메소드를 호출할 수 있습니다. NFT의 경우 토큰이 민트된 후에는 토큰 메타데이터 및 토큰 URI를 업데이트할 수 없습니다.
페이로드:
{
 "tokenAsset": "{\"tokenId\":\"{{bc-token-id}}\",\"tokenDesc\":\"tokenDesc value\",\"Token_Name\":\"Token_Name value\",\"Token_to_Currency_Ratio\":999}",
 "sameOrgEndorser": true
}
매개변수:
  • tokenAsset: <Token Class> – 업데이트할 토큰 자산입니다. 토큰 자산의 속성에 대한 자세한 내용은 입력 사양 파일을 참조하십시오.
  • endorsers: string[] – 트랜잭션을 보증해야 하는 피어의 배열(예: peer1, peer2)입니다.
반환 값 예제:
{
            "assetType": "otoken",
            "events": false,
            "tokenId": "token2",
            "tokenName": "loyalty",
            "tokenDesc": "tokenDesc value",
            "tokenStandard": "erc1155+",
            "tokenType": "fungible",
            "tokenUnit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter",
                "burner_role_name": "burner"
            },
            "mintable": {
                "max_mint_quantity": 0
            },
            "quantity": 10,
            "createdBy": "oaccount~85dfd98d1b99e5b8891e0a0fdcd7d2e07fc5d37958f5d2a5796290b6a9204a43",
            "creationDate": "2024-12-03T12:07:24.000Z",
            "divisible": {
                "decimal": 0
            },
            "isBurned": false,
            "isLocked": false,
            "tokenUri": "tokenUri value",
            "status": "created"
}
URI
원래 메소드 이름: URI
이 GET 메소드는 지정된 토큰의 URI를 반환합니다. 토큰 생성자만 이 메소드를 호출할 수 있습니다.
질의
/URI?tokenId={{bc-token-id}}
매개변수:
  • tokenId: string – 토큰 ID입니다.
반환 값 예제:
{
    "tokenUri": "example.com"
}