serviceUpdateMessage resource type
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Represents the announcements about changes in a service.
Represents announcements such as major updates, new features in a product; for example, the publication of a new SharePoint feature.
Inherits from serviceAnnouncementBase.
Methods
| Method | Return type | Description |
|---|---|---|
| Get message | serviceUpdateMessage | Retrieve the properties and relationships of a serviceUpdateMessage object. |
| Mark read status | Boolean | Mark a list of serviceUpdateMessages as read for the signed in user. |
| Mark unread status | Boolean | Mark a list of serviceUpdateMessages as unread for the signed in user. |
| Archive status | Boolean | Archive a list of serviceUpdateMessages for the signed in user. |
| Unarchive status | Boolean | Unarchive a list of serviceUpdateMessages for the signed in user. |
| Mark favorite status | Boolean | Change the status of a list of serviceUpdateMessages to favorite for the signed in user. |
| Remove favorite status | Boolean | Remove the favorite status of serviceUpdateMessages for the signed in user. |
| List message attachments | serviceAnnouncementAttachment collection | Get a list of attachments associated with a service message. |
Properties
| Property | Type | Description |
|---|---|---|
| actionRequiredByDateTime | DateTimeOffset | The expected deadline of the action for the message. |
| attachmentsArchive | Stream | The zip file of all attachments for a message. |
| body | itemBody | The content type and content of the service message body. The supported value for the contentType property is html. |
| category | serviceUpdateCategory | The service message category. Possible values are: preventOrFixIssue, planForChange, stayInformed, unknownFutureValue. |
| details | Collection(keyValuePair) | Additional details about service message. This property doesn't support filters. Inherited from serviceAnnouncementBase. |
| endDateTime | DateTimeOffset | The end time of the service message. Inherited from serviceAnnouncementBase. |
| hasAttachments | Boolean | Indicates whether the message has any attachment. |
| id | String | The id of the service message. Inherited from serviceAnnouncementBase. |
| isMajorChange | Boolean | Indicates whether the message describes a major update for the service. |
| lastModifiedDateTime | DateTimeOffset | The last modified time of the service message. Inherited from serviceAnnouncementBase. |
| services | Collection(string) | The affected services by the service message. |
| severity | serviceUpdateSeverity | The severity of the service message. Possible values are: normal, high, critical, unknownFutureValue. |
| startDateTime | DateTimeOffset | The start time of the service message. Inherited from serviceAnnouncementBase. |
| tags | Collection(string) | A collection of tags for the service message. Tags are provided by the service team/support team who post the message to tell whether this message contains privacy data, or whether this message is for a service new feature update, and so on. |
| title | String | The title of the service message. Inherited from serviceAnnouncementBase. |
| viewPoint | serviceUpdateMessageViewpoint | Represents user viewpoints data of the service message. This data includes message status such as whether the user has archived, read, or marked the message as favorite. This property is null when accessed with application permissions. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| attachments | Collection(serviceAnnouncementAttachment) | A collection of serviceAnnouncementAttachments. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.serviceUpdateMessage",
"startDateTime": "String (timestamp)",
"endDateTime": "String (timestamp)",
"lastModifiedDateTime": "String (timestamp)",
"title": "String",
"details": [
{
"@odata.type": "microsoft.graph.keyValuePair"
}
],
"id": "String (identifier)",
"body": {
"@odata.type": "microsoft.graph.itemBody"
},
"category": "String",
"severity": "String",
"tags": [
"String"
],
"isMajorChange": "Boolean",
"actionRequiredByDateTime": "String (timestamp)",
"services": [
"String"
],
"viewPoint": {
"@odata.type": "microsoft.graph.serviceUpdateMessageViewpoint"
},
"hasAttachments": "Boolean",
"attachmentsArchive": "Stream"
}