ノートブックを一覧表示するList notebooks

ノートブック オブジェクトの一覧を取得します。Retrieve a list of notebook objects.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) Notes.Create、Notes.Read、Notes.ReadWrite、Notes.Read.All、Notes.ReadWrite.AllNotes.Create, Notes.Read, Notes.ReadWrite, Notes.Read.All, Notes.ReadWrite.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) Notes.Create、Notes.Read、Notes.ReadWriteNotes.Create, Notes.Read, Notes.ReadWrite
アプリケーションApplication Notes.Read.All、Notes.ReadWrite.AllNotes.Read.All, Notes.ReadWrite.All

HTTP 要求HTTP request

GET /me/onenote/notebooks
GET /users/{id | userPrincipalName}/onenote/notebooks
GET /groups/{id}/onenote/notebooks
GET /sites/{id}/onenote/notebooks

オプションのクエリ パラメーターOptional query parameters

このメソッドは、応答をカスタマイズするための OData クエリ パラメーターをサポートします。This method supports the OData Query Parameters to help customize the response.

既定の並べ替え順序は name asc です。The default sort order is name asc.

ノートブックの有効な expand 値は sections および sectionGroups です。Valid expand values for notebooks are sections and sectionGroups.

要求ヘッダーRequest headers

名前Name 種類Type 説明Description
AuthorizationAuthorization stringstring ベアラー {トークン}。必須。Bearer {token}. Required.
承諾Accept stringstring application/json

要求本文Request body

このメソッドには、要求本文を指定しません。Do not supply a request body for this method.

応答Response

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で notebook オブジェクトのコレクションを返します。If successful, this method returns a 200 OK response code and collection of notebook objects in the response body.

Example

要求Request

以下は、要求の例です。Here is an example of the request.

GET https://graph.microsoft.com/v1.0/me/onenote/notebooks
応答Response

以下は、応答の例です。注:ここに示す応答オブジェクトは切り詰めて簡略化されています。実際の呼び出しではすべてのプロパティが返されます。Here is an example of the response. Note: The response object shown here is truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 369

{
  "value": [
    {
      "isDefault": true,
      "userRole": {
      },
      "isShared": true,
      "sectionsUrl": "sectionsUrl-value",
      "sectionGroupsUrl": "sectionGroupsUrl-value",
      "links": {
        "oneNoteClientUrl": {
          "href": "href-value"
        },
        "oneNoteWebUrl": {
          "href": "href-value"
        }
      }
    }
  ]
}