Notification Service API Data Structures
Clause
This data structure has no properties.
CriteriaOperator
This data structure has no properties.
DataType
JSON Example
{
"typeId": "string"
}string
typeId
Optional
typeId
DynamicValueContext
JSON Example
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"providerEntityId": "string"
}string
providerEntityId
Optional
providerEntityId
ElementState
JSON Example
{
"dependencies": [
"string"
],
"facets": [
{}
]
}array of string
dependencies
Optional
dependencies
Evaluator
This data structure has no properties.
ExtensionRendererContext
JSON Example
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"extensionId": "string"
}string
extensionId
Optional
extensionId
Field
JSON Example
{
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"columns": [
"Field Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"orderIndex": "integer",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}string
displayAdvice
Optional
displayAdvice
boolean
isMultiValued
Optional
isMultiValued
string
description
Optional
description
integer As int32 As int32
orderIndex
Optional
orderIndex
string
id
Optional
id
string
label
Optional
label
InboundNotification
JSON Example
{
"userToken": "string",
"fromUser": "string",
"subject": "string",
"action": "string",
"notificationId": "string",
"id": "string",
"body": "string",
"userId": "string",
"messageReceivedAt": "string"
}string As uuid As uuid
userToken
Optional
userToken
string
fromUser
Optional
fromUser
string
subject
Optional
subject
string
action
Optional
action
string As uuid As uuid
notificationId
Optional
notificationId
string As uuid As uuid
id
Optional
id
string
body
Optional
body
string
userId
Optional
userId
string As date-time As date-time
messageReceivedAt
Optional
messageReceivedAt
InlineLayoutField1
This data structure has no properties.
boolean
isMultiValued
Optional
isMultiValued
string
description
Optional
description
string
label
Optional
label
integer As int32 As int32
labelSize
Optional
labelSize
string
displayAdvice
Optional
displayAdvice
integer As int32 As int32
orderIndex
Optional
orderIndex
string
id
Optional
id
LayoutCell
JSON Example
{
"size": "integer"
}integer As int32 As int32
size
Optional
size
LayoutField
AllOf
JSON Example
{
"size": "integer",
"extensionRendererContext": {
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"extensionId": "string"
},
"columns": [
"LayoutField Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"label": "string",
"labelSize": "integer",
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"orderIndex": "integer",
"id": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
LayoutFlow
JSON Example
{
"size": "integer",
"parts": [
{
"size": "integer"
}
],
"id": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}integer As int32 As int32
size
Optional
size
string
id
Optional
id
LayoutFlowElement
JSON Example
{
"size": "integer"
}integer As int32 As int32
size
Optional
size
LayoutPage
JSON Example
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}string
id
Optional
id
string
label
Optional
label
LayoutReference
This data structure has no properties.
LayoutRow
JSON Example
{
"items": [
{
"size": "integer"
}
]
}
LayoutSection
JSON Example
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}string
id
Optional
id
string
label
Optional
label
LiteralMapEntry
JSON Example
{
"key": "string"
}string
key
Optional
key
Notification
JSON Example
{
"attachment": [
{
"fileName": "string",
"contentId": "string",
"mimeType": "string",
"value": [
"string"
]
}
],
"recipients": [
{
"id": "string",
"type": "string"
}
],
"entityId": "string",
"id": "string",
"serviceId": "string",
"priority": "string",
"notificationScenarioId": "string"
}string
entityId
Optional
entityId
string As uuid As uuid
id
Optional
id
string
serviceId
Optional
serviceId
string
priority
Optional
priority
string
notificationScenarioId
Optional
notificationScenarioId
NotificationAction
JSON Example
{
"name": "string",
"id": "string"
}string
name
Optional
name
string
id
Optional
id
NotificationAttachment
JSON Example
{
"fileName": "string",
"contentId": "string",
"mimeType": "string",
"value": [
"string"
]
}string
fileName
Optional
fileName
string
contentId
Optional
contentId
string
mimeType
Optional
mimeType
array of string
value
Optional
value
NotificationContent
This data structure has no properties.
NotificationDeliveryMechanism
JSON Example
{
"enabled": "boolean",
"notificationProvider": {
"providerMode": {
"role": "string",
"overriddenGlobalProviderId": "string"
},
"name": "string",
"description": "string",
"providerDirection": "string",
"id": "string",
"type": "string",
"version": "integer"
}
}boolean
enabled
Required
enabled
NotificationPrincipal
JSON Example
{
"id": "string",
"type": "string"
}string
id
Optional
id
string
type
Optional
type
NotificationProvider
JSON Example
{
"providerMode": {
"role": "string",
"overriddenGlobalProviderId": "string"
},
"name": "string",
"description": "string",
"providerDirection": "string",
"id": "string",
"type": "string",
"version": "integer"
}string
name
Optional
name
string
description
Optional
description
string
providerDirection
Required
providerDirection
string As uuid As uuid
id
Optional
id
string
type
Required
type
integer As int64 As int64
version
Optional
version
Property Of
Parameter To
NotificationProviderCreationInfo
JSON Example
{
"createable": "boolean",
"providerType": "string",
"direction": "string"
}boolean
createable
Optional
createable
string
providerType
Optional
providerType
string
direction
Optional
direction
NotificationScenario
JSON Example
{
"name": "string",
"description": "string",
"serviceTypeId": "string",
"id": "string",
"serviceName": "string",
"actions": [
{
"name": "string",
"id": "string"
}
]
}string
name
Optional
name
string
description
Optional
description
string
serviceTypeId
Optional
serviceTypeId
string
id
Optional
id
string
serviceName
Optional
serviceName
NotificationScenarioConfiguration
JSON Example
{
"settings": [
{
"enabled": "boolean",
"notificationScenario": {
"name": "string",
"description": "string",
"serviceTypeId": "string",
"id": "string",
"serviceName": "string",
"actions": [
{
"name": "string",
"id": "string"
}
]
}
}
],
"tenantId": "string",
"version": "integer"
}string
tenantId
Optional
tenantId
integer As int64 As int64
version
Optional
version
NotificationScenarioSetting
JSON Example
{
"enabled": "boolean",
"notificationScenario": {
"name": "string",
"description": "string",
"serviceTypeId": "string",
"id": "string",
"serviceName": "string",
"actions": [
{
"name": "string",
"id": "string"
}
]
}
}boolean
enabled
Required
enabled
ParameterMapping
JSON Example
{
"key": "string"
}string
key
Optional
key
ParameterMappingCollection
JSON Example
{
"params": [
{
"key": "string"
}
]
}
PermissibleValueList
JSON Example
{
"customAllowed": "boolean"
}boolean
customAllowed
Optional
customAllowed
ProviderMode
JSON Example
{
"role": "string",
"overriddenGlobalProviderId": "string"
}string
role
Optional
role
string As uuid As uuid
overriddenGlobalProviderId
Optional
overriddenGlobalProviderId
RecipientDeliveryStatus
JSON Example
{
"recipientId": "string",
"id": "string",
"message": "string",
"status": "string"
}object
deliveryStatuses
Optional
deliveryStatuses
string
recipientId
Optional
recipientId
string As uuid As uuid
id
Optional
id
string
message
Optional
message
string
status
Optional
status
Schema
JSON Example
{
"fields": [
{
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"columns": [
"Field Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"orderIndex": "integer",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
]
}
Sort
This data structure has no properties.
UserNotificationPreference
JSON Example
{
"locale": "string",
"version": "integer",
"notificationDeliveryMechanisms": [
{
"enabled": "boolean",
"notificationProvider": {
"providerMode": {
"role": "string",
"overriddenGlobalProviderId": "string"
},
"name": "string",
"description": "string",
"providerDirection": "string",
"id": "string",
"type": "string",
"version": "integer"
}
}
]
}string
locale
Optional
locale
integer As int64 As int64
version
Optional
version
array of NotificationDeliveryMechanism
notificationDeliveryMechanisms
Required
notificationDeliveryMechanisms
booleanLiteral
Wraps a boolean value.
JSON Example
{
"value": "boolean"
}boolean
value
Optional
The boolean value.
layout
JSON Example
{
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
}
literal
Wraps a value such that values of different types can be treated generically.
This data structure has no properties.
literalMap
Equivalent of java.util.Map
JSON Example
{
"entries": [
{
"key": "string"
}
]
}
timeSpan
A literal defining period of time. This period is represented some integral number of a specified timeUnit.e.g. 6 days.
JSON Example
{
"unit": "string",
"amount": "integer"
}string
unit
Optional
The unit of measure for the time span. e.g: days.
integer As int64 As int64
amount
Optional
The amount for the time span.
value
JSON Example
{
"label": "string"
}string
label
Optional
label
Node: apidepo-liferay-dxp-v1-be-w-0:8080: