Microsoft.ConfidentialLedger (preview:2024-12-09)

2025/03/11 • 2 updated methods

ListLedgerEntries (updated)
Description :  A collection id may optionally be specified. Only entries in the specified (or default) collection will be returned.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ListLedgerEntries",
  "$parameters": {
    "@added_4971a4fcb1354b79b124a1d9aa15cb1b": {
      "#name": "tag",
      "Description": "Single tag.",
      "Required": false,
      "Type": "string"
    }
  }
}

⚼ Request

GET:  /app/transactions
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection id. ,
Required: False ,
}
string ,
fromTransactionId:
{
Description: Specify the first transaction ID in a range. ,
Required: False ,
}
string ,
toTransactionId:
{
Description: Specify the last transaction ID in a range. ,
Required: False ,
}
string ,
tag:
{
Description: Single tag. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
state:
{
Description: State of a ledger query. ,
Enum:
{
Loading: No description available. ,
Ready: No description available. ,
}
,
Required: True ,
}
enum ,
nextLink:
{
Description: Path from which to retrieve the next page of results. ,
Required: False ,
}
string ,
entries:
{
Description: Array of ledger entries. ,
Required: True ,
}
[
{
contents:
{
Description: Contents of the ledger entry. ,
Required: True ,
}
string ,
collectionId:
{
Required: False ,
}
string ,
transactionId:
{
Description: A unique identifier for the state of the ledger. If returned as part of a LedgerEntry, it indicates the state from which the entry was read. ,
Required: False ,
}
string ,
preHooks:
{
Description: List of user defined function hooks to be executed before the ledger entry is written. ,
Required: False ,
}
[
{
functionId:
{
Description: ID of the user defined function to execute. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for executing a user defined function. ,
Required: False ,
}
{
arguments:
{
Description: Runtime arguments of the user defined function. Defaults to an empty list. ,
Required: False ,
}
[
string ,
]
,
exportedFunctionName:
{
Description: Name of the exported function to execute in the code of the user defined function. Defaults to main. ,
Required: False ,
}
string ,
runtimeOptions:
{
Description: JS runtime options for user defined endpoints and functions ,
Required: False ,
}
{
log_exception_details:
{
Required: False ,
}
boolean ,
max_cached_interpreters:
{
Format: int64 ,
Required: False ,
}
integer ,
max_execution_time_ms:
{
Format: int64 ,
Required: False ,
}
integer ,
max_heap_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
max_stack_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
return_exception_details:
{
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
postHooks:
{
Description: List of user defined function hooks to be executed after the ledger entry is written. ,
Required: False ,
}
[
{
functionId:
{
Description: ID of the user defined function to execute. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for executing a user defined function. ,
Required: False ,
}
{
arguments:
{
Description: Runtime arguments of the user defined function. Defaults to an empty list. ,
Required: False ,
}
[
string ,
]
,
exportedFunctionName:
{
Description: Name of the exported function to execute in the code of the user defined function. Defaults to main. ,
Required: False ,
}
string ,
runtimeOptions:
{
Description: JS runtime options for user defined endpoints and functions ,
Required: False ,
}
{
log_exception_details:
{
Required: False ,
}
boolean ,
max_cached_interpreters:
{
Format: int64 ,
Required: False ,
}
integer ,
max_execution_time_ms:
{
Format: int64 ,
Required: False ,
}
integer ,
max_heap_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
max_stack_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
return_exception_details:
{
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Confidential Ledger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CreateLedgerEntry (updated)
Description :  A collection id may optionally be specified.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CreateLedgerEntry",
  "$parameters": {
    "@added_00707956629e41bfb0a18c320c7dac2f": {
      "#name": "tags",
      "Description": "Comma separated tags.",
      "Required": false,
      "Type": "string"
    }
  }
}

⚼ Request

POST:  /app/transactions
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection id. ,
Required: False ,
}
string ,
entry:
{
Description: Ledger entry. ,
Required: True ,
}
{
contents:
{
Description: Contents of the ledger entry. ,
Required: True ,
}
string ,
collectionId:
{
Required: False ,
}
string ,
transactionId:
{
Description: A unique identifier for the state of the ledger. If returned as part of a LedgerEntry, it indicates the state from which the entry was read. ,
Required: False ,
}
string ,
preHooks:
{
Description: List of user defined function hooks to be executed before the ledger entry is written. ,
Required: False ,
}
[
{
functionId:
{
Description: ID of the user defined function to execute. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for executing a user defined function. ,
Required: False ,
}
{
arguments:
{
Description: Runtime arguments of the user defined function. Defaults to an empty list. ,
Required: False ,
}
[
string ,
]
,
exportedFunctionName:
{
Description: Name of the exported function to execute in the code of the user defined function. Defaults to main. ,
Required: False ,
}
string ,
runtimeOptions:
{
Description: JS runtime options for user defined endpoints and functions ,
Required: False ,
}
{
log_exception_details:
{
Required: False ,
}
boolean ,
max_cached_interpreters:
{
Format: int64 ,
Required: False ,
}
integer ,
max_execution_time_ms:
{
Format: int64 ,
Required: False ,
}
integer ,
max_heap_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
max_stack_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
return_exception_details:
{
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
postHooks:
{
Description: List of user defined function hooks to be executed after the ledger entry is written. ,
Required: False ,
}
[
{
functionId:
{
Description: ID of the user defined function to execute. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for executing a user defined function. ,
Required: False ,
}
{
arguments:
{
Description: Runtime arguments of the user defined function. Defaults to an empty list. ,
Required: False ,
}
[
string ,
]
,
exportedFunctionName:
{
Description: Name of the exported function to execute in the code of the user defined function. Defaults to main. ,
Required: False ,
}
string ,
runtimeOptions:
{
Description: JS runtime options for user defined endpoints and functions ,
Required: False ,
}
{
log_exception_details:
{
Required: False ,
}
boolean ,
max_cached_interpreters:
{
Format: int64 ,
Required: False ,
}
integer ,
max_execution_time_ms:
{
Format: int64 ,
Required: False ,
}
integer ,
max_heap_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
max_stack_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
return_exception_details:
{
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
}
,
tags:
{
Description: Comma separated tags. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: The transaction id at which this write will become durable. ,
}
string ,
}
,
$schema:
{
Description: Returned as a result of a write to the Confidential Ledger, the transaction id in the response indicates when the write will become durable. ,
}
{
collectionId:
{
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Confidential Ledger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}