REST API for Clinical One Platform

Get metdata for all reports based on query paramaters

get

/ec-reporting-svc/rest/v1.0/reportmetadata

Retrieves report details, filter specifications and last 10 generated jobs for a all reports based on the given query parameters. Right: ReportingGet.

Request

Query Parameters

mode: string

Mode of the study. Accepts test, active, or training.
studyId: string(uuid)

ID of the study for which you want to get the metadata. Metadata for tenant reports such as HSL report etc can be viewed by making study id as null.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object ReportMetadataStatusContainer

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

Nested Schema : ReportMetadataStatusContainer

Type: object

Show Source

fieldSpecsList: array fieldSpecsList
reportId: string (uuid)
reportName: string
reportRunStatusList: array reportRunStatusList
reportType: string
rptSeq: integer (int32)
rptTypeSeq: integer (int32)

{
    "type":"object",
    "properties":{
        "reportId":{
            "type":"string",
            "format":"uuid"
        },
        "reportName":{
            "type":"string"
        },
        "reportType":{
            "type":"string"
        },
        "rptTypeSeq":{
            "type":"integer",
            "format":"int32"
        },
        "rptSeq":{
            "type":"integer",
            "format":"int32"
        },
        "fieldSpecsList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FieldSpec"
            }
        },
        "reportRunStatusList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReportRunStatus"
            }
        }
    }
}

Nested Schema : fieldSpecsList

Type: array

Show Source

Array of: object FieldSpec

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

Nested Schema : reportRunStatusList

Type: array

Show Source

Array of: object ReportRunStatus

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

Nested Schema : FieldSpec

Type: object

Show Source

defaultValue: string
fieldName: string
fieldPreftchUri: string
fieldUiCtrlType: string
fldId: string (uuid)
fldSeq: integer (int32)
fldUiLabel: string
hideInUI: string

Allowed Values: [ "VISIBLE", "HIDE", "DISABLE", "ADVANCED", "SHOWANDHIDE", "PARSE_PREFETCH_URI" ]
idFldName: string
mandatoryFldInd: boolean
parFldId: string (uuid)
reportSearchSpec: string
reportSortSpec: string
resultPath: string
valFldName: string

{
    "type":"object",
    "properties":{
        "fldId":{
            "type":"string",
            "format":"uuid"
        },
        "fieldName":{
            "type":"string"
        },
        "reportSearchSpec":{
            "type":"string"
        },
        "reportSortSpec":{
            "type":"string"
        },
        "fieldUiCtrlType":{
            "type":"string"
        },
        "fieldPreftchUri":{
            "type":"string"
        },
        "mandatoryFldInd":{
            "type":"boolean"
        },
        "fldSeq":{
            "type":"integer",
            "format":"int32"
        },
        "fldUiLabel":{
            "type":"string"
        },
        "idFldName":{
            "type":"string"
        },
        "valFldName":{
            "type":"string"
        },
        "parFldId":{
            "type":"string",
            "format":"uuid"
        },
        "resultPath":{
            "type":"string"
        },
        "defaultValue":{
            "type":"string"
        },
        "hideInUI":{
            "type":"string",
            "enum":[
                "VISIBLE",
                "HIDE",
                "DISABLE",
                "ADVANCED",
                "SHOWANDHIDE",
                "PARSE_PREFETCH_URI"
            ]
        }
    }
}

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

ID does not exist

Root Schema : BaseResponse

Type: object

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
result: object result
status: string

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

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."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

404 Response

User not authorized to download the report.

Root Schema : BaseResponse

Type: object

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
result: object result
status: string

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

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."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.