1. REST API for Clinical One Platform
  2. Tasks
  3. Reporting
  4. v1.0

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 of the study. Accepts test, active, or training.
    Example:
    test
  • 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

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
    Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
  • result
    Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
  • Response status for the request; typically 'success' or 'error'.
    Example: success
Nested Schema : ErrorResponseData
Type: object
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
  • Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
    Example: User role is missing required permission REPORTING_VIEW. Field: userId
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
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.
Examples

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
    Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
  • result
    Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
  • Response status for the request; typically 'success' or 'error'.
    Example: success
Nested Schema : ErrorResponseData
Type: object
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
  • Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
    Example: User role is missing required permission REPORTING_VIEW. Field: userId
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
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.
Examples

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
    Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
  • result
    Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
  • Response status for the request; typically 'success' or 'error'.
    Example: success
Nested Schema : ErrorResponseData
Type: object
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
  • Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
    Example: User role is missing required permission REPORTING_VIEW. Field: userId
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
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.
Examples

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
    Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
  • result
    Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
  • Response status for the request; typically 'success' or 'error'.
    Example: success
Nested Schema : ErrorResponseData
Type: object
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
  • Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
    Example: User role is missing required permission REPORTING_VIEW. Field: userId
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
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.
Examples

Back to Top