notebook resource type

Namespace: microsoft.graph

A OneNote notebook.

JSON representation

The following JSON representation shows the resource type.

JSON

{
  "createdBy": {"@odata.type": "microsoft.graph.identitySet"},
  "createdDateTime": "String (timestamp)",
  "id": "string (identifier)",
  "isDefault": true,
  "isShared": true,
  "lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
  "lastModifiedDateTime": "String (timestamp)",
  "links": {"@odata.type": "microsoft.graph.notebookLinks"},
  "displayName": "string",
  "sectionGroupsUrl": "string",
  "sectionsUrl": "string",
  "self": "string",
  "userRole": "String"
}

Properties

Property	Type	Description
createdBy	identitySet	Identity of the user, device, and application which created the item. Read-only.
createdDateTime	DateTimeOffset	The date and time when the notebook was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
displayName	String	The name of the notebook.
id	String	The unique identifier of the notebook. Read-only.
isDefault	Boolean	Indicates whether this is the user's default notebook. Read-only.
isShared	Boolean	Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.
lastModifiedBy	identitySet	Identity of the user, device, and application which created the item. Read-only.
lastModifiedDateTime	DateTimeOffset	The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
links	NotebookLinks	Links for opening the notebook. The oneNoteClientURL link opens the notebook in the OneNote native client if it's installed. The oneNoteWebURL link opens the notebook in OneNote on the web.
sectionGroupsUrl	String	The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.
sectionsUrl	String	The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.
self	String	The endpoint where you can get details about the notebook. Read-only.
userRole	onenoteUserRole	Possible values are: Owner, Contributor, Reader, None. Owner represents owner-level access to the notebook. Contributor represents read/write access to the notebook. Reader represents read-only access to the notebook. Read-only.

Relationships

Relationship	Type	Description
sectionGroups	SectionGroup collection	The section groups in the notebook. Read-only. Nullable.
sections	OnenoteSection collection	The sections in the notebook. Read-only. Nullable.

Methods

Method	Return Type	Description
Get notebook	Notebook	Read the properties and relationships of the notebook.
Get recent notebooks	recentNotebook collection	Get a collection of the most recently accessed notebooks for the user.
Get notebook from web	Notebook	Retrieve the properties and relationships of a notebook object using its URL path.
Create section group	SectionGroup	Create a section group by posting to the sectionGroups collection in the specified notebook.
List section groups	SectionGroup collection	Get a collection of section groups in the specified notebook.
Create section	OnenoteSection	Create a section by posting to the sections collection in the specified notebook.
List sections	OnenoteSection collection	Get a collection of sections in the specified notebook.
Copy notebook	None	Copies a notebook.