The API reference isn't available right now
This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.
Back to the API reference
No such model
This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.
Back to the API reference
This reference may be out of date
This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:57 UTC.
API reference
/
Models
PagedResultDtoOfAnnouncementTemplateDtoA model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description items
required array of AnnouncementTemplateDto
array of AnnouncementTemplateDto nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields of each AnnouncementTemplateDto:
Field
Type
Description extraProperties
required object
nullable read only Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
id
required string (uuid)
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
creationTime
required string (date-time)
The date and time when this entity was created.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
creatorId
required string (uuid)
The ID of the user who created this entity.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
lastModificationTime
required string (date-time)
The date and time when this entity was last modified.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
lastModifierId
required string (uuid)
The ID of the user who last modified this entity.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isDeleted
required boolean
Indicates whether this entity has been deleted.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
deleterId
required string (uuid)
The ID of the user who deleted this entity, if it is deleted.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
deletionTime
required string (date-time)
The date and time when this entity was deleted, if it is deleted.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
tenantId
required string (uuid)
The tenant this template belongs to. Null for host-level templates.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
concurrencyStamp
required string
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
entityVersion
required integer (int32)
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
name
required string
Template name shown in the picker.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
title
required string
Default announcement title.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
body
required string
Default announcement body.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
priority
required AnnouncementPriority
AnnouncementPriority Default priority level.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
NormalNormal priority. Standard styling in the notification dropdown. ImportantImportant priority. Highlighted styling (e.g., orange badge). CriticalCritical priority. Emphasized styling (e.g., red badge). When combined with PopupOnLogin display option, shows as a blocking modal.
displayOptions
required AnnouncementDisplayOptions
AnnouncementDisplayOptions Default display options.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
DropdownOnlyAnnouncement appears only in the notification dropdown in the header toolbar. PopupOnLoginAnnouncement appears as a popup modal on user login/page load. The popup is shown once and tracked via UserAnnouncementState.PopupShownAt. BothAnnouncement appears in both the dropdown and as a popup on login.
externalLinkUrl
required string
Optional default external link URL.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
externalLinkText
required string
Optional default external link display text.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This body has no documented fields.
totalCount
required integer (int64)
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This model has no documented fields.
Next steps