Jump to

• Request
• Response

Create a log entry and send it or schedule it

post

/ec-notifications-svc/rest/v3.0/studies/{studyId}/{mode}/notificationlog

Creates a log entry and immediately sends it or schedules it to be sent with the Scheduler service.

Request

Path Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• approvalFlag: string
  Minimum Length: 0

  Maximum Length: 1
• attachment: array attachment
• attachmentProviderVersion: string
• attachmentUrl: string
• attachmentUrlProvider: string
• category: string
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• createdBy: string
• createdDate: string (date-time)
• emailAddressList: string
  Minimum Length: 0

  Maximum Length: 4000
• emailOnlyFlag: string
  Minimum Length: 0

  Maximum Length: 1
• entityId: string (uuid)
• entityType: string
• id: string (uuid)
• immediateFlag: 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: string
• privilege: string
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• serviceName: string
• softwareVersionNumber: number
• targetList: array targetList
• userId: string (uuid)
• userList: string
  Minimum Length: 0

  Maximum Length: 4000
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "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"
        },
        "emailAddressList":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string"
        },
        "attachment":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"byte"
            }
        },
        "emailOnlyFlag":{
            "maxLength":"1",
            "minLength":"0",
            "type":"string"
        },
        "attachmentUrl":{
            "type":"string"
        },
        "attachmentUrlProvider":{
            "type":"string"
        },
        "attachmentProviderVersion":{
            "type":"string"
        },
        "targetList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NotificationLogTargetDto"
            }
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "notificationDatetime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : attachment

Type: array

Show Source

• Array of: string(byte)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"byte"
    }
}

Nested Schema : targetList

Type: array

Show Source

• Array of: object NotificationLogTargetDto

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NotificationLogTargetDto"
    }
}

Nested Schema : NotificationLogTargetDto

Type: object

Show Source

• targetId(required): string (uuid)
• targetType: string

{
    "required":[
        "targetId"
    ],
    "type":"object",
    "properties":{
        "targetType":{
            "type":"string"
        },
        "targetId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success.

Body ()

Root Schema : schema

Type: object

Show Source

• approvalFlag: string
  Minimum Length: 0

  Maximum Length: 1
• attachment: array attachment
• attachmentProviderVersion: string
• attachmentUrl: string
• attachmentUrlProvider: string
• category: string
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• createdBy: string
• createdDate: string (date-time)
• emailAddressList: string
  Minimum Length: 0

  Maximum Length: 4000
• emailOnlyFlag: string
  Minimum Length: 0

  Maximum Length: 1
• entityId: string (uuid)
• entityType: string
• id: string (uuid)
• immediateFlag: 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: string
• privilege: string
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• serviceName: string
• softwareVersionNumber: number
• userId: string (uuid)
• userList: string
  Minimum Length: 0

  Maximum Length: 4000
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "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"
        },
        "emailAddressList":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string"
        },
        "attachment":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"byte"
            }
        },
        "emailOnlyFlag":{
            "maxLength":"1",
            "minLength":"0",
            "type":"string"
        },
        "attachmentUrl":{
            "type":"string"
        },
        "attachmentUrlProvider":{
            "type":"string"
        },
        "attachmentProviderVersion":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "notificationDatetime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : attachment

Type: array

Show Source

• Array of: string(byte)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"byte"
    }
}

400 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