DELETE

/Report

When to Use

Cancel long-running EntityBalanceReport requests with 10,000+ records when results are no longer needed before processing completes
Clean up TransactionSummary reports submitted with incorrect date ranges (wrong financial year) before retrieval to avoid confusion
Remove completed DistributionReconciliation reports from system after downloading and archiving to free storage resources
Cancel reports in "error" state after GET /Report/Status confirms processing failure to clear queue for corrected retry
Manage concurrent report limits - delete queued reports to free slots when approaching 10-report-per-user maximum

Common Scenarios

Parameter Error Recovery: Submit EntityBalanceReport with wrong ProductID, detect via GET /Report/Status error message, DELETE incorrect request, resubmit with correct ProductID
Post-Retrieval Cleanup: Complete 3-stage workflow (POST → Status → GET), download EntityBalanceReport results, immediately DELETE to free system resources and maintain clean report queue
Concurrent Limit Management: Reach 10-report maximum, review pending reports via tracking system, DELETE lowest-priority queued reports, submit new high-priority regulatory reports
Superseded Request Handling: Submit quarterly DistributionReconciliation, discover data error requiring correction, DELETE pending report, fix source data, resubmit corrected report request
Batch Processing Error Recovery: Automated system submits 20 TransactionSummary reports, 5 fail with parameter errors, DELETE all failed requests, log errors, retry with corrected parameters

Prerequisites

Valid Bearer token with report management permissions sufficient to delete reports within user's data access scope
Reference GUID of target report request - obtained from POST /Report response or stored tracking system
Understanding of permanent deletion consequences - report results, generation parameters, and GUID become permanently inaccessible
Confirmation that report results have been retrieved and archived if needed - use GET /Report before deletion for backup
Awareness of processing state timing - reports in "processing" state may complete before deletion takes effect

Important Considerations

⚠️ Report Deletion and Recovery

Permanent Data Loss: Deletion cannot be undone - retrieve and backup results via GET /Report before deletion if needed
Processing State Limitations: Reports currently being processed may complete before deletion takes effect
Reference GUID Invalidation: GUID becomes invalid immediately - subsequent status checks or retrieval attempts will fail

Description

Permanently deletes report requests and associated resources from the 7G system, providing lifecycle management for asynchronous report generation workflows. Removes report data at any processing stage (queued, processing, complete, error), freeing system resources and managing the 10-report-per-user concurrent limit. Deletion invalidates the reference GUID immediately - subsequent GET /Report/Status or GET /Report calls will fail. Primary use cases include parameter error recovery, post-retrieval cleanup, storage management, and concurrent request limit optimization.

State-Based Deletion Behavior

Report deletion impacts vary by current processing status:

Queued (pending): Cancels report generation before processing begins, removes from queue, frees concurrent slot immediately
Processing (incomplete): Attempts cancellation - may complete before deletion takes effect due to timing, results still purged after deletion
Complete: Removes generated JSON results, metadata, and temporary files - report no longer retrievable via GET /Report
Error: Cleans up failed request metadata and any partial results, allows queue retry with corrected parameters

Resource Cleanup Scope: Deletion removes report request metadata, generated JSON payload, processing parameters, status history, and invalidates reference GUID across all endpoints.

⚠️ Important: Permanent Operation

Report deletion cannot be undone. Ensure you have retrieved and archived results via GET /Report before deletion if data is needed for compliance, audit, or business purposes. GUID becomes invalid immediately upon successful deletion.

Required Headers - See Authentication

Header	Value	Description
Authorization	{accessToken}	Bearer token for API access
Version	2.0	API version identifier

Query Parameters

Parameter	Type	Required	Description
`reference` >	string	> Required...	The GUID reference of the report request to delete. This permanently removes the report and all associated data.

reference

string

> Required...

The GUID reference of the report request to delete. This permanently removes the report and all associated data.

Example Requests

bash

# Delete specific report request
curl -X DELETE "https://api.7g.com.au/Report?reference=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

# Alternative with explicit reference parameter
curl -X DELETE "https://api.7g.com.au/Report" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0" \
  -G -d "reference=a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response Examples

json

{
  "result": true,
  "message": "Report request has been deleted.",
  "data": {}
}