1. REST API for Clinical One Platform
  2. Tasks
  3. Reporting
  4. v1.0

Generate report based on search specifications and query parameters

post

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

Submits a request for generating a report and returns Job ID in response.
Right: ReportingPost.

Request

Query Parameters
  • Format of the report
    Example:
    CSV
  • Mode of the study. Accepts test, active, or training.
    Example:
    test
  • Report ID
    Example:
    546A79C296BE11EABB370242AC130002
  • ID of the study for which you want to generate report. Tenant reports, such as HSL report, can be generated by making study ID as null.
    Example:
    D5E16DD550CB4AD1B330E0D09B4B8F3F
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Job request payload for report generation, specifying lists of Field specifications.
Show Source
Example:
{
    "fieldSpecsList":[
        {
            "fldId":"546A77A696BE11EABB370242AC130002",
            "fieldType":"list",
            "fieldName":"fileName",
            "fieldValueList":[
                "Study Name_Form Name_Timestamp (CSV only)"
            ]
        },
        {
            "fieldType":"list",
            "fieldName":"siteId",
            "fldId":"546A79C296BE11EABB370242AC130002",
            "fieldValueList":[
                "549AD8CA793C46688ECF6332C8926319"
            ]
        }
    ],
    "extFieldSpecsList":[
        {
            "fldId":"546A77A696BE11EABB370242AC130002",
            "fieldName":"File Name",
            "fieldType":"list",
            "fieldValueList":[
                "Study Name_Form Name_Timestamp (CSV only)"
            ]
        },
        {
            "fldId":"546A79C296BE11EABB370242AC130002",
            "fieldName":"Site",
            "fieldType":"list",
            "fieldValueList":[
                "Site001 - Site002"
            ]
        }
    ]
}
Nested Schema : ReportField
Type: object
Field metadata object for reporting job request.
Show Source
Example:
{
    "fldId":"C62C9522D70F41FDBB57FC92B05D6D02",
    "fieldName":"siteIds",
    "fieldType":"list",
    "fieldSequence":1,
    "fieldValueList":[
        "D62C9522D70F41FDBB57FC92B05D6D02",
        "B62C9522D70F41FDBB57FC92B05D6D02"
    ]
}
Examples

Back to Top

Response

Supported Media Types

202 Response

Success.
Body ()
Root Schema : ExecutionLog
Type: object
Show Source
Examples

401 Response

Unauthorized user.
Body ()
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
    Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
  • result
    Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
  • Response status for the request; typically 'success' or 'error'.
    Example: success
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
  • 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
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
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

Back to Top