Jump to

• Request
• Response

Get generated reports available for download

get

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

Retrieves a list of generated reports that are available for download for the specified query parameters. Right: ReportingGet.

Request

Query Parameters

• limit: integer(int32)
  Limit
• mode: string
  Mode of the study. Accepts test, active, or training.
• offset: integer(int32)
  Offset
• rptId: string(uuid)
  Report ID to list the generated reports. If made null, this API will return list of generated jobs for all reports
• studyId: string(uuid)
  ID of the study for which you want to list the downloaded reports. Tenant reports such as HSL report etc can be listed by making study id as null.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PaginatedReportRunStatus

Type: object

Show Source

• count: integer (int32)
• hasMore: string
• limit: integer (int32)
• offset: integer (int32)
• reportId: string (uuid)
• reportRunStatus: array reportRunStatus
• totalResults: integer (int32)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        },
        "reportId":{
            "type":"string",
            "format":"uuid"
        },
        "reportRunStatus":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReportRunStatus"
            }
        }
    }
}

Nested Schema : reportRunStatus

Type: array

Show Source

• Array of: object ReportRunStatus

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

Nested Schema : ReportRunStatus

Type: object

Show Source

• currSearchSpec: string
• currSortSpec: string
• downloadId: string (uuid)
• rptFormat: string
• rptId: string (uuid)
• rptKickoffDatetime: string (date-time)

{
    "type":"object",
    "properties":{
        "rptKickoffDatetime":{
            "type":"string",
            "format":"date-time"
        },
        "rptFormat":{
            "type":"string"
        },
        "currSearchSpec":{
            "type":"string"
        },
        "currSortSpec":{
            "type":"string"
        },
        "downloadId":{
            "type":"string",
            "format":"uuid"
        },
        "rptId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

400 Response

Validation error

Body ()

Root Schema : BaseResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

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

Nested Schema : details

Type: object

403 Response

User not authorized to download the report.

Body ()

Root Schema : BaseResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

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

Nested Schema : details

Type: object

Back to Top