1. REST API for Clinical One Platform
  2. Tasks
  3. Data Integration
  4. Subject Reports
  5. v1.0

Generate a report based on the path parameter

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.
Rights: DataCaptureSubjectGet or SubjectDataCTMSReportPost or SubjectDataClassificationGet.

Request

Path Parameters
  • Name of the report to generate. Reports include: DC_SUBJECT_EVENTS, DC_SUBJECT_DATA, DC_SUBJECT_DATA_OPTION3, DC_SUBJECT_SETTINGS, DC_VISIT_SETTINGS, DC_SIGNATURE_CONFIGS_REPORT and DC_SIGNATURE_CONFIGS.
Query Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : fieldSpecsList
Type: array
Show Source
Nested Schema : FieldSet
Type: object
Show Source
Nested Schema : fieldNameList
Type: array
Show Source
Nested Schema : fieldValueList
Type: array
Show Source
Nested Schema : fieldValueSets
Type: array
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : schema
Type: array
Show Source
Nested 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: ["UserName","UserId","SiteName","Role"]
Example:
[
    "UserName",
    "UserId",
    "SiteName",
    "Role"
]
Nested Schema : data
Type: array
Tabular data where each item is a row (array of string values in report column order).
Show Source
  • items
    Tabular data where each item is a row (array of string values in report column order).
Example:
[
    [
        "fiona.cobb@example.com",
        "8571341A98694B82B8EB3EB901C88ACD",
        "US-East",
        "Rule Designer"
    ],
    [
        "lucas.james@example.com",
        "225B79C982104415886DE02BC73C1E1E",
        "US-West",
        "Site User"
    ]
]
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: [["fiona.cobb@example.com","8571341A98694B82B8EB3EB901C88ACD","US-East","Rule Designer"],["lucas.james@example.com","225B79C982104415886DE02BC73C1E1E","US-West","Site User"]]
Example:
[
    [
        "fiona.cobb@example.com",
        "8571341A98694B82B8EB3EB901C88ACD",
        "US-East",
        "Rule Designer"
    ],
    [
        "lucas.james@example.com",
        "225B79C982104415886DE02BC73C1E1E",
        "US-West",
        "Site User"
    ]
]

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
  • 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
Back to Top