次の方法で共有

OneNote GET sections/id

  • [アーティクル]

指定したセクションの詳細情報を取得します。

適用対象: apps for SharePoint | OneNote service | SharePoint Server 2013

この記事の内容
リソース URL
HTTP 要求ヘッダー
OAuth のスコープ
詳細説明
要求の例
HTTP 応答ヘッダー
応答プロパティ
応答の例
その他の技術情報

sections/{section id} リソース パスを指定した GET 動詞は、Microsoft OneDrive に格納された OneNote ノートブック内の特定のセクションを表します。これは、ユーザーが所有しているノートブック内またはユーザーが共有しているノートブック内のいずれかに含まれるセクションです。

リソース URL

HTTPS://www.onenote.com/api/v1.0/sections/{section ID}

リソース情報

プロトコル

SSL/TLS HTTPS

応答形式

JSON

HTTP 要求ヘッダー

OneNote API に対するすべての要求には、Authorization ヘッダーを含める必要があります。

要求ヘッダー

値と説明

Authorization

Bearer tokenString
ユーザーの資格情報とユーザーに許可されているアクセスに基づいてアプリに提供される有効な OAuth トークン。詳細については、OneNote サービス API を使用してユーザーを認証するを参照してください。
セキュリティ メモセキュリティ メモ

Microsoft OneNote API は OAUTH 認証を必要とするため、基本認証の場合とは違って、ユーザー名とパスワードをクリア テキストで渡しても受け付けません。ユーザーのアカウント資格情報のセキュリティを保護するため、アプリで基本認証を使用しようとしたり、HTTPS 経由であってもアカウント資格情報を送信したりしないでください。

OAuth のスコープ

製品でユーザーを認証する際には、ユーザーが参照できるようにする内容に応じて、次のいずれかのスコープを要求してください。

スコープ

スコープ

目的

office.onenote

ユーザーのノートブックおよびページに対する読み取りアクセス許可を付与します。製品が、ユーザーの任意のノートブック内のセクションをクエリの対象にする必要がある場合に、このスコープを要求します。

office.onenote_update_by_app

製品によって作成されたページに対する作成、読み取り、更新、および削除のアクセス許可を付与します。製品が、その製品を使用してユーザーが作成したセクションのみをクエリの対象にすればよい場合は、このスコープを要求します。

office.onenote_update

ユーザーのノートブック、セクション、およびページに対するフル アクセス許可を付与します。製品が、ユーザーの任意のノートブック内のセクションをクエリおよび更新する必要がある場合に、このスコープを要求します。

office.onenote_create

ノートブック階層を列挙し、任意の場所にページを作成する許可を製品に与えます。製品が、ユーザーの任意のノートブック内にページを作成する必要がある場合に、このスコープを要求します。

詳細説明

/sections/id エンドポイントを指定して GET 動詞を使用すると、OneNote API はセクションを、OData バージョン 4.0 仕様に準拠した JSON オブジェクトとして返します。

要求の例

[GET] https://www.onenote.com/api/v1.0/sections/{section ID}

この要求は、指定されたセクションに対するアクセス許可をユーザーが持っている場合に、そのセクションを返します。セクションのリストを取得するには、sections リソース パスを使用します。ユーザーまたは使用しているアプリケーションがセクションにアクセスするための適切な許可を持っていない場合は、OneNote API から 40001-49999 の範囲のエラー コードが返されます。

HTTP 応答ヘッダー

応答ヘッダー

値と説明

Content-Type

Application/json: charset=utf-8

API は常に JSON 形式でデータを返します。

X-CorrelationId

<GUID>

相関 ID により要求を一意に識別できるため、問題をデバッグするときに相関 ID を使用できます。

応答プロパティ

プロパティ

値と説明

値の型

isDefault

これがユーザーの既定のセクションであるかどうかを示します。

ブール

pagesUrl

セクション内に新しいページを作成できる /pages エンドポイント。セクション内に新しいページを作成するには、POST 動詞と一緒にこのエンドポイントを使用してください。

文字列

self

セクションに関する詳細を取得できるエンドポイント。

文字列

id

セクションの一意識別子。

文字列

name

セクションの名前。

文字列

createdBy

セクションを作成したユーザー。

文字列

createdTime

セクションが作成された日時。

ISO 8601 形式の日付。

lastModifiedBy

セクションを最後に変更したユーザー。

文字列

lastModifiedTime

セクションが最後に変更された日時。

ISO 8601 形式の日付。

応答の例

Content-Type: application/json
X-CorrelationId: <GUID>
Status: 200 OK
{
  "@odata.context":"https://www.onenote.com/api/v1.0/$metadata#sections","value":[
    {
      "isDefault":false,
"pagesUrl":"https://www.onenote.com/api/v1.0/sections/section ID/pages",
"id":"section ID",
"name":"section name",
"self":"https://www.onenote.com/api/v1.0/sections/section ID",
"createdBy":"user name",
"lastModifiedBy":"user name",
"createdTime":"2013-10-05T10:58:19.98Z",
"lastModifiedTime":"2013-10-13T10:42:36.11Z"
    }
  ]
}

その他の技術情報