Cancel a queued run or request cancellation for a running 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-operations/jobs/example/cancel"),};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-operations/jobs/example/cancel';const options = {method: 'POST'};
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-operations/jobs/example/cancelAuthorizations
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
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.
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.
object
object
object
object
Example
{ "Data": { "VersionResolutionMode": 0, "Status": 0, "ActionTargetScope": 0, "CancellationKind": 0, "RetryStopState": 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
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.
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.
object
object
object
object
Example
{ "Data": { "VersionResolutionMode": 0, "Status": 0, "ActionTargetScope": 0, "CancellationKind": 0, "RetryStopState": 0 }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Conflict
object
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.
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.
object
object
object
object
Example
{ "Data": { "VersionResolutionMode": 0, "Status": 0, "ActionTargetScope": 0, "CancellationKind": 0, "RetryStopState": 0 }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}