Generate specific report for notifications settings

post

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

Generates report for notification settings in a study based on the specified report name.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Request body passing search specs like limit, offset and list of fields
Show Source
  • fieldSpecsList
  • Minimum Value: 1
    Maximum Value: 5000
    Maximum number of records to display per page.
    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. Offset is affected by the value of the order parameter
    Example: 5
Nested Schema : fieldSpecsList
Type: array
Show Source
Nested Schema : Field
Type: object
Contains field details.
Show Source
Nested Schema : fieldValueList
Type: array
Show Source
Back to Top

Response

Supported Media Types

200 Response

Success.
Body ()
Root Schema : PaginatedResponseDto
Type: object
Paginated Response Object for report APIs.
Show Source
Nested Schema : columns
Type: array
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : items
Type: array
Show Source

400 Response

Invalid request.
Body ()
Root Schema : SDFResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved
    Example: Cannot modify object after a study version has been approved
Nested Schema : result
Type: object
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Back to Top