Validate and enqueue an admin-launched Global action function.
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/global-action/enqueue"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"FunctionId\": \"example\", \"Input\": \"example\", \"CorrelationId\": \"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/global-action/enqueue';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"FunctionId":"example","Input":"example","CorrelationId":"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/global-action/enqueue \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "FunctionId": "example", "Input": "example", "CorrelationId": "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”Request payload to validate and enqueue an admin-launched Global action function.
object
Business function identifier.
Action input object keyed by CLR property name.
Optional correlation identifier.
Examplegenerated
{ "FunctionId": "example", "Input": "example", "CorrelationId": "example"}Request payload to validate and enqueue an admin-launched Global action function.
object
Business function identifier.
Action input object keyed by CLR property name.
Optional correlation identifier.
Examplegenerated
{ "FunctionId": "example", "Input": "example", "CorrelationId": "example"}Request payload to validate and enqueue an admin-launched Global action function.
object
Business function identifier.
Action input object keyed by CLR property name.
Optional correlation identifier.
Examplegenerated
{ "FunctionId": "example", "Input": "example", "CorrelationId": "example"}Responses
Section titled “Responses”OK
object
Backend-only queued action invocation result.
object
Queued function run identifier.
Queued function run summary.
object
Queued run identifier.
Queued function identifier.
Captured function version identifier.
Execution source.
Optional deduplication key.
Queue priority; lower numbers run first.
Execution attempt count.
Timestamp when the run was queued.
Next eligible run timestamp.
Original actor user identifier, when any.
Source user identifier when the worker runs under a different actor.
Correlation identifier.
Related entity definition identifier.
Related entity instance identifier.
Related entity operation.
Trigger binding identifier, when this run came from a trigger.
Schedule identifier, when this run came from a schedule.
Action binding identifier, when this run came from an action.
Action input JSON snapshot.
Selected entity ids JSON snapshot for selection actions.
Last execution error summary.
Timestamp when cancellation was requested.
User that requested cancellation.
Timestamp when cancellation was observed by the worker.
Whether the queued run can be cancelled manually.
Optional source-owned timeout captured for schedule or API-enqueue runs.
Stable machine-readable reason code for the latest failed attempt.
Read-only product invocation owner key.
Read-only owning configuration identity.
Durable module operation correlated with this invocation.
Net Operation Project source revision captured for this job.
Net Operation Project build captured for this job.
Net Operation Project artifact captured for this job.
Maximum attempts captured when this job was enqueued.
Retry delay captured when this job was enqueued.
Attempts still available after the current attempt.
Whether the persisted policy permits a later attempt.
Whether the administrator can stop this retry chain.
Stable reason for the accepted retry stop.
Current one-based execution attempt; zero means the initial attempt has not started.
Backend-only action invocation validation result.
object
Designer-owned action identifier, or null for admin-launched Global actions.
Business function identifier resolved from the binding.
Published function version pinned for enqueue/execution.
Resolved entity definition identifier, when applicable.
Resolved entity instance identifier, when applicable.
Normalized selected entity instance ids.
Normalized action input JSON snapshot.
Validation errors returned by platform or package validation.
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.
object
object
object
object
Example
{ "Data": { "Job": { "RuntimeKind": 0, "VersionResolutionMode": 0, "Status": 0, "ActionTargetScope": 0, "CancellationKind": 0, "RetryStopState": 0 }, "Validation": { "ActionTargetScope": 0 } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Backend-only queued action invocation result.
object
Queued function run identifier.
Queued function run summary.
object
Queued run identifier.
Queued function identifier.
Captured function version identifier.
Execution source.
Optional deduplication key.
Queue priority; lower numbers run first.
Execution attempt count.
Timestamp when the run was queued.
Next eligible run timestamp.
Original actor user identifier, when any.
Source user identifier when the worker runs under a different actor.
Correlation identifier.
Related entity definition identifier.
Related entity instance identifier.
Related entity operation.
Trigger binding identifier, when this run came from a trigger.
Schedule identifier, when this run came from a schedule.
Action binding identifier, when this run came from an action.
Action input JSON snapshot.
Selected entity ids JSON snapshot for selection actions.
Last execution error summary.
Timestamp when cancellation was requested.
User that requested cancellation.
Timestamp when cancellation was observed by the worker.
Whether the queued run can be cancelled manually.
Optional source-owned timeout captured for schedule or API-enqueue runs.
Stable machine-readable reason code for the latest failed attempt.
Read-only product invocation owner key.
Read-only owning configuration identity.
Durable module operation correlated with this invocation.
Net Operation Project source revision captured for this job.
Net Operation Project build captured for this job.
Net Operation Project artifact captured for this job.
Maximum attempts captured when this job was enqueued.
Retry delay captured when this job was enqueued.
Attempts still available after the current attempt.
Whether the persisted policy permits a later attempt.
Whether the administrator can stop this retry chain.
Stable reason for the accepted retry stop.
Current one-based execution attempt; zero means the initial attempt has not started.
Backend-only action invocation validation result.
object
Designer-owned action identifier, or null for admin-launched Global actions.
Business function identifier resolved from the binding.
Published function version pinned for enqueue/execution.
Resolved entity definition identifier, when applicable.
Resolved entity instance identifier, when applicable.
Normalized selected entity instance ids.
Normalized action input JSON snapshot.
Validation errors returned by platform or package validation.
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.
object
object
object
object
Example
{ "Data": { "Job": { "RuntimeKind": 0, "VersionResolutionMode": 0, "Status": 0, "ActionTargetScope": 0, "CancellationKind": 0, "RetryStopState": 0 }, "Validation": { "ActionTargetScope": 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
Backend-only queued action invocation result.
object
Queued function run identifier.
Queued function run summary.
object
Queued run identifier.
Queued function identifier.
Captured function version identifier.
Execution source.
Optional deduplication key.
Queue priority; lower numbers run first.
Execution attempt count.
Timestamp when the run was queued.
Next eligible run timestamp.
Original actor user identifier, when any.
Source user identifier when the worker runs under a different actor.
Correlation identifier.
Related entity definition identifier.
Related entity instance identifier.
Related entity operation.
Trigger binding identifier, when this run came from a trigger.
Schedule identifier, when this run came from a schedule.
Action binding identifier, when this run came from an action.
Action input JSON snapshot.
Selected entity ids JSON snapshot for selection actions.
Last execution error summary.
Timestamp when cancellation was requested.
User that requested cancellation.
Timestamp when cancellation was observed by the worker.
Whether the queued run can be cancelled manually.
Optional source-owned timeout captured for schedule or API-enqueue runs.
Stable machine-readable reason code for the latest failed attempt.
Read-only product invocation owner key.
Read-only owning configuration identity.
Durable module operation correlated with this invocation.
Net Operation Project source revision captured for this job.
Net Operation Project build captured for this job.
Net Operation Project artifact captured for this job.
Maximum attempts captured when this job was enqueued.
Retry delay captured when this job was enqueued.
Attempts still available after the current attempt.
Whether the persisted policy permits a later attempt.
Whether the administrator can stop this retry chain.
Stable reason for the accepted retry stop.
Current one-based execution attempt; zero means the initial attempt has not started.
Backend-only action invocation validation result.
object
Designer-owned action identifier, or null for admin-launched Global actions.
Business function identifier resolved from the binding.
Published function version pinned for enqueue/execution.
Resolved entity definition identifier, when applicable.
Resolved entity instance identifier, when applicable.
Normalized selected entity instance ids.
Normalized action input JSON snapshot.
Validation errors returned by platform or package validation.
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.
object
object
object
object
Example
{ "Data": { "Job": { "RuntimeKind": 0, "VersionResolutionMode": 0, "Status": 0, "ActionTargetScope": 0, "CancellationKind": 0, "RetryStopState": 0 }, "Validation": { "ActionTargetScope": 0 } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}