Python SDK
import os
from parable_web_api_sdk import ClientConfig, WebApiSDK
sdk = WebApiSDK(
ClientConfig(
base_url=os.environ["PARABLE_API_URL"],
auth_token=os.environ["PARABLE_API_TOKEN"],
default_headers={"X-Tenant": os.environ["PARABLE_WORKSPACE"]},
)
)
result = sdk.parable_authoring.cancel_workspace_parable_report_run('example', 'example')sdk, err := webapisdk.New(webapisdk.SDKConfig{
BaseURL: os.Getenv("PARABLE_API_URL"),
Auth: &webapisdk.AuthConfig{Token: os.Getenv("PARABLE_API_TOKEN")},
RequestInterceptor: func(ctx context.Context, req *http.Request) error {
req.Header.Set("X-Tenant", os.Getenv("PARABLE_WORKSPACE"))
return nil
},
})
if err != nil {
return err
}
result, err := sdk.ParableAuthoringNamespace.CancelWorkspaceParableReportRun(ctx, "example", "example"){
"data": {
"forced": true,
"id": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"plotResults": [
{
"id": "<string>",
"plotEntityKey": "<string>",
"plotEntityVersion": 0,
"plotName": "<string>",
"rowCountHidden": true,
"spentCalls": 123,
"spentCost": 123,
"status": "pending",
"updatedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"errorMessage": "<string>",
"maxCost": {
"value": 4503599627370495
},
"maxExternalCalls": {
"value": 4503599627370495
},
"reusedFrom": {
"occurredAt": "2023-11-07T05:31:56Z",
"preview": true,
"reportRunId": "<string>"
},
"rowCount": 0,
"startedAt": "2023-11-07T05:31:56Z"
}
],
"preview": true,
"publishedCommitId": "<string>",
"reportKey": "<string>",
"sources": [
{
"delivery": "batch",
"id": "<string>",
"name": "<string>",
"connectionStatus": "disabled",
"connectionStatusMessage": "<string>",
"dataAsOf": "2023-11-07T05:31:56Z",
"hasData": true,
"logoUrl": "<string>",
"provider": "<string>",
"streamsOff": [
"<string>"
],
"tenantConnectorId": "<string>",
"vendorName": "<string>"
}
],
"status": "pending",
"trigger": "scheduled",
"triggerSources": [
{
"completedAt": "2023-11-07T05:31:56Z",
"kind": "provider_tap",
"name": "<string>",
"sourceId": "<string>"
}
],
"completedAt": "2023-11-07T05:31:56Z",
"durationMs": 0,
"failureMessage": "<string>",
"planKey": "<string>",
"proposalId": "<string>",
"requestedBy": {
"id": "<string>",
"kind": "organization",
"name": "<string>"
},
"typicalDurationMs": 0,
"unavailableReason": "<string>"
},
"meta": {
"requestId": "<string>",
"totalCount": 123
},
"links": {
"first": "<string>",
"last": "<string>",
"next": "<string>",
"prev": "<string>"
}
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}Cancel a Report run
Stops a Report run that has not finished. Paid model calls stay cached, and nothing from the run becomes readable. Cancelling a cancelled run returns it unchanged.
POST
/
api
/
parables
/
authoring
/
primaries
/
{rootRefId}
/
report-runs
/
{reportRunId}
/
actions
/
cancel
Python SDK
import os
from parable_web_api_sdk import ClientConfig, WebApiSDK
sdk = WebApiSDK(
ClientConfig(
base_url=os.environ["PARABLE_API_URL"],
auth_token=os.environ["PARABLE_API_TOKEN"],
default_headers={"X-Tenant": os.environ["PARABLE_WORKSPACE"]},
)
)
result = sdk.parable_authoring.cancel_workspace_parable_report_run('example', 'example')sdk, err := webapisdk.New(webapisdk.SDKConfig{
BaseURL: os.Getenv("PARABLE_API_URL"),
Auth: &webapisdk.AuthConfig{Token: os.Getenv("PARABLE_API_TOKEN")},
RequestInterceptor: func(ctx context.Context, req *http.Request) error {
req.Header.Set("X-Tenant", os.Getenv("PARABLE_WORKSPACE"))
return nil
},
})
if err != nil {
return err
}
result, err := sdk.ParableAuthoringNamespace.CancelWorkspaceParableReportRun(ctx, "example", "example"){
"data": {
"forced": true,
"id": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"plotResults": [
{
"id": "<string>",
"plotEntityKey": "<string>",
"plotEntityVersion": 0,
"plotName": "<string>",
"rowCountHidden": true,
"spentCalls": 123,
"spentCost": 123,
"status": "pending",
"updatedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"errorMessage": "<string>",
"maxCost": {
"value": 4503599627370495
},
"maxExternalCalls": {
"value": 4503599627370495
},
"reusedFrom": {
"occurredAt": "2023-11-07T05:31:56Z",
"preview": true,
"reportRunId": "<string>"
},
"rowCount": 0,
"startedAt": "2023-11-07T05:31:56Z"
}
],
"preview": true,
"publishedCommitId": "<string>",
"reportKey": "<string>",
"sources": [
{
"delivery": "batch",
"id": "<string>",
"name": "<string>",
"connectionStatus": "disabled",
"connectionStatusMessage": "<string>",
"dataAsOf": "2023-11-07T05:31:56Z",
"hasData": true,
"logoUrl": "<string>",
"provider": "<string>",
"streamsOff": [
"<string>"
],
"tenantConnectorId": "<string>",
"vendorName": "<string>"
}
],
"status": "pending",
"trigger": "scheduled",
"triggerSources": [
{
"completedAt": "2023-11-07T05:31:56Z",
"kind": "provider_tap",
"name": "<string>",
"sourceId": "<string>"
}
],
"completedAt": "2023-11-07T05:31:56Z",
"durationMs": 0,
"failureMessage": "<string>",
"planKey": "<string>",
"proposalId": "<string>",
"requestedBy": {
"id": "<string>",
"kind": "organization",
"name": "<string>"
},
"typicalDurationMs": 0,
"unavailableReason": "<string>"
},
"meta": {
"requestId": "<string>",
"totalCount": 123
},
"links": {
"first": "<string>",
"last": "<string>",
"next": "<string>",
"prev": "<string>"
}
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}Access
This operation needs a Parable token. An MCP token cannot call it. See Authentication for the kinds of token. Your roles must granttenant.parables.manage.
Errors
PA-AU-001: The Parable or the Report run was not found in this Workspace. Check the rootRefId and reportRunId.PA-AU-019: The caller cannot cancel a Report run of this Parable. Use a Workspace identity with Parable manage permission and the required RACI role.PA-AU-005: The Report run already finished, or it runs on the legacy Report worker, so it cannot be cancelled. Read the Report context; only a run that is still moving can be cancelled.
Authorizations
A personal access token, which starts with pat_. A Parable token can call each operation that the roles of its owner allow. An MCP token can call only the read operations that are open to agents. A SQL token does not work on this API.
Headers
Workspace slug. Overrides subdomain-based workspace resolution when provided.
Example:
"acme"
Optional request correlation ID echoed back in the response.
Example:
"550e8400-e29b-41d4-a716-446655440000"
Path Parameters
rootRefId parameter UUID v4 with automatic base62 encoding for client-facing APIs
reportRunId parameter UUID v4 with automatic base62 encoding for client-facing APIs