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

Generate report based on the direct report payload

post

/ec-reporting-svc/rest/v1.0/studies/{studyId}/{mode}/reports/direct

Generates a direct report for a given study and mode, using the supplied report sections and data.

Request

Path Parameters
Query Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Payload object for direct report generation. Contains report sections details.
Show Source
Nested Schema : DirectReportSection
Type: object
Section in a direct report payload, includes report name, sequence, and results.
Show Source
Nested Schema : SectionData
Type: object
Show Source
Nested Schema : columns
Type: array
Column headers for the data grid.
Show Source
  • Column headers for the data grid.
    Example: ["Subject Id","Visit Date","Visit Type"]
Example:
[
    "Subject Id",
    "Visit Date",
    "Visit Type"
]
Nested Schema : data
Type: array
2D array representing the tabular data for the section, matching the columns and rows.
Show Source
  • items
    2D array representing the tabular data for the section, matching the columns and rows.
Example:
[
    [
        "1001",
        "2025-11-04",
        "BASELINE"
    ],
    [
        "1002",
        "2025-11-05",
        "SCREENING"
    ]
]
Nested Schema : headers
Type: object
Additional Properties Allowed
Show Source
Additional metadata headers for this report section, such as site info or investigator.
Example:
{
    "siteNumbr":"S01",
    "investigator":"Dr. Smith",
    "shipmentNumbr":"123ABCXYZ"
}
Nested Schema : items
Type: array
2D array representing the tabular data for the section, matching the columns and rows.
Show Source
  • 2D array representing the tabular data for the section, matching the columns and rows.
    Example: [["1001","2025-11-04","BASELINE"],["1002","2025-11-05","SCREENING"]]
Example:
[
    [
        "1001",
        "2025-11-04",
        "BASELINE"
    ],
    [
        "1002",
        "2025-11-05",
        "SCREENING"
    ]
]
Nested Schema : additionalProperties
Type: object
Additional metadata headers for this report section, such as site info or investigator.
Example:
{
    "siteNumbr":"S01",
    "investigator":"Dr. Smith",
    "shipmentNumbr":"123ABCXYZ"
}
Examples

Back to Top

Response

Supported Media Types

202 Response

Direct report accepted for generation, returns execution log object.
Body ()
Root Schema : ExecutionLog
Type: object
Show Source
Examples

400 Response

Bad request: (missing or invalid payload or parameters).
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

401 Response

Unauthorized: or user lacks rights to generate report.
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

500 Response

Internal server error:
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