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. Right: ReportingGet.

Request

Query Parameters

id: string

ID of the report job to download. This is mandatory
mode: string

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

Report Name
rptKickoffDatetime: string

Report Kickoff Date Time
studyId: string(uuid)

ID of the study for which you want to download report. Tenant reports such as HSL report etc can be downloaded by making study id as null.

There's no request body for this operation.

Response

Supported Media Types

text/html
application/json

200 Response

Success

Root Schema : HttpServletResponse

Type: object

Show Source

bufferSize: integer (int32)
characterEncoding: string
committed: boolean
contentLength: integer (int32)
contentLengthLong: integer (int64)
contentType: string
headerNames: array headerNames
locale: object locale
outputStream: object ServletOutputStream
status: integer (int32)
trailerFields: object trailerFields
writer: object writer

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "trailerFields":{
            "type":"object"
        },
        "headerNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "locale":{
            "type":"object",
            "properties":{
                "language":{
                    "type":"string"
                },
                "displayName":{
                    "type":"string"
                },
                "country":{
                    "type":"string"
                },
                "variant":{
                    "type":"string"
                },
                "script":{
                    "type":"string"
                },
                "unicodeLocaleAttributes":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "unicodeLocaleKeys":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "displayLanguage":{
                    "type":"string"
                },
                "displayScript":{
                    "type":"string"
                },
                "displayCountry":{
                    "type":"string"
                },
                "displayVariant":{
                    "type":"string"
                },
                "extensionKeys":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "iso3Language":{
                    "type":"string"
                },
                "iso3Country":{
                    "type":"string"
                }
            }
        },
        "writer":{
            "type":"object"
        },
        "contentLengthLong":{
            "type":"integer",
            "format":"int64",
            "writeOnly":true
        },
        "bufferSize":{
            "type":"integer",
            "format":"int32"
        },
        "committed":{
            "type":"boolean"
        },
        "characterEncoding":{
            "type":"string"
        },
        "contentType":{
            "type":"string"
        },
        "contentLength":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "outputStream":{
            "$ref":"#/components/schemas/ServletOutputStream"
        }
    }
}

Nested Schema : headerNames

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : locale

Type: object

Show Source

country: string
displayCountry: string
displayLanguage: string
displayName: string
displayScript: string
displayVariant: string
extensionKeys: array extensionKeys

Unique Items Required: true
iso3Country: string
iso3Language: string
language: string
script: string
unicodeLocaleAttributes: array unicodeLocaleAttributes

Unique Items Required: true
unicodeLocaleKeys: array unicodeLocaleKeys

Unique Items Required: true
variant: string

{
    "type":"object",
    "properties":{
        "language":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "variant":{
            "type":"string"
        },
        "script":{
            "type":"string"
        },
        "unicodeLocaleAttributes":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "unicodeLocaleKeys":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "displayLanguage":{
            "type":"string"
        },
        "displayScript":{
            "type":"string"
        },
        "displayCountry":{
            "type":"string"
        },
        "displayVariant":{
            "type":"string"
        },
        "extensionKeys":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "iso3Language":{
            "type":"string"
        },
        "iso3Country":{
            "type":"string"
        }
    }
}

Nested Schema : ServletOutputStream

Type: object

Show Source

ready: boolean
writeListener: object WriteListener

{
    "type":"object",
    "properties":{
        "ready":{
            "type":"boolean"
        },
        "writeListener":{
            "$ref":"#/components/schemas/WriteListener"
        }
    }
}

Nested Schema : trailerFields

Type: object

Nested Schema : writer

Type: object

Nested Schema : extensionKeys

Type: array

Unique Items Required: true

Show Source

Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : unicodeLocaleAttributes

Type: array

Unique Items Required: true

Show Source

Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : unicodeLocaleKeys

Type: array

Unique Items Required: true

Show Source

Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : WriteListener

Type: object

400 Response

'Invalid parameters', 'Insufficient parameters'

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

401 Response

User not authorized to download the report.

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

404 Response

Not found

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