Return one business function from the synchronized runtime catalog.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://example.com/api/workspace/admin/function-catalog/example"),};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/admin/function-catalog/example';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/workspace/admin/function-catalog/exampleAuthorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Responses
Section titled “Responses”OK
object
Administrative business function detail.
object
Function identifier.
Stable function key.
User-facing function name.
Optional description.
Owning entity definition for entity functions.
Whether the function can be invoked by future runtime slices.
Creation timestamp.
Last metadata modification timestamp.
Last modifying user identifier.
Immutable business function script version.
object
Version identifier.
Owning function identifier.
Monotonic version number within the function.
Action input CLR type name.
Action input signature hash.
Immutable action input schema JSON payload, including field nullability and typed Boolean or Select defaults when declared.
Action input Form metadata JSON payload.
Action input-history Card metadata JSON payload.
Creation timestamp.
User that created the version.
Publication timestamp, when published.
User that published the version.
Function versions ordered by version number.
Immutable business function script version.
object
Version identifier.
Owning function identifier.
Monotonic version number within the function.
Action input CLR type name.
Action input signature hash.
Immutable action input schema JSON payload, including field nullability and typed Boolean or Select defaults when declared.
Action input Form metadata JSON payload.
Action input-history Card metadata JSON payload.
Creation timestamp.
User that created the version.
Publication timestamp, when published.
User that published the version.
Entity bindings that reference this function.
Entity-bound business function binding.
object
Binding identifier.
Entity definition identifier.
Bound function identifier.
Execution order within the source and operation.
Whether the binding is enabled.
Concurrency token.
Concurrency token.
object
object
object
object
Example
{ "Data": { "Kind": 0, "CurrentPublishedVersion": { "Contract": 0, "ActionTargetScope": 0 }, "Versions": [ { "Contract": 0, "ActionTargetScope": 0 } ], "Bindings": [ { "Source": 0, "Operation": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Administrative business function detail.
object
Function identifier.
Stable function key.
User-facing function name.
Optional description.
Owning entity definition for entity functions.
Whether the function can be invoked by future runtime slices.
Creation timestamp.
Last metadata modification timestamp.
Last modifying user identifier.
Immutable business function script version.
object
Version identifier.
Owning function identifier.
Monotonic version number within the function.
Action input CLR type name.
Action input signature hash.
Immutable action input schema JSON payload, including field nullability and typed Boolean or Select defaults when declared.
Action input Form metadata JSON payload.
Action input-history Card metadata JSON payload.
Creation timestamp.
User that created the version.
Publication timestamp, when published.
User that published the version.
Function versions ordered by version number.
Immutable business function script version.
object
Version identifier.
Owning function identifier.
Monotonic version number within the function.
Action input CLR type name.
Action input signature hash.
Immutable action input schema JSON payload, including field nullability and typed Boolean or Select defaults when declared.
Action input Form metadata JSON payload.
Action input-history Card metadata JSON payload.
Creation timestamp.
User that created the version.
Publication timestamp, when published.
User that published the version.
Entity bindings that reference this function.
Entity-bound business function binding.
object
Binding identifier.
Entity definition identifier.
Bound function identifier.
Execution order within the source and operation.
Whether the binding is enabled.
Concurrency token.
Concurrency token.
object
object
object
object
Example
{ "Data": { "Kind": 0, "CurrentPublishedVersion": { "Contract": 0, "ActionTargetScope": 0 }, "Versions": [ { "Contract": 0, "ActionTargetScope": 0 } ], "Bindings": [ { "Source": 0, "Operation": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}