Alerts - event inbox in Framework(EventInbox)
Latest version of the JSON entity definition is available on GitHub.
Traits
Traits for this entity are listed below.
is.identifiedBy
names a specifc identity attribute to use with an entity
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | EventInbox/(resolvedAttributes)/RecId | attribute |
is.CDM.entityVersion
Parameter | Value | Data type | Explanation |
---|---|---|---|
versionNumber | "1.1" | string | semantic version number of the entity |
is.application.releaseVersion
Parameter | Value | Data type | Explanation |
---|---|---|---|
releaseVersion | "10.0.13.0" | string | semantic version number of the application introducing this entity |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
Attributes
RecId
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
isPrimaryKey | true |
dataFormat | int64 |
isReadOnly | true |
Traits
List of traits for the RecId attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.identifiedBy
names a specifc identity attribute to use with an entity
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | EventInbox/(resolvedAttributes)/RecId | attribute |
is.readOnly
is.dataFormat.integer
is.dataFormat.big
AlertCreatedDateTime
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | date |
isNullable | true |
Traits
List of traits for the AlertCreatedDateTime attribute are listed below.
is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.
is.dataFormat.date
AlertedFor
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isReadOnly | true |
Traits
List of traits for the AlertedFor attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.dataFormat.character
is.dataFormat.array
AlertFieldId
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the AlertFieldId attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
AlertFieldLabel
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the AlertFieldLabel attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
AlertInstanceRelationType
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the AlertInstanceRelationType attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
is.dataFormat.big
AlertTableId
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the AlertTableId attribute are listed below.
is.dataFormat.integer
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
CompanyId
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isReadOnly | true |
Traits
List of traits for the CompanyId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.dataFormat.character
is.dataFormat.array
Deleted
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
displayName | Deleted alert |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the Deleted attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
DueDateTime
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | date |
isNullable | true |
Traits
List of traits for the DueDateTime attribute are listed below.
is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.
is.dataFormat.date
EmailId
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
displayName | |
dataFormat | int64 |
isNullable | true |
Traits
List of traits for the EmailId attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
is.dataFormat.big
EmailRecipient
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the EmailRecipient attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
EmailTemplateId
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the EmailTemplateId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
EnumType
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the EnumType attribute are listed below.
is.dataFormat.integer
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
EPDrillDown
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
displayName | Drill down |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the EPDrillDown attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
ExtendedDataType
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the ExtendedDataType attribute are listed below.
is.dataFormat.integer
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
GlobalRule
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the GlobalRule attribute are listed below.
is.dataFormat.integer
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
InboxId
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | int64 |
isReadOnly | true |
Traits
List of traits for the InboxId attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.readOnly
is.dataFormat.integer
is.dataFormat.big
IsAggregated
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the IsAggregated attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
IsRead
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
displayName | Read |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the IsRead attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
KeyFieldNameData
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | binary |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the KeyFieldNameData attribute are listed below.
is.dataFormat.byte
is.dataFormat.array
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.dataFormat.byte
is.dataFormat.array
KeyFieldNameList
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | binary |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the KeyFieldNameList attribute are listed below.
is.dataFormat.byte
is.dataFormat.array
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.dataFormat.byte
is.dataFormat.array
Message
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the Message attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
NotificationSource
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the NotificationSource attribute are listed below.
is.dataFormat.integer
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
NotificationType
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the NotificationType attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
ParentTableId
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the ParentTableId attribute are listed below.
is.dataFormat.integer
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
RuleId
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the RuleId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
SendEmail
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
displayName | Send email |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the SendEmail attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
ShowPopup
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
displayName | Show pop-ups |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the ShowPopup attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
Subject
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isReadOnly | true |
Traits
List of traits for the Subject attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.dataFormat.character
is.dataFormat.array
TypeId
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the TypeId attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
TypeTrigger
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the TypeTrigger attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
UserId
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isNullable | true |
Traits
List of traits for the UserId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
Visible
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
displayName | Visible |
dataFormat | int32 |
Traits
List of traits for the Visible attribute are listed below.
is.dataFormat.integer
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
Relationship_EventRuleRelationshipId
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_EventRuleRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Relationship_SysEmailTableRelationshipId
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_SysEmailTableRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Relationship_SysOutgoingEmailTableRelationshipId
First included in: Framework/EventInbox (this entity)
Properties
Name | Value |
---|---|
dataFormat | guid |
Traits
List of traits for the Relationship_SysOutgoingEmailTableRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array