REST API for Clinical One Cloud Service

Get generated reports available for download

get

/ec-reporting-svc/rest/v2.0/reportmetadata/downloadList

Retrieves the paginated list of download runs for a given study/report in v2.0. Specify parameters to control paging.

Request

Query Parameters

limit(required): integer(int32)
Requested maximum page size.
Example:
```
50
```
mode: string
Mode of the study. Accepts test, active, or training.
Example:
```
test
```
offset(required): integer(int32)
Results paging start offset.
Example:
```
0
```
rptId: string(uuid)
Reporting template identifier (UUID).
Example:
```
BBAACF7D12C245A2A59B1C23DEADBEEF
```
studyId: string(uuid)
Study identifier (UUID, required)
Example:
```
AABB1234DD884FA1A9DC1AFDECBA1A35
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Query returned a paginated list of report runs.

Root Schema : PaginatedReportRunStatus

Type: object

Reports a paginated list of executed report runs for a given reporting template.

Show Source

count: integer (int32)

Number of report runs in this page.

Example: 50
hasMore: string

If true, more results are available beyond this page.

Example: true
limit: integer (int32)

Page size requested.

Example: 50
offset: integer (int32)

Page offset in result set.

Example: 0
reportId: string (uuid)

Reporting template UUID corresponding to these runs.
reportRunStatus: array reportRunStatus
totalResults: integer (int32)

Total number of report runs available.

Example: 200

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"string",
            "description":"If true, more results are available beyond this page.",
            "example":"true"
        },
        "totalResults":{
            "type":"integer",
            "description":"Total number of report runs available.",
            "format":"int32",
            "example":200
        },
        "count":{
            "type":"integer",
            "description":"Number of report runs in this page.",
            "format":"int32",
            "example":50
        },
        "limit":{
            "type":"integer",
            "description":"Page size requested.",
            "format":"int32",
            "example":50
        },
        "offset":{
            "type":"integer",
            "description":"Page offset in result set.",
            "format":"int32",
            "example":0
        },
        "reportId":{
            "type":"string",
            "description":"Reporting template UUID corresponding to these runs.",
            "format":"uuid"
        },
        "reportRunStatus":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReportRunStatus"
            }
        }
    },
    "description":"Reports a paginated list of executed report runs for a given reporting template."
}

Nested Schema : reportRunStatus

Type: array

Show Source

Array of: object ReportRunStatus

Execution status/details for a report run.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReportRunStatus"
    }
}

Nested Schema : ReportRunStatus

Type: object

Execution status/details for a report run.

Show Source

currSearchSpec: string

Current search/filter specification string.

Example: siteId:SITE001
currSortSpec: string

Current sort specification string.

Example: subjectId
downloadId: string (uuid)

Unique identifier for this download/run (UUID, upper-case hex).
rptFormat: string

File format for the report, e.g., PDF, XLSX.

Example: PDF
rptId: string (uuid)

Report ID for this run (UUID).
rptKickoffDatetime: string (date-time)

Timestamp when report generation started (UTC).

Example: 2025-10-27T10:00:00Z

{
    "type":"object",
    "properties":{
        "rptKickoffDatetime":{
            "type":"string",
            "description":"Timestamp when report generation started (UTC).",
            "format":"date-time",
            "example":"2025-10-27T10:00:00Z"
        },
        "rptFormat":{
            "type":"string",
            "description":"File format for the report, e.g., PDF, XLSX.",
            "example":"PDF"
        },
        "currSearchSpec":{
            "type":"string",
            "description":"Current search/filter specification string.",
            "example":"siteId:SITE001"
        },
        "currSortSpec":{
            "type":"string",
            "description":"Current sort specification string.",
            "example":"subjectId"
        },
        "downloadId":{
            "type":"string",
            "description":"Unique identifier for this download/run (UUID, upper-case hex).",
            "format":"uuid"
        },
        "rptId":{
            "type":"string",
            "description":"Report ID for this run (UUID).",
            "format":"uuid"
        }
    },
    "description":"Execution status/details for a report run."
}

Examples

400 Response

Invalid parameter/validation error.

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

Title: ErrorResponseData

Error Response Details Information
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

Title: ErrorResponseData

Error Response Details Information

Show Source

details: object Object

Title: Object

Object with error details information.
errorCode: string

Error code which is stored in ErrorCode enum. Example : C1-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

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 : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples

403 Response

User not authorized to view download list.

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

Title: ErrorResponseData

Error Response Details Information
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

Title: ErrorResponseData

Error Response Details Information

Show Source

details: object Object

Title: Object

Object with error details information.
errorCode: string

Error code which is stored in ErrorCode enum. Example : C1-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

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 : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples