---
updatedAt: 2026-07-17T12:06:01.000Z
---

# Cancel report execution

Request cancellation of a report result that is currently PENDING or PROCESSING. The operation is idempotent — repeating it for an already-cancelled result returns 204. Results in COMPLETED or FAILED status cannot be cancelled and will return 409.


# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Vertex Solution Reporting API",
    "version": "v1.0.0",
    "description": "Public REST API for Vertex Solution Reporting"
  },
  "x-readme": {
    "explorer-enabled": false
  },
  "servers": [
    {
      "url": "https://platform-reporting.vertexcloud.com",
      "description": "Production"
    },
    {
      "url": "https://stage-platform-reporting.vertexcloud.com",
      "description": "Staging"
    }
  ],
  "security": [
    {
      "Bearer": []
    }
  ],
  "tags": [
    {
      "name": "report-results",
      "description": "Operations related to generated report results"
    }
  ],
  "paths": {
    "/api/v1/reports/results/{reportResultId}/cancel": {
      "post": {
        "tags": [
          "report-results"
        ],
        "summary": "Cancel report execution",
        "operationId": "cancelReportResult",
        "description": "Request cancellation of a report result that is currently PENDING or PROCESSING. The operation is idempotent — repeating it for an already-cancelled result returns 204. Results in COMPLETED or FAILED status cannot be cancelled and will return 409.\n",
        "security": [
          {
            "Bearer": []
          }
        ],
        "parameters": [
          {
            "name": "reportResultId",
            "in": "path",
            "description": "UUID of the report result to cancel",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Report result cancelled successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReportResultSummary"
                }
              }
            }
          },
          "400": {
            "description": "Invalid ID supplied",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Report result not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "Bearer": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "schemas": {
      "ReportStatus": {
        "type": "string",
        "description": "Current processing state of the report result",
        "enum": [
          "PENDING",
          "PROCESSING",
          "STORING",
          "COMPLETED",
          "FAILED",
          "CANCELED"
        ],
        "example": "COMPLETED"
      },
      "ReportResultErrorCode": {
        "type": "string",
        "description": "Classification code indicating why the report generation failed",
        "enum": [
          "WORKFLOW_START_FAILED",
          "WORKFLOW_GENERAL_FAILURE",
          "STORAGE_WORKFLOW_FAILED",
          "STORAGE_WORKFLOW_ERROR",
          "REPORT_RESULT_INVALID_STATE",
          "REPORT_RESULT_NOT_FOUND",
          "STANDARD_REPORT_GENERATION_FAILED",
          "STANDARD_REPORT_FILTER_LOAD_FAILED",
          "STANDARD_REPORT_TEMPLATE_LOAD_FAILED",
          "DATA_EXTRACT_REPORT_GENERATION_FAILED",
          "DATA_EXTRACT_REPORT_DEFINITION_LOAD_FAILED"
        ]
      },
      "ReportResultError": {
        "type": "object",
        "description": "Error details for a failed report result",
        "required": [
          "code"
        ],
        "properties": {
          "code": {
            "$ref": "#/components/schemas/ReportResultErrorCode"
          },
          "message": {
            "type": "string",
            "nullable": true,
            "description": "Detailed error message describing what went wrong during report generation"
          }
        }
      },
      "ReportFormat": {
        "type": "string",
        "description": "File format of the generated report",
        "enum": [
          "CSV",
          "HTML",
          "PDF",
          "RTF",
          "XML",
          "XLS",
          "XLSX",
          "TXT"
        ],
        "example": "CSV"
      },
      "ReportCompression": {
        "type": "string",
        "nullable": true,
        "description": "Compression applied to the generated file content.\nnull  – no compression\nZIP   – ZIP archive\nGZIP  – GZIP stream\n",
        "enum": [
          "ZIP",
          "GZIP"
        ],
        "example": "GZIP"
      },
      "ReportCategory": {
        "type": "object",
        "description": "Report category",
        "required": [
          "id",
          "name"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
          },
          "name": {
            "type": "string"
          }
        }
      },
      "ReportResultSummaryOutput": {
        "type": "object",
        "required": [
          "fileName",
          "fileSize",
          "format"
        ],
        "properties": {
          "fileName": {
            "type": "string",
            "readOnly": true,
            "description": "Name of the generated output file"
          },
          "fileSize": {
            "type": "integer",
            "format": "int64",
            "readOnly": true,
            "description": "Size of the generated output file in bytes"
          },
          "format": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ReportFormat"
              }
            ],
            "readOnly": true,
            "description": "Output format of the generated file"
          },
          "compression": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ReportCompression"
              }
            ],
            "readOnly": true,
            "description": "Compression applied to the generated file, if any"
          }
        }
      },
      "BaseReportResult": {
        "type": "object",
        "required": [
          "reportResultId",
          "reportResultName",
          "templateId",
          "templateName",
          "templateDisplayName",
          "createDateTime",
          "status"
        ],
        "properties": {
          "reportResultId": {
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "description": "Unique identifier of this report result"
          },
          "reportResultName": {
            "type": "string",
            "readOnly": true,
            "description": "Human-readable name of this report result"
          },
          "reportId": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "readOnly": true,
            "description": "Identifier of the underlying report definition, if available"
          },
          "reportName": {
            "type": "string",
            "nullable": true,
            "readOnly": true,
            "description": "Name of the underlying report definition, if available"
          },
          "templateId": {
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "description": "UUID of the template used for this execution"
          },
          "templateName": {
            "type": "string",
            "readOnly": true,
            "description": "Name of the report template."
          },
          "templateDisplayName": {
            "type": "string",
            "readOnly": true,
            "description": "Display name of the report template."
          },
          "category": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ReportCategory"
              }
            ],
            "type": "object",
            "nullable": true,
            "readOnly": true,
            "description": "Category of the template used for this execution"
          },
          "createDateTime": {
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "description": "Date and time when the report run started"
          },
          "finishDateTime": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "description": "Date and time when the report run finished, if completed"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ReportStatus"
              }
            ],
            "readOnly": true,
            "description": "Current status of this report result"
          },
          "error": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ReportResultError"
              }
            ],
            "type": "object",
            "nullable": true,
            "readOnly": true,
            "description": "Error details, present only when status is FAILED"
          },
          "processedRecordCount": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "readOnly": true,
            "description": "Number of records processed in this report execution"
          }
        }
      },
      "ReportResultSummary": {
        "allOf": [
          {
            "$ref": "#/components/schemas/BaseReportResult"
          },
          {
            "type": "object",
            "properties": {
              "output": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ReportResultSummaryOutput"
                  }
                ],
                "type": "object",
                "nullable": true,
                "description": "Metadata for the generated artifact, without a download URL"
              }
            }
          }
        ]
      },
      "ApiError": {
        "type": "object",
        "required": [
          "error",
          "message",
          "timestamp"
        ],
        "properties": {
          "error": {
            "type": "string",
            "description": "Error code (uppercase). Enumerated value that represents the type of error.\n",
            "enum": [
              "AUTHENTICATION_SERVER_ERROR",
              "MISSING_CLIENT_CONFIGURATION",
              "INCOMPLETE_CLIENT_CONFIGURATION",
              "MISSING_AUTH_HEADER",
              "ACCESS_FLAG_NOT_ENABLED",
              "INVALID_PARAMETER",
              "METHOD_NOT_ALLOWED",
              "MALFORMED_JSON",
              "MISSING_PARAMETER",
              "MISSING_HEADER",
              "VALIDATION_ERROR",
              "BINDING_ERROR",
              "CONSTRAINT_VIOLATION",
              "INTERNAL_SERVER_ERROR",
              "REQUESTED_URL_NOT_FOUND",
              "UNSUPPORTED_MEDIA_TYPE",
              "REPORT_FILE_NOT_FOUND",
              "NO_EXTERNAL_REPORT_FILE_ID",
              "FILE_STORE_NOT_COMPLETED",
              "REPORT_RESULT_NOT_FOUND",
              "REPORT_NOT_FOUND",
              "LOCAL_FILE_NOT_FOUND",
              "FIS_CLIENT_ERROR",
              "FIS_FILE_NOT_FOUND",
              "TEMPLATE_NOT_FOUND",
              "REPORT_RUN_ERROR",
              "TOO_MANY_REQUESTS",
              "SCHEDULE_NOT_FOUND",
              "DUPLICATE_SCHEDULE",
              "SELECTOR_NOT_FOUND",
              "REPORT_PREVIEW_NOT_SUPPORTED",
              "REPORT_PREVIEW_NOT_ELIGIBLE",
              "SELECTOR_FETCH_TIMEOUT",
              "SELECTOR_FETCH_ERROR",
              "SELECTOR_MISSING_PARAMETER",
              "SELECTOR_UNKNOWN_PROPERTY",
              "REPORT_RESULT_NOT_DELETABLE",
              "REPORT_DEFINITION_ARCHIVED"
            ]
          },
          "message": {
            "type": "string",
            "description": "Human-readable error message."
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "description": "Exact time when the error was generated."
          },
          "path": {
            "type": "string",
            "description": "Request endpoint path that produced the error."
          },
          "details": {
            "type": "object",
            "additionalProperties": true,
            "description": "Optional structured metadata about the error."
          }
        }
      }
    }
  }
}
```