DELETE

/Report

When to Use

Cancel long-running report requests when results are no longer needed
Clean up reports submitted with incorrect parameters
Remove completed reports after downloading and archiving
Manage concurrent report limits (delete queued reports to free slots)

Prerequisites

Reference GUID obtained from POST /Report

Considerations

Deletion cannot be undone (retrieve and backup results before deletion if needed)
Reports currently being processed may complete before deletion takes effect
GUID becomes invalid immediately

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": {}
}