Run a published business function with supplied test context.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://example.com/api/workspace/admin/function-catalog/example/test-invocations"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"Args\": \"example\", \"CorrelationId\": \"example\", \"EntityDefinitionId\": \"example\", \"EntityInstanceId\": \"example\", \"EntityOperation\": \"example\", \"Record\": \"example\", \"PreviousRecord\": \"example\" }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};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/test-invocations';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"Args":"example","CorrelationId":"example","EntityDefinitionId":"example","EntityInstanceId":"example","EntityOperation":"example","Record":"example","PreviousRecord":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/workspace/admin/function-catalog/example/test-invocations \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "Args": "example", "CorrelationId": "example", "EntityDefinitionId": "example", "EntityInstanceId": "example", "EntityOperation": "example", "Record": "example", "PreviousRecord": "example" }'Authorizations
Section titled “Authorizations”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.
Request Body
Section titled “Request Body”Admin test invocation request for a published business function.
object
Optional JSON arguments exposed as ctx.args.
Optional correlation identifier.
Optional related entity definition identifier for entity-scoped execution.
Optional related entity instance identifier for entity-scoped execution.
Optional related entity operation label for entity-scoped execution.
Optional draft/current entity record exposed to dynamic functions and package entity bridges.
Optional previous entity record exposed to dynamic functions and package entity bridges.
Examplegenerated
{ "Args": "example", "CorrelationId": "example", "EntityDefinitionId": "example", "EntityInstanceId": "example", "EntityOperation": "example", "Record": "example", "PreviousRecord": "example"}Admin test invocation request for a published business function.
object
Optional JSON arguments exposed as ctx.args.
Optional correlation identifier.
Optional related entity definition identifier for entity-scoped execution.
Optional related entity instance identifier for entity-scoped execution.
Optional related entity operation label for entity-scoped execution.
Optional draft/current entity record exposed to dynamic functions and package entity bridges.
Optional previous entity record exposed to dynamic functions and package entity bridges.
Examplegenerated
{ "Args": "example", "CorrelationId": "example", "EntityDefinitionId": "example", "EntityInstanceId": "example", "EntityOperation": "example", "Record": "example", "PreviousRecord": "example"}Admin test invocation request for a published business function.
object
Optional JSON arguments exposed as ctx.args.
Optional correlation identifier.
Optional related entity definition identifier for entity-scoped execution.
Optional related entity instance identifier for entity-scoped execution.
Optional related entity operation label for entity-scoped execution.
Optional draft/current entity record exposed to dynamic functions and package entity bridges.
Optional previous entity record exposed to dynamic functions and package entity bridges.
Examplegenerated
{ "Args": "example", "CorrelationId": "example", "EntityDefinitionId": "example", "EntityInstanceId": "example", "EntityOperation": "example", "Record": "example", "PreviousRecord": "example"}Responses
Section titled “Responses”OK
object
Business function execution result.
object
Persisted run identifier.
Function identifier.
Executed function version identifier.
Execution source.
Actor user identifier.
Correlation identifier.
Execution start timestamp.
Execution completion timestamp.
Execution duration in milliseconds.
Bounded result summary.
Structured JSON result payload.
Bounded error summary.
Bounded diagnostic log summary.
Structured validation errors produced during function execution or persistence.
Structured validation error emitted during business-function execution or persistence.
object
Optional entity field key targeted by the error.
User-facing validation message.
Optional stable validation code.
Stable machine-readable reason code for a platform or runtime failure.
Net Operation Project source revision captured for this execution.
Net Operation Project build captured for this execution.
Net Operation Project artifact captured by the published function version.
Net Operation Project artifact selected before runtime activation.
Runtime epoch created after successful artifact activation.
object
object
object
object
Example
{ "Data": { "Status": 0 }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Business function execution result.
object
Persisted run identifier.
Function identifier.
Executed function version identifier.
Execution source.
Actor user identifier.
Correlation identifier.
Execution start timestamp.
Execution completion timestamp.
Execution duration in milliseconds.
Bounded result summary.
Structured JSON result payload.
Bounded error summary.
Bounded diagnostic log summary.
Structured validation errors produced during function execution or persistence.
Structured validation error emitted during business-function execution or persistence.
object
Optional entity field key targeted by the error.
User-facing validation message.
Optional stable validation code.
Stable machine-readable reason code for a platform or runtime failure.
Net Operation Project source revision captured for this execution.
Net Operation Project build captured for this execution.
Net Operation Project artifact captured by the published function version.
Net Operation Project artifact selected before runtime activation.
Runtime epoch created after successful artifact activation.
object
object
object
object
Example
{ "Data": { "Status": 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
Business function execution result.
object
Persisted run identifier.
Function identifier.
Executed function version identifier.
Execution source.
Actor user identifier.
Correlation identifier.
Execution start timestamp.
Execution completion timestamp.
Execution duration in milliseconds.
Bounded result summary.
Structured JSON result payload.
Bounded error summary.
Bounded diagnostic log summary.
Structured validation errors produced during function execution or persistence.
Structured validation error emitted during business-function execution or persistence.
object
Optional entity field key targeted by the error.
User-facing validation message.
Optional stable validation code.
Stable machine-readable reason code for a platform or runtime failure.
Net Operation Project source revision captured for this execution.
Net Operation Project build captured for this execution.
Net Operation Project artifact captured by the published function version.
Net Operation Project artifact selected before runtime activation.
Runtime epoch created after successful artifact activation.
object
object
object
object
Example
{ "Data": { "Status": 0 }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}