Jump to

• Request
• Response

Create a log entry and send it or schedule it

post

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

Creates a log entry and immediately sends it or schedules it to be sent with the Scheduler service. This version supports anchor index which enables having multiple values for an anchor key.

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
• messageLanguageSupported: object MessageLanguageSupportedDto2
• 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"
            }
        },
        "messageLanguageSupported":{
            "$ref":"#/components/schemas/MessageLanguageSupportedDto2"
        },
        "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 : MessageLanguageSupportedDto2

Type: object

Show Source

• body(required): object BodyDto2
• subject(required): object SubjectDto

{
    "required":[
        "body",
        "subject"
    ],
    "type":"object",
    "properties":{
        "subject":{
            "$ref":"#/components/schemas/SubjectDto"
        },
        "body":{
            "$ref":"#/components/schemas/BodyDto2"
        }
    }
}

Nested Schema : targetList

Type: array

Show Source

• Array of: object NotificationLogTargetDto

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

Nested Schema : BodyDto2

Type: object

Show Source

• anchors(required): array anchors
• htmlContent: string

{
    "required":[
        "anchors"
    ],
    "type":"object",
    "properties":{
        "htmlContent":{
            "type":"string"
        },
        "anchors":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NotificationAnchorDto2"
            }
        }
    }
}

Nested Schema : SubjectDto

Type: object

Show Source

• anchorKey: string
• values: array values

{
    "type":"object",
    "properties":{
        "anchorKey":{
            "type":"string"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ValueDto"
            }
        }
    }
}

Nested Schema : anchors

Type: array

Show Source

• Array of: object NotificationAnchorDto2

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

Nested Schema : NotificationAnchorDto2

Type: object

Show Source

• anchorIndex(required): integer
• anchorKey: string
• values: array values

{
    "required":[
        "anchorIndex"
    ],
    "type":"object",
    "properties":{
        "anchorKey":{
            "type":"string"
        },
        "anchorIndex":{
            "type":"integer"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ValueDto"
            }
        }
    }
}

Nested Schema : values

Type: array

Show Source

• Array of: object ValueDto

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

Nested Schema : ValueDto

Type: object

Show Source

• key: string
• keyType: string
• name: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "keyType":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : values

Type: array

Show Source

• Array of: object ValueDto

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

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
• messageLanguageSupported: object MessageLanguageSupportedDto2
• 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"
            }
        },
        "messageLanguageSupported":{
            "$ref":"#/components/schemas/MessageLanguageSupportedDto2"
        },
        "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 : MessageLanguageSupportedDto2

Type: object

Show Source

• body(required): object BodyDto2
• subject(required): object SubjectDto

{
    "required":[
        "body",
        "subject"
    ],
    "type":"object",
    "properties":{
        "subject":{
            "$ref":"#/components/schemas/SubjectDto"
        },
        "body":{
            "$ref":"#/components/schemas/BodyDto2"
        }
    }
}

Nested Schema : targetList

Type: array

Show Source

• Array of: object NotificationLogTargetDto

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

Nested Schema : BodyDto2

Type: object

Show Source

• anchors(required): array anchors
• htmlContent: string

{
    "required":[
        "anchors"
    ],
    "type":"object",
    "properties":{
        "htmlContent":{
            "type":"string"
        },
        "anchors":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NotificationAnchorDto2"
            }
        }
    }
}

Nested Schema : SubjectDto

Type: object

Show Source

• anchorKey: string
• values: array values

{
    "type":"object",
    "properties":{
        "anchorKey":{
            "type":"string"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ValueDto"
            }
        }
    }
}

Nested Schema : anchors

Type: array

Show Source

• Array of: object NotificationAnchorDto2

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

Nested Schema : NotificationAnchorDto2

Type: object

Show Source

• anchorIndex(required): integer
• anchorKey: string
• values: array values

{
    "required":[
        "anchorIndex"
    ],
    "type":"object",
    "properties":{
        "anchorKey":{
            "type":"string"
        },
        "anchorIndex":{
            "type":"integer"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ValueDto"
            }
        }
    }
}

Nested Schema : values

Type: array

Show Source

• Array of: object ValueDto

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

Nested Schema : ValueDto

Type: object

Show Source

• key: string
• keyType: string
• name: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "keyType":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : values

Type: array

Show Source

• Array of: object ValueDto

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

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"
        }
    }
}

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