REST API for Clinical One Platform

Download report for a given report job ID

get

/ec-reporting-svc/rest/v2.0/reports/download

Downloads a specific report for a given job ID and streams the result as a file attachment if successful. The response body is the file content and headers (such as Content-Disposition) are set for file download. Example response is shown for a CSV file.

Request

Query Parameters

id: string
ID of the report job to download. This is mandatory
Example:
```
6A7C29DD011241DFBE1B64399283C860
```
mode: string
Mode of the study. Accepts test, active, or training.
Example:
```
test
```
reportName: string
Report Name
Example:
```
Subject Data Extract
```
rptKickoffDatetime: string
Report Kickoff Date Time
Example:
```
2025-06-04T11:27:52.014Z
```
studyId: string(uuid)
ID of the study for which you want to download report. Tenant reports, such as HSL report, can be downloaded by making study ID as null.
Example:
```
CFD8129A430A473C8A02F4BA5DAAD865
```

There's no request body for this operation.

Response

Supported Media Types

text/html
application/json

200 Response

Success. The response will include the file data as an attachment, typically with headers: `Content-Disposition: attachment; filename=report.csv` `Content-Type: text/csv` (or appropriate for format requested) The body contains the raw report file (for example, CSV data).

Root Schema : schema

Type: string(binary)

Report file content, streamed as a file. Example shown is CSV.

Examples

400 Response

'Invalid parameters', 'Insufficient parameters'

Root Schema : BaseResponse

Type: object

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

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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."
        },
        "errorData":{
            "$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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

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
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"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"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

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.

Root Schema : BaseResponse

Type: object

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

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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."
        },
        "errorData":{
            "$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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

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
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"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"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

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.

Root Schema : BaseResponse

Type: object

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

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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."
        },
        "errorData":{
            "$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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

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
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"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"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

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