Jump to

• Request
• Response

Delete report based on query parameters

delete

/ec-reporting-svc/rest/v1.0/reports

Removes an existing report based on the given input, using the Query parameter.
Right: ReportingDelete.

Request

Query Parameters

• mode: string
  Mode of the study. Accepts test, active, or training.

  Example:

  test

• studyId: string(uuid)
  ID of the study for which you want to delete the generated report. Tenant reports, such as HSL report, can be deleted by making study ID as null.

  Example:

  D5E16DD550CB4AD1B330E0D09B4B8F3F

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

204 Response

Success.

Body ()

Root Schema : BaseResponse

Type: object

Base response object for all reporting service endpoints, providing a standard structure for status, result, and errorData.

Show Source

• ErrorResponseData: object ErrorResponseData
• result: object result
  Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
• status: string
  Response status for the request; typically 'success' or 'error'.

  Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Response status for the request; typically 'success' or 'error'.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data."
        },
        "ErrorResponseData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Base response object for all reporting service endpoints, providing a standard structure for status, result, and errorData."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.

Nested Schema : details

Type: object

Examples

Select an example Report deleted successfully

400 Response

'Invalid parameters': 'Insufficient parameters'

Body ()

Root Schema : BaseResponse

Type: object

Base response object for all reporting service endpoints, providing a standard structure for status, result, and errorData.

Show Source

• ErrorResponseData: object ErrorResponseData
• result: object result
  Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
• status: string
  Response status for the request; typically 'success' or 'error'.

  Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Response status for the request; typically 'success' or 'error'.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data."
        },
        "ErrorResponseData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Base response object for all reporting service endpoints, providing a standard structure for status, result, and errorData."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.

Nested Schema : details

Type: object

Examples

Select an example Bad request for report deletion

401 Response

User not authorized: to download the report.

Body ()

Root Schema : BaseResponse

Type: object

Base response object for all reporting service endpoints, providing a standard structure for status, result, and errorData.

Show Source

• ErrorResponseData: object ErrorResponseData
• result: object result
  Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
• status: string
  Response status for the request; typically 'success' or 'error'.

  Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Response status for the request; typically 'success' or 'error'.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data."
        },
        "ErrorResponseData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Base response object for all reporting service endpoints, providing a standard structure for status, result, and errorData."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.

Nested Schema : details

Type: object

Examples

Select an example Unauthorized deletion attempt

404 Response

Not found:

Body ()

Root Schema : BaseResponse

Type: object

Base response object for all reporting service endpoints, providing a standard structure for status, result, and errorData.

Show Source

• ErrorResponseData: object ErrorResponseData
• result: object result
  Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
• status: string
  Response status for the request; typically 'success' or 'error'.

  Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Response status for the request; typically 'success' or 'error'.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data."
        },
        "ErrorResponseData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Base response object for all reporting service endpoints, providing a standard structure for status, result, and errorData."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.

Nested Schema : details

Type: object

Examples

Select an example Resource not found for deletion

Back to Top