次の方法で共有

OneNote GET sectiongroups

  • [アーティクル]

ユーザーがアクセス許可を持つセクション グループの詳細を取得します。

適用対象: OneNote service

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

sectiongroups リソース パスを指定した GET 動詞は、Microsoft OneDrive に格納されているすべての OneNote ノートブックに含まれるセクション グループのうち、ユーザーがアクセス許可を持っているすべてのセクション グループを表します。これには、そのユーザーが所有するノートブック内および共有するノートブック内の両方にあるセクション グループが含まれます。また、特定のノートブック内またはセクション グループ内でユーザーがアクセス許可を持つすべてのセクション グループを取得することもできます。

リソース URL

HTTPS://www.onenote.com/api/v1.0/sectiongroups
HTTPS://www.onenote.com/api/v1.0/notebooks/{notebook ID}/sectiongroups
HTTPS://www.onenote.com/api/v1.0/sectiongroups/{section group ID}/sectiongroups

リソース情報

プロトコル

SSL/TLS HTTPS

応答形式

JSON

パラメーター

$orderby

コンマで区切った 1 つ以上の式。オプションで、値を並べ替える順序に応じて "asc" (既定値) または "desc" を含みます。この演算子の値は、API から返されるセクション グループを並べ替えるために使用するセクション グループ プロパティと、結果を並べ替える順序のリストです。有効なプロパティは、lastModifiedTime、createdTime、および name です。これらの値では大文字と小文字が区別されます。既定値は name asc です (名前の昇順)。modifiedTime プロパティは、セクション グループ内のページが最後に変更された日時を参照します。プロパティのリストを指定できます。例: $orderby=name asc, lastModifiedTime desc (名前の昇順、かつ lastModifiedTime の降順)。プロパティを指定する順序により、それぞれの並べ替えが行われるレベルが決まります。1 つのプロパティを 2 回以上指定した場合は、そのプロパティのうち最初に出現するものだけが使用されます。

$orderby=name asc

$filter

応答に特定のエントリを含める必要があるかどうかを示すブール式です。

$filter=contains(name, ‘text’)

$select

応答に含める各エントリのプロパティを、この値に指定したものだけに限定します。

$select=id,name

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

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

詳細説明

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

要求の例

[GET] https://www.onenote.com/api/v1.0/notebooks/{notebook ID}/sectiongroups

この要求は、特定のセクション グループ内でユーザーがアクセス許可を持つセクション グループを返します。既定の並び順は "name asc" (大文字小文字の区別なし) です。

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

この要求は、特定のセクション グループ内のセクション グループを返します。

[GET] https://www.onenote.com/api/v1.0/notebooks/{notebook ID}/sectiongroups?$select=id,name,createdTime&$orderby=createdTime

この要求は、特定のノートブック内のセクション グループについて id、title、createdTime プロパティのみを、createdTime を基準にして並べ替えて返します。

HTTP 応答ヘッダー

応答ヘッダー

値と説明

Content-Type

Application/json: charset=utf-8

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

X-CorrelationId

<GUID>

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

応答プロパティ

プロパティ

値と説明

値の型

sectionsUrl

/sections エンドポイント。セクション グループ内のすべてのセクションに関する詳細をここから取得できます。

文字列

sectionGroupsUrl

/sectiongroups エンドポイント。セクション グループ内のすべてのセクション グループの詳細をここから取得できます。

文字列

self

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

文字列

id

セクション グループの一意識別子。

文字列

name

セクション グループの名前。

文字列

createdBy

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

文字列

createdTime

セクション グループが作成された日時。

ISO 8601 形式の日付。

lastModifiedBy

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

文字列

lastModifiedTime

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

ISO 8601 形式の日付。

応答の例

Content-Type: application/json
X-CorrelationId: <GUID>
Status: 200 OK
{
  "@odata.context":"https://edog.onenote.com/api/Beta/$metadata#sectionGroups","value":[
    {
      "sectionsUrl":"https://www.onenote.com/api/v1.0/sectionGroups/section group ID/sections",
"sectionGroupsUrl":"https://www.onenote.com/api/v1.0/sectionGroups/section group ID/sectionGroups",
"id":"section group ID",
"name":"section group name",
"self":"https://www.onenote.com/api/v1.0/sectionGroups/section group ID",
"createdBy":"user name",
"lastModifiedBy":"user name",
"createdTime":"2013-10-05T16:48:53.553Z",
"lastModifiedTime":"2014-01-13T00:53:18.007Z"
    },
    {
      "sectionsUrl":"https://www.onenote.com/api/v1.0/sectionGroups/section group ID/sections",
"sectionGroupsUrl":"https://www.onenote.com/api/v1.0/sectionGroups/section group ID/sectionGroups",
"id":"section group ID",
"name":"section group name",
"self":"https://www.onenote.com/api/v1.0/sectionGroups/section group ID",
"createdBy":"user name",
"lastModifiedBy":"user name",
"createdTime":"2011-07-20T03:54:50.33Z",
"lastModifiedTime":"2014-06-04T22:23:07.303Z"
    }
  ]
}

その他の技術情報