1. REST API for Clinical One Cloud Service
  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
  • ReportField
    Field metadata supplied when generating a Rule Designer report. Every entry identifies a report filter or column definition and provides the values to apply.
  • ReportField
    Field metadata supplied when generating a Rule Designer report. Every entry identifies a report filter or column definition and provides the values to apply.
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 supplied when generating a Rule Designer report. Every entry identifies a report filter or column definition and provides the values to apply.
Show Source
  • Minimum Length: 32
    Maximum Length: 32
    Pattern: ^[0-9A-Fa-f]{32}$
    Unique 32 character identifier for the report field definition.
    Example: C62C9522D70F41FDBB57FC92B05D6D02
  • Minimum Length: 1
    Maximum Length: 255
    Report field name being filtered. Examples include ruleState, ruleEnabled, siteIds, and dateRange.
    Example: ruleState
  • Minimum Value: 0
    Maximum Value: 2147483647
    Zero-based order in which the field should be evaluated. Provide a non-negative integer.
    Example: 1
  • Minimum Length: 4
    Maximum Length: 16
    Allowed Values: [ "list", "date", "date-time", "number", "string", "boolean" ]
    Data classification for the supplied field values. Use list for discrete enumerations, date for calendar values, date-time for timestamp ranges, number for numeric filters, or string for textual filters.
    Example: list
  • fieldValueList
    List of values used when filtering the report for this field. Supply GUIDs for identifier fields and literal values for other types.
Example:
{
    "fldId":"C62C9522D70F41FDBB57FC92B05D6D02",
    "fieldName":"ruleState",
    "fieldType":"list",
    "fieldSequence":1,
    "fieldValueList":[
        "approved",
        "publish"
    ]
}
Nested Schema : fieldValueList
Type: array
List of values used when filtering the report for this field. Supply GUIDs for identifier fields and literal values for other types.
Show Source
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
Nested Schema : ErrorResponseData
Type: object
Show Source
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.
Nested Schema : details
Type: object
Examples

Back to Top