Generate study design reports
post
/ec-designer-svc/rest/v1.0/report/{reportName}
Retrieves study design related data in paginated format based on a given report name and the filters applied. Protected under the right StudyDesignReportPost.
Request
Path Parameters
-
reportName(required): string
The report section nameAllowed Values:
[ "DESIGNER_VISITS_SECTION", "STUDY_DESIGN_SUMMARY", "DESIGNER_KITS_SECTION", "DESIGNER_FORMS_SECTION", "DESIGNER_KIT_DISPENSATION_SECTION", "DESIGNER_RANDOMIZATION_SECTION", "DESIGNER_STRATIFICATION_SECTION", "DESIGNER_RANDOMIZATION_TREATMENT_ARMS", "CALCULATED_DOSES", "DESIGNER_COHORT_TREATMENT_ARMS", "DESIGNER_DEMOGRAPHY_COHORTS", "KIT_TYPE_TITRATIONS", "DESIGNER_TITRATION_KIT_SETTINGS", "DESIGNER_TITRATION_KIT_SETTINGS", "DESIGNER_RULES_SECTION" ]
Query Parameters
-
fileType: string
Indicates plain or rich text formattingDefault Value:
plain
-
isLocalized: boolean
Indicates whether to localize the report data
-
studyId: string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
Supported Media Types
- application/json
Root Schema : schema
Type:
object
Request body passing search specs like limit, offset and list of fields
Show Source
-
fieldSpecsList: array
fieldSpecsList
-
limit: integer
(int32)
Minimum Value:
1
Maximum Value:5000
Maximum number of records to display per page.Example:50
-
offset: integer
(int32)
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. Offset is affected by the value of the order parameterExample:5
Nested Schema : fieldSpecsList
Type:
Show Source
array
-
Array of:
object Field
Contains field details.
Nested Schema : Field
Type:
object
Contains field details.
Show Source
-
fieldName(required): string
Minimum Length:
0
Maximum Length:255
Field nameExample:siteIds
-
fieldSequence: integer
(int32)
Minimum Value:
0
Field sequenceExample:1
-
fieldType(required): string
Minimum Length:
0
Maximum Length:50
Field typeExample:list
-
fieldValueList(required): array
fieldValueList
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : PaginatedResponseDto
Type:
object
Paginated Response Object for report APIs.
Show Source
-
columns: array
columns
-
count: integer
(int32)
Total count of result
-
data: array
data
-
hasMore: string
Attribute describes if result set has more recordsExample:
true
-
limit: integer
(int32)
Maximum number of records to display per page.
-
offset: integer
(int32)
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. Offset is affected by the value of the order parameterExample:
400
-
totalResults: integer
(int32)
Total number of entities in response
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'
Nested Schema : result
Type:
object
Nested Schema : details
Type:
object
500 Response
Error
Nested Schema : details
Type:
object