1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Designer
  4. Reporting APIs
  5. Generate study design reports

V3.0

post

/ec-designer-svc/rest/v3.0/report/{reportName}

Generates a designer report for the requested report type using the provided search criteria.

Request

Path Parameters
Query Parameters
  • Study ID (UUID, 32-character uppercase hexadecimal string). Optional.
    Example:
    2F9A6C7E1B8F4D56A23C9F3A0C7D4E11
Supported Media Types
Request Body - application/json ()
Root Schema : SearchSpecs
Type: object
Title: SearchSpecs
Request body passing search specs like limit, offset and list of fields
Show Source
  • fieldSpecsList
    Field Specification List. Each element describes a single filter applied to the report.
  • Minimum Value: 1
    Maximum Value: 5000
    Maximum number of records to display per page. Provide a value between 1 and 5000 inclusive. Negative numbers are not accepted.
    Example: 50
  • 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. Provide a zero or positive value.
    Example: 5
Nested Schema : fieldSpecsList
Type: array
Field Specification List. Each element describes a single filter applied to the report.
Show Source
  • Field
    Generic representation of a report filter. Each entry specifies the field to evaluate, its data type, and the values to use when filtering.
Example:
[
    {
        "fieldName":"ruleState",
        "fieldType":"list",
        "fieldSequence":1,
        "fieldValueList":[
            "approved"
        ]
    }
]
Nested Schema : Field
Type: object
Generic representation of a report filter. Each entry specifies the field to evaluate, its data type, and the values to use when filtering.
Show Source
  • Minimum Length: 1
    Maximum Length: 255
    Field name to evaluate. Examples include STUDYID, SITEID, ruleState, and dateRange.
    Example: ruleState
  • Minimum Value: 0
    Maximum Value: 2147483647
    Sequence/order of the field. Provide a non-negative integer.
    Example: 1
  • Minimum Length: 4
    Maximum Length: 16
    Allowed Values: [ "list", "date", "date-time", "number", "string", "boolean" ]
    Field value classification. Use list for enumerations, date for calendar values, date-time for timestamps, number for numeric filters, string for textual filters, or boolean for true/false.
    Example: list
  • fieldValueList
    List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.
Example:
{
    "fieldName":"ruleState",
    "fieldType":"list",
    "fieldSequence":1,
    "fieldValueList":[
        "approved"
    ]
}
Nested Schema : fieldValueList
Type: array
List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Examples

Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : PaginatedResponseDto
Type: object
Title: PaginatedResponseDto
Paginated Response Object for report APIs.
Show Source
  • columns
  • Minimum Value: 0
    Maximum Value: 5000
    Total count of result Provide a non-negative integer.
    Example: 5
  • data
    Tabular data where each item is a row represented as an array of string values that align with the columns order.
  • Minimum Length: 4
    Maximum Length: 5
    Allowed Values: [ "true", "false" ]
    Attribute describes if result set has more records Returns "true" when additional records exist, otherwise "false".
    Example: true
  • Minimum Value: 1
    Maximum Value: 5000
    Maximum number of records to display per page. Provide a value between 1 and 5000 inclusive.
    Example: 5
  • 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. Provide a zero or positive value.
    Example: 400
  • Minimum Value: 0
    Maximum Value: 2147483647
    Total number of entities in response Provide a non-negative integer.
    Example: 5
Nested Schema : columns
Type: array
Show Source
Example:
[
    "name",
    "status"
]
Nested Schema : data
Type: array
Tabular data where each item is a row represented as an array of string values that align with the columns order.
Show Source
  • items
    Row values aligned with the `columns` list; each row must include between 1 and 50 string columns.
Example:
[
    [
        "38891F5E75BB4071BBF8ACE1F43BD1BD",
        "Visit Start Date Validation",
        "approved"
    ]
]
Nested Schema : items
Type: array
Row values aligned with the `columns` list; each row must include between 1 and 50 string columns.
Show Source
  • Row values aligned with the `columns` list; each row must include between 1 and 50 string columns.
    Example: ["38891F5E75BB4071BBF8ACE1F43BD1BD","Visit Start Date Validation","approved"]
Example:
[
    "38891F5E75BB4071BBF8ACE1F43BD1BD",
    "Visit Start Date Validation",
    "approved"
]
Examples

400 Response

'studyId is a mandatory filter criteria', 'studyVersion is a mandatory filter criteria', 'Filter Criteria can not be empty', 'Invalid Offset', 'Invalid Limit', 'Missing Request Body'
Body ()
Root Schema : DesignerResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Show Source
Nested Schema : result
Type: object
Nested Schema : details
Type: object

500 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.
Body ()
Root Schema : ErrorResponseData
Type: object
Show Source
Nested Schema : details
Type: object
Back to Top