Hyperledger Fabric - get history
Search form
Description - Queries a Hyperledger Fabric Channel for the history of a key
Runtime Class - com.ibi.agents.XDFabricKeyHistoryAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description * Namespace string Namespace of the key, this is usually the chaincode name.
* Key string Name of the key
* Block Number string The number of a block containing a transaction with a write of the key. This is a non-negative integer block number, or a negative integer block number relative to the current block height (-1 is the latest block).
* Transaction Number integer The index of the transaction within the selected block
* - denotes required
Parameter Type Description Encoding string How each search criteria will be converted to string. Choose UTF-8 or type a Charset name to convert the bytes to string, or choose Hex to convert the ByteString to a hex encoded string with two hex characters per byte.
Select from one of the following options:
- Hex String {hex}
- UTF-8 String {UTF-8}
* - denotes required
Parameter Type Description From: string Starting time (timestamp) to search from. Format:yyyy-MM-dd'T'HH:mm:ss.SSSXXX where XXX is an ISO 8601 time zone. Timestamps are created by clients without a central clock. It is therefore recommended to specify a date earlier than necessary by some margin.
Maximum Depth: integer The maximum number of versions of the key to report
* - denotes required
Parameter Type Description Format: string Format of the history in the output document
Select from one of the following options:
- XML {xml}
- JSON {json}
* - denotes required
Output Events
Runtime Class - com.ibi.agents.XDFabricKeyHistoryAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description * Namespace string Namespace of the key, this is usually the chaincode name.
* Key string Name of the key
* Block Number string The number of a block containing a transaction with a write of the key. This is a non-negative integer block number, or a negative integer block number relative to the current block height (-1 is the latest block).
* Transaction Number integer The index of the transaction within the selected block
* - denotes required
Parameter Type Description Encoding string How each search criteria will be converted to string. Choose UTF-8 or type a Charset name to convert the bytes to string, or choose Hex to convert the ByteString to a hex encoded string with two hex characters per byte.
Select from one of the following options:
- Hex String {hex}
- UTF-8 String {UTF-8}
* - denotes required
Parameter Type Description From: string Starting time (timestamp) to search from. Format:yyyy-MM-dd'T'HH:mm:ss.SSSXXX where XXX is an ISO 8601 time zone. Timestamps are created by clients without a central clock. It is therefore recommended to specify a date earlier than necessary by some margin.
Maximum Depth: integer The maximum number of versions of the key to report
* - denotes required
Parameter Type Description Format: string Format of the history in the output document
Select from one of the following options:
- XML {xml}
- JSON {json}
* - denotes required
Output Events
Configuration
This action requires a Generics Configuration as well as the following required parameters.Parameter Groups
| Parameter | Type | Description | |
|---|---|---|---|
| * | Namespace | string | Namespace of the key, this is usually the chaincode name. | * | Key | string | Name of the key | * | Block Number | string | The number of a block containing a transaction with a write of the key. This is a non-negative integer block number, or a negative integer block number relative to the current block height (-1 is the latest block). | * | Transaction Number | integer | The index of the transaction within the selected block |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Encoding | string | How each search criteria will be converted to string. Choose UTF-8 or type a Charset name to convert the bytes to string, or choose Hex to convert the ByteString to a hex encoded string with two hex characters per byte.
Select from one of the following options:
|
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| From: | string | Starting time (timestamp) to search from. Format:yyyy-MM-dd'T'HH:mm:ss.SSSXXX where XXX is an ISO 8601 time zone. Timestamps are created by clients without a central clock. It is therefore recommended to specify a date earlier than necessary by some margin. | Maximum Depth: | integer | The maximum number of versions of the key to report |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Format: | string | Format of the history in the output document
Select from one of the following options:
|
* - denotes required
Output Events
| Name | Description |
|---|---|
| onFailParse | Could not parse a document. |
| onFailOperation | Could not perform the operation requested. |