Rediger

note 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 a simple note in the user's Notes folder. Notes support text content with optional inline image attachments, and are suitable for quick capture scenarios.

Inherits from outlookItem.

Methods

Method Return type Description
List note collection Get a list of the note objects in the user's Notes folder.
Create note Create a new note in the user's Notes folder.
Get note Read the properties and relationships of a note object.
Update note Update the properties of a note object.
Delete None Delete a note object.
Get delta note collection Get a set of note objects that were added, updated, or deleted in the user's Notes folder since the last delta query.
List attachments attachment collection Get the list of file attachments associated with a note.
Create attachment attachment Create a fileAttachment object, which adds an inline image attachment to a note.
Delete attachment None Delete an inline image attachment from a note.

Properties

Property Type Description
body itemBody The content of the note. Supports text or html content types.
bodyPreview String Auto-generated preview of the note body content (first ~255 characters, plain text). Read-only.
categories String collection The categories associated with the note. Inherited from outlookItem.
changeKey String Version identifier used for optimistic concurrency control via the If-Match header. Read-only. Inherited from outlookItem.
createdDateTime DateTimeOffset The date and time when the note was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2024, is 2024-01-01T00:00:00Z. Supports $filter (eq, ge, le, gt, lt). Read-only. Inherited from outlookItem.
hasAttachments Boolean Indicates whether the note has file attachments. Supports $filter (eq). Read-only.
id String The unique identifier for the note. Read-only. Inherited from outlookItem.
isDeleted Boolean Indicates whether the note is soft-deleted. Read-only.
lastModifiedDateTime DateTimeOffset The date and time when the note was last modified. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2024, is 2024-01-01T00:00:00Z. Supports $filter (eq, ge, le, gt, lt) and $orderby. Read-only. Inherited from outlookItem.
subject String The title of the note. Supports $filter (eq, ne, startsWith) and $orderby.

Relationships

Relationship Type Description
attachments attachment collection The file attachments for the note. Only inline image attachments (image/png, image/jpeg, image/gif, or image/bmp) are supported, with a maximum size of 3 MB per attachment. Use $expand to retrieve attachments.
extensions extension collection The collection of open extensions defined for the note.
multiValueExtendedProperties multiValueLegacyExtendedProperty collection The collection of multi-value extended properties defined for the note.
singleValueExtendedProperties singleValueLegacyExtendedProperty collection The collection of single-value extended properties defined for the note.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.note",
  "id": "String (identifier)",
  "createdDateTime": "String (timestamp)",
  "lastModifiedDateTime": "String (timestamp)",
  "changeKey": "String",
  "categories": [
    "String"
  ],
  "subject": "String",
  "body": {
    "@odata.type": "microsoft.graph.itemBody"
  },
  "bodyPreview": "String",
  "isDeleted": "Boolean",
  "hasAttachments": "Boolean"
}
  • Last updated on