Get User Defined Function - Get User Defined Function

Service:

Azure confidential ledger

API Version:

2024-12-09-preview

Gets a user defined function.
Returns the user defined function in the Confidential Ledger

GET {ledgerEndpoint}/app/userDefinedFunctions/{functionId}?api-version=2024-12-09-preview

URI Parameters

Name	In	Required	Type	Description
functionId	path	True	string	Identifies a user defined function.
ledgerEndpoint	path	True	string (uri)	The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	UserDefinedFunction	The request has succeeded.
Other Status Codes	ConfidentialLedgerCommon.ConfidentialLedgerError	An unexpected error response.

Examples

Get User Defined Function

Sample request

HTTP

GET {ledgerEndpoint}/app/userDefinedFunctions/myFunction?api-version=2024-12-09-preview

Sample response

Status code:

200

{
  "id": "myFunction",
  "code": "export function main() { return true }"
}

Definitions

Name	Description
ConfidentialLedgerCommon.ConfidentialLedgerError	An error response from Confidential Ledger.
ConfidentialLedgerCommon.ConfidentialLedgerErrorBody	An error response from Confidential Ledger.
UserDefinedFunction	A user defined function in the ledger.

ConfidentialLedgerCommon.ConfidentialLedgerError

Object

An error response from Confidential Ledger.

Name	Type	Description
error	ConfidentialLedgerCommon.ConfidentialLedgerErrorBody	An error response from Confidential Ledger.

ConfidentialLedgerCommon.ConfidentialLedgerErrorBody

Object

An error response from Confidential Ledger.

Name	Type	Description
code	string	The error code.
message	string	The error message.

UserDefinedFunction

Object

A user defined function in the ledger.

Name	Type	Description
code	string	Code of the user defined function in JavaScript.
id	string	ID of the user defined function.