New, Changed and Deprecated APIs
This page describes the resource paths and endpoints that are new, changed, or deprecated from previous releases.
This document is specific to Oracle Blockchain Platform REST APIs on Hyperledger Fabric v2.2 or later.
Hyperledger Fabric v2.5
All Oracle Blockchain Platform REST APIs for Hyperledger Fabric v2.2 will work as-is after you upgrade to Hyperledger Fabric v2.5.
Hyperledger Fabric v2.2
Although most of the existing Hyperledger Fabric v1.4 APIs have a new Hyperledger Fabric v2 equivalent, there is not a 1:1 match. Some APIs are unique to each version of Hyperledger Fabric, and some have different parameters for each release.
Which Resource Paths and Endpoints Were Added or Modified
These resource paths and endpoints were modified from earlier Oracle Blockchain Platform releases or may have slightly different functionality in this release.
Endpoints | Resource Paths | Functional Changes | |
---|---|---|---|
Application Operations | |||
Versions |
|
New in 22.2.1, you can query the Oracle Blockchain Platform, Hyperledger Fabric and admin API versions. |
|
Audit Log Events |
Hyperledger Fabric v2.x base path
|
New in 21.1.2, you can retrieve audit log information from a REST API endpoint. The audit log is a record of administrative console activity, including actions related to channels, organizations, nodes, and chaincode. | |
Atomic Transactions |
Hyperledger Fabric v2.x base path
|
New in 22.3.2, atomic transactions are supported. An atomic transaction is an indivisible series of data operations that either all succeed, or none succeed. New in 22.4.2, you can include Ethereum-based transactions in an atomic transaction workflow using the Last Resource Commit (LRC) parameters. New in 23.3.3 you can use atomic transactions to transfer NFTs from Oracle Blockchain Platform to an Ethereum or Polygon network using the Last Resource Commit (LRC) parameters. See Atomic Transactions. |
|
Events |
Hyperledger Fabric v1.4 base path
Hyperledger Fabric v2.x base path
|
All other endpoints continue to function as they did in earlier releases, but with the new basepath. New in 22.2.1, while subscribing to an event, you can now optionally select the maximum number of callback retries. New in 22.4.2, in addition to TLS, you can invoke callback endpoints secured with OAuth 2.0. New in 22.4.2, the |
|
Transactions |
Hyperledger Fabric v1.4 base path
Hyperledger Fabric v2.x base path
|
New in Fabric v2.2, when sending a transaction, you can now optionally specify if it's an initialization request by using the All other endpoints continue to function as they did in earlier releases, but with the new basepath. New in 24.4.3, several new endpoints specific to asynchronous transactions and scheduling transactions have been added:
|
|
Blockchain Network Administrative Operations |
All blockchain network administrative operations have been updated from v1.1 to v2. All endpoints will use this new basepath. |
||
Chaincode |
Hyperledger Fabric v1.4 APIs with the base path:
|
The chaincode lifecycle is different between Hyperledger Fabric v1.4 and v2.2. Thus the available endpoints, their parameters and functionality are new in Hyperledger Fabric v2.2. Closely read the documentation for the new lifecycle before migrating your REST API calls to the new platform level.
New in 22.4.2, you can delete an installed chaincode package to free up storage space in your instance. |
|
Channel |
Hyperledger Fabric v1.4 base path
|
New endpoints in Hyperledger Fabric v2.2
All other channel endpoints continue to function as they did in earlier releases, but with the new basepath. |
|
Nodes |
Hyperledger Fabric v1.4 base path
|
Modified endpoints in Hyperledger Fabric v2.2
All other node endpoints continue to function as they did in earlier releases, but with the new basepath. |
|
Organizations |
Hyperledger Fabric v1.4 base path
|
All organization endpoints continue to function as they did in earlier releases, but with the new basepath. |
|
Blockchain Platform Administrative Operations | Hyperledger Fabric v1.4 and v2.x base paths
|
These APIs did not change between Hyperledger Fabric v1.4 and v2.2. New in 24.4.3, Digital Assets Edition support was added. |
|
Statistics |
Hyperledger Fabric v1.4 base path
|
Deprecated endpoints in Hyperledger Fabric v2.2
Due to the change in chaincode lifecycle between Hyperledger Fabric versions, any statistics pertaining to the earlier version's lifecycle are deprecated once you migrate your platform to the new version. Note that these will still work if you have not yet migrated to Hyperledger Fabic v2.x. All non-deprecated endpoints continue to function as they did in earlier releases, but with the new basepath. |
Which Resource Paths and Endpoints are Deprecated
These resource paths and endpoints are deprecated.
Endpoints | Deprecated in Release Version | Resource Path | Additional Information |
---|---|---|---|
Blockchain Network Administrative Operations | Hyperledger Fabric v2.2 |
|
Due to the change in chaincode lifecycle between Hyperledger Fabric versions, any administrative operations pertaining to the earlier version's lifecycle are deprecated once you migrate your platform to the new version. Note that these will still work if you have not yet migrated to Hyperledger Fabic v2.2. |
Statistics | Hyperledger Fabric v2.2 |
|
Due to the change in chaincode lifecycle between Hyperledger Fabric versions, any statistics pertaining to the earlier version's lifecycle are deprecated once you migrate your platform to the new version. Note that these will still work if you have not yet migrated to Hyperledger Fabic v2.2. |
Note:
- The deprecated resource path and endpoints will become obsolete in the release listed. This means when you create an instance using that version or upgrade an existing instance, you will no longer be able to use these endpoints.
- It is recommended that you migrate your applications to use the new paths and endpoints at your earliest convenience. This will minimize any disruption in the future when the deprecated URL structures are no longer supported.