Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Success.

Body ()

Root Schema : schema

Type: object

Show Source

• 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)

{
    "required":[
        "approvalFlag",
        "category",
        "createdBy",
        "entityType",
        "immediateFlag",
        "priority",
        "serviceName"
    ],
    "type":"object",
    "properties":{
        "serviceName":{
            "type":"string"
        },
        "messageSubject":{
            "maxLength":1024,
            "minLength":0,
            "type":"string"
        },
        "messageDescription":{
            "maxLength":32767,
            "minLength":0,
            "type":"string"
        },
        "priority":{
            "type":"string"
        },
        "entityType":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "privilege":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "entityId":{
            "type":"string",
            "format":"uuid"
        },
        "approvalFlag":{
            "maxLength":1,
            "minLength":0,
            "type":"string"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time"
        },
        "userList":{
            "maxLength":4000,
            "minLength":0,
            "type":"string"
        },
        "immediateFlag":{
            "maxLength":1,
            "minLength":0,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "notificationDatetime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

404 Response

Bad request.

Body ()

Root Schema : NotificationResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

500 Response

Internal server error.

Body ()

Root Schema : NotificationResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Back to Top