Jump to

• Request
• Response

V1.0

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

• mode(required): string
  Mode of the study, accepts: test, active, or training.

  Example:

  active

• reportName(required): string
  Name of the report to generate.

  Example:

  PROPERTIES_REPORT

• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  515D8531E6A94B1BB238E58A572D8C80

Supported Media Types

• application/json

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: array fieldSpecsList
  Field Specification List
• 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.

  Example: 5

{
    "title":"SearchSpecs",
    "type":"object",
    "properties":{
        "limit":{
            "maximum":5000,
            "minimum":1,
            "type":"integer",
            "description":"Maximum number of records to display per page.",
            "format":"int32",
            "example":50
        },
        "offset":{
            "maximum":2147483647,
            "minimum":0,
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "example":5
        },
        "fieldSpecsList":{
            "type":"array",
            "description":"Field Specification List",
            "items":{
                "$ref":"#/components/schemas/Field"
            }
        }
    },
    "description":"Request body passing search specs like limit, offset and list of fields"
}

Nested Schema : fieldSpecsList

Type: array

Field Specification List

Show Source

• Array of: object Field
  Contains field details.

{
    "type":"array",
    "description":"Field Specification List",
    "items":{
        "$ref":"#/components/schemas/Field"
    }
}

Nested Schema : Field

Type: object

Contains field details.

Show Source

• fieldName(required): string
  Minimum Length: 0

  Maximum Length: 255

  Field name. The acceptable values are : TENANTID, STUDYID, COUNTRY, SITEID, INVID, INVNAM, USUBJID, SCRNID, SUBJID, VISITNUM, VISIT, UNSCHED, SVSTDTC, DOMAIN, LAB ID, LAB NAME, REPEATNUMBER, SREPEATID, SREPEATNUMBER, ENTERED BY, ENTERED DATE, LAST CHANGED BY, LAST CHANGED DATE etc.

  Example: siteIds or dateRange
• fieldSequence: integer (int32)
  Sequence/order of the field.

  Example: 1
• fieldType(required): string
  Minimum Length: 0

  Maximum Length: 50

  Field type. The fields type can be : date-time, string, list, number etc.

  Example: list or date-time
• fieldValueList(required): array fieldValueList
  List of values for the Field

{
    "required":[
        "fieldName",
        "fieldType",
        "fieldValueList"
    ],
    "type":"object",
    "properties":{
        "fieldName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Field name. The acceptable values are : TENANTID, STUDYID, COUNTRY, SITEID, INVID, INVNAM, USUBJID, SCRNID, SUBJID, VISITNUM, VISIT, UNSCHED, SVSTDTC, DOMAIN, LAB ID, LAB NAME, REPEATNUMBER, SREPEATID, SREPEATNUMBER, ENTERED BY, ENTERED DATE, LAST CHANGED BY, LAST CHANGED DATE etc. ",
            "example":"siteIds or dateRange"
        },
        "fieldType":{
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Field type. The fields type can be : date-time, string, list, number etc.",
            "example":"list or date-time"
        },
        "fieldSequence":{
            "type":"integer",
            "description":"Sequence/order of the field.",
            "format":"int32",
            "example":1
        },
        "fieldValueList":{
            "type":"array",
            "description":"List of values for the Field",
            "example":[
                "D5E16DD550CB4AD1B330E0D09B4B8F3F",
                "A5E16DD550CB4AD1B330E0D09B4B8F3F"
            ],
            "items":{
                "type":"string",
                "description":"List of values for the Field",
                "example":"[\"D5E16DD550CB4AD1B330E0D09B4B8F3F\",\"A5E16DD550CB4AD1B330E0D09B4B8F3F\"]"
            }
        }
    },
    "description":"Contains field details."
}

Nested Schema : fieldValueList

Type: array

List of values for the Field

Show Source

• Array of: string
  List of values for the Field

  Example: ["D5E16DD550CB4AD1B330E0D09B4B8F3F","A5E16DD550CB4AD1B330E0D09B4B8F3F"]

{
    "type":"array",
    "description":"List of values for the Field",
    "example":[
        "D5E16DD550CB4AD1B330E0D09B4B8F3F",
        "A5E16DD550CB4AD1B330E0D09B4B8F3F"
    ],
    "items":{
        "type":"string",
        "description":"List of values for the Field",
        "example":"[\"D5E16DD550CB4AD1B330E0D09B4B8F3F\",\"A5E16DD550CB4AD1B330E0D09B4B8F3F\"]"
    }
}

Example:

[
    "D5E16DD550CB4AD1B330E0D09B4B8F3F",
    "A5E16DD550CB4AD1B330E0D09B4B8F3F"
]

Examples

Select an example SearchSpecs

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request processed successfully, check the result

Body ()

Root Schema : PaginatedResponseDto

Type: object

Title: PaginatedResponseDto

Paginated Response Object for report APIs.

Show Source

• columns: array columns
  Names of report columns in the result set
• count: integer (int32)
  Total count of result

  Example: 5
• data: array data
  Tabular data where each item is a row (array of string values in report column order)
• hasMore: string
  Attribute describes if result set has more records

  Example: true
• limit: integer (int32)
  Maximum number of records to display per page.

  Example: 5
• 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.

  Example: 400
• totalResults: integer (int32)
  Total number of entities in response

  Example: 5

{
    "title":"PaginatedResponseDto",
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"string",
            "description":"Attribute describes if result set has more records",
            "example":"true"
        },
        "totalResults":{
            "type":"integer",
            "description":"Total number of entities in response",
            "format":"int32",
            "example":5
        },
        "count":{
            "type":"integer",
            "description":"Total count of result",
            "format":"int32",
            "example":5
        },
        "limit":{
            "type":"integer",
            "description":"Maximum number of records to display per page.",
            "format":"int32",
            "example":5
        },
        "offset":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "example":400
        },
        "columns":{
            "type":"array",
            "description":"Names of report columns in the result set",
            "example":[
                "Footer Message"
            ],
            "items":{
                "type":"string",
                "description":"Names of report columns in the result set",
                "example":"[\"Footer Message\"]"
            }
        },
        "data":{
            "type":"array",
            "description":"Tabular data where each item is a row (array of string values in report column order)",
            "example":[
            ],
            "items":{
                "type":"array",
                "description":"Tabular data where each item is a row (array of string values in report column order)",
                "example":[
                ],
                "items":{
                    "type":"string",
                    "description":"Tabular data where each item is a row (array of string values in report column order)",
                    "example":"[]"
                }
            }
        }
    },
    "description":"Paginated Response Object for report APIs."
}

Nested Schema : columns

Type: array

Names of report columns in the result set

Show Source

• Array of: string
  Names of report columns in the result set

  Example: ["Footer Message"]

{
    "type":"array",
    "description":"Names of report columns in the result set",
    "example":[
        "Footer Message"
    ],
    "items":{
        "type":"string",
        "description":"Names of report columns in the result set",
        "example":"[\"Footer Message\"]"
    }
}

Example:

[
    "Footer Message"
]

Nested Schema : data

Type: array

Tabular data where each item is a row (array of string values in report column order)

Show Source

• Array of: array items
  Tabular data where each item is a row (array of string values in report column order)

{
    "type":"array",
    "description":"Tabular data where each item is a row (array of string values in report column order)",
    "example":[
    ],
    "items":{
        "type":"array",
        "description":"Tabular data where each item is a row (array of string values in report column order)",
        "example":[
        ],
        "items":{
            "type":"string",
            "description":"Tabular data where each item is a row (array of string values in report column order)",
            "example":"[]"
        }
    }
}

Nested Schema : items

Type: array

Tabular data where each item is a row (array of string values in report column order)

Show Source

• Array of: string
  Tabular data where each item is a row (array of string values in report column order)

  Example: []

{
    "type":"array",
    "description":"Tabular data where each item is a row (array of string values in report column order)",
    "example":[
    ],
    "items":{
        "type":"string",
        "description":"Tabular data where each item is a row (array of string values in report column order)",
        "example":"[]"
    }
}

Examples

Select an example PaginatedResponseDto

400 Response

Error in request, check the request

Body ()

Root Schema : NotificationResponse

Type: object

Standard wrapper for API responses. Contains the request processing status, the result payload for successful requests, and error details when a request fails.

Show Source

• errorData: object Error Response
  Read Only: true

  Standard error body containing code, message and optional details.
• result: object result
  Read Only: true

  Result payload for the request. The concrete type depends on the endpoint and is described in the corresponding API documentation.
• status: string
  Read Only: true

  Allowed Values: [ "success, Failed" ]

  Status of the request processing. SUCCESS indicates the request was processed without errors. Any other value indicates failure.

  Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the request processing. SUCCESS indicates the request was processed without errors. Any other value indicates failure.",
            "readOnly":true,
            "example":"success",
            "enum":[
                "success, Failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result payload for the request. The concrete type depends on the endpoint and is described in the corresponding API documentation.",
            "readOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/Error Response"
        }
    },
    "description":"Standard wrapper for API responses. Contains the request processing status, the result payload for successful requests, and error details when a request fails."
}

Nested Schema : Error Response

Type: object

Read Only: true

Standard error body containing code, message and optional details.

Show Source

• details: object details
  Read Only: true

  Optional additional details about the error for diagnostics.
• errorCode: string
  Read Only: true

  Application-specific error code representing the failure reason.

  Example: VALIDATION_ERROR
• errorMessage: string
  Read Only: true

  Human-readable message describing the error.

  Example: Request payload validation failed

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application-specific error code representing the failure reason.",
            "readOnly":true,
            "example":"VALIDATION_ERROR"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable message describing the error.",
            "readOnly":true,
            "example":"Request payload validation failed"
        },
        "details":{
            "type":"object",
            "description":"Optional additional details about the error for diagnostics.",
            "nullable":true,
            "readOnly":true
        }
    },
    "description":"Standard error body containing code, message and optional details.",
    "nullable":true,
    "readOnly":true
}

Nested Schema : result

Type: object

Read Only: true

Result payload for the request. The concrete type depends on the endpoint and is described in the corresponding API documentation.

Nested Schema : details

Type: object

Read Only: true

Optional additional details about the error for diagnostics.

Examples

Select an example NotificationResponse

Back to Top