1. REST API for Clinical One Platform
  2. Tasks
  3. Data Integration
  4. Subject Reports
  5. Generate a report based on the path parameter

v1.0

post

/ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/report/{reportName}

Generates the following reports: DC_SUBJECT_VISIT, DC_SUBJECT_DATA, DC_SUBJECT_EVENTS, DC_SUBJECT_SETTINGS, DC_STUDY_SETTINGS, DC_SDV_SETTINGS, DC_SDV_STRATEGIES, DC_VISIT_SETTINGS, DC_GENERAL_SETTINGS, DC_ENROLLMENT_SETTINGS, DC_SCREEN_RAND_LIMIT_COUNTRY, DC_VISIT_SETTINGS_REPORT, DC_CUSTOM_ENROLLMENT_SETTINGS, DC_SITE_SETTINGS, DC_COUNTRY_SETTINGS, DC_GENERAL_SETTINGS_AUDIT, DC_COUNTRY_SETTINGS_AUDIT, SUBJECT_DATA_CTMS, DC_SUBJECT_DATA_EXTRACT, DC_SIGNATURE_CONFIGS_REPORT and DC_SIGNATURE_CONFIGS.

Request

Path Parameters
  • Mode of the study, accepts: test, active, or training.
    Example:
    active
  • Name of the report to generate. Reports include: DC_SUBJECT_VISIT, DC_SUBJECT_DATA, DC_SUBJECT_EVENTS, DC_SUBJECT_SETTINGS, DC_STUDY_SETTINGS, DC_SDV_SETTINGS, DC_SDV_STRATEGIES, DC_VISIT_SETTINGS, DC_GENERAL_SETTINGS, DC_ENROLLMENT_SETTINGS, DC_SCREEN_RAND_LIMIT_COUNTRY, DC_VISIT_SETTINGS_REPORT, DC_CUSTOM_ENROLLMENT_SETTINGS, DC_SITE_SETTINGS, DC_COUNTRY_SETTINGS, DC_GENERAL_SETTINGS_AUDIT, DC_COUNTRY_SETTINGS_AUDIT, SUBJECT_DATA_CTMS, DC_SUBJECT_DATA_EXTRACT, DC_SIGNATURE_CONFIGS_REPORT and DC_SIGNATURE_CONFIGS.
    Example:
    DC_SUBJECT_DATA
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
    Example:
    A1B2C3D4E5F647839ABCDEF012345678
Query Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Search specification wrapper including pagination and a list of field filters for reporting queries.
Show Source
  • fieldSpecsList
    List of field specifications used to filter or select data
  • Minimum Value: 1
    Maximum Value: 10000
    Maximum number of records to display per page.
    Example: 10000
  • Minimum Value: 0
    Maximum Value: 2147483647
    An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.
    Example: 0
Nested Schema : fieldSpecsList
Type: array
List of field specifications used to filter or select data
Show Source
Example:
[
    {
        "fieldName":"VisitName",
        "fieldType":"STRING",
        "fieldSequence":1,
        "fieldValueList":[
            "SCREENED",
            "ENROLLED"
        ]
    }
]
Nested Schema : FieldSet
Type: object
Defines a search field and optional lists of values for reporting queries.
Show Source
Example:
[
    {
        "fieldName":"VisitName",
        "fieldType":"STRING",
        "fieldSequence":1,
        "fieldValueList":[
            "SCREENED",
            "ENROLLED"
        ]
    }
]
Nested Schema : fieldNameList
Type: array
List of field names when specifying multiple fields together
Show Source
  • List of field names when specifying multiple fields together
    Example: ["dataElementId","versionStart"]
Example:
[
    "dataElementId",
    "versionStart"
]
Nested Schema : fieldValueList
Type: array
List of values used for filtering the field
Show Source
Example:
[1.0.0.1]
Nested Schema : fieldValueSets
Type: array
List of value sets corresponding to fieldNameList order. Each inner list contains values or operators as applicable.
Show Source
  • items
    List of value sets corresponding to fieldNameList order. Each inner list contains values or operators as applicable.
Example:
[
    [
        "299BC76CF0F943E6BAC1D209BC3D1CDC",
        "2018-11-21 11:45:31.854"
    ]
]
Nested Schema : items
Type: array
List of value sets corresponding to fieldNameList order. Each inner list contains values or operators as applicable.
Show Source
  • items
    List of value sets corresponding to fieldNameList order. Each inner list contains values or operators as applicable.
Example:
[
    [
        "299BC76CF0F943E6BAC1D209BC3D1CDC",
        "2018-11-21 11:45:31.854"
    ]
]
Nested Schema : items
Type: object
List of value sets corresponding to fieldNameList order. Each inner list contains values or operators as applicable.
Example:
[
    [
        "299BC76CF0F943E6BAC1D209BC3D1CDC",
        "2018-11-21 11:45:31.854"
    ]
]
Examples

Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : PaginatedResponseDto
Type: object
Title: PaginatedResponseDto
Paginated Response Object for report APIs.
Show Source
Nested Schema : columns
Type: array
Names of report columns in the result set
Show Source
  • Names of report columns in the result set
    Example: ["Footer Message"]
Example:
[
    "Footer Message"
]
Nested Schema : data
Type: array
Tabular data where each item is a row (array of string values in report column order)
Show Source
Nested Schema : items
Type: array
Tabular data where each item is a row (array of string values in report column order)
Show Source
  • Tabular data where each item is a row (array of string values in report column order)
    Example: []
Examples

400 Response

Bad request.
Body ()
Root Schema : RestResponse
Type: object
Show Source
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
  • details
    Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
  • 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
Nested Schema : details
Type: object
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
Back to Top