Get notification properties for a study
get
/ec-notifications-svc/rest/v1.0/studies/{studyId}/notificationProperties
Retrieves the notification properties for a study.
Request
Path Parameters
-
studyId(required): string
ID of the study.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success.
Root Schema : schema
Type:
Show Source
object
-
approvalFlag(required): string
Minimum Length:
0
Maximum Length:1
-
category(required): string
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
createdBy(required): string
-
createdDate: string
(date-time)
-
entityId: string
(uuid)
-
entityType(required): string
-
id: string
(uuid)
-
immediateFlag(required): string
Minimum Length:
0
Maximum Length:1
-
messageDescription: string
Minimum Length:
0
Maximum Length:32767
-
messageSubject: string
Minimum Length:
0
Maximum Length:1024
-
notificationDatetime: string
(date-time)
-
objectVersionNumber: number
-
operationType: string
-
priority(required): string
-
privilege: string
-
reason: string
Minimum Length:
0
Maximum Length:255
-
serviceName(required): string
-
softwareVersionNumber: number
-
userId: string
(uuid)
-
userList: string
Minimum Length:
0
Maximum Length:4000
-
versionEnd: string
(date-time)
-
versionStart: string
(date-time)
404 Response
Bad request.
Root Schema : NotificationResponse
Type:
Show Source
object
-
errorData: object
ErrorResponseData
Title:
ErrorResponseData
Error Response Details Information -
result: object
result
-
status: string
Nested Schema : ErrorResponseData
Type:
object
Title:
ErrorResponseData
Error Response Details Information
Show Source
-
details: object
Object
Title:
Object
Object with error details information. -
errorCode: string
Error code which is stored in ErrorCode enum. Example : C1-003Example:
C1-003
-
errorMessage: string
Error message which is stored in service property file. Example : Cannot modify object after a study version has been approvedExample:
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.
500 Response
Internal server error.
Root Schema : NotificationResponse
Type:
Show Source
object
-
errorData: object
ErrorResponseData
Title:
ErrorResponseData
Error Response Details Information -
result: object
result
-
status: string
Nested Schema : ErrorResponseData
Type:
object
Title:
ErrorResponseData
Error Response Details Information
Show Source
-
details: object
Object
Title:
Object
Object with error details information. -
errorCode: string
Error code which is stored in ErrorCode enum. Example : C1-003Example:
C1-003
-
errorMessage: string
Error message which is stored in service property file. Example : Cannot modify object after a study version has been approvedExample:
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.