サブスクリプションの取得
SharePoint リストの 1 つ以上の webhook サブスクリプションを取得します。
アクセス許可
1 つのサブスクリプションの取得
アプリケーションには、少なくともサブスクリプションが取得される SharePoint リストへの編集許可が必要です。
アプリケーションが、Microsoft Azure Active Directory (Azure AD) アプリケーションである場合
Azure AD のアプリケーションに次の表で指定されるアクセス許可を与える必要があります。 サブスクリプションは、それを作成した Azure AD のアプリケーションでのみ取得できます。
| アプリケーション | アクセス許可 |
|---|---|
| Office 365 SharePoint Online | すべてのサイト コレクション内のアイテムおよびリストを読み取り、書き込みます。 |
アプリケーションが SharePoint アドインである場合
次のアクセス許可もしくはそれ以上の許可を SharePoint アドインに与える必要があります。 サブスクリプションは、それを作成した SharePoint アドインでのみ取得できます。
| スコープ | アクセス権限 |
|---|---|
| リスト | 管理 |
すべてのサブスクリプションの取得
アプリケーションには、少なくともサブスクリプションが取得される SharePoint リストへのリスト管理許可が必要です。
アプリケーションが Azure AD アプリケーションである場合
Azure AD アプリケーションに次の表で指定されるアクセス許可を与える必要があります。
| アプリケーション | アクセス許可 |
|---|---|
| Office 365 SharePoint Online | すべてのサイト コレクションのフル コントロール |
アプリケーションが SharePoint アドインである場合
次のアクセス許可もしくはそれ以上の許可を SharePoint アドインに与える必要があります。
| スコープ | アクセス権限 |
|---|---|
| リスト | フル コントロール |
HTTP 要求
1 つのサブスクリプションを取得します。
リスト Webhook
GET _api/web/lists('list-id')/subscriptions('id')
例
GET _api/web/lists('5C77031A-9621-4DFC-BB5D-57803A94E91D')/subscriptions('6D77031A-2345-5GRT-BV3D-55234B56FR43')
要求本文
このメソッドには、要求本文を指定しません。
応答
これにより、呼び出しアプリケーションで表示可能なサブスクリプションは戻されます。
HTTP/1.1 200 OK
Content-Type: application/json
{
"odata.metadata": "https://contoso.sharepoint.com/_api/$metadata#SP.ApiData.Subscriptions/@Element",
"odata.type": "Microsoft.SharePoint.Webhooks.Subscription",
"odata.id": "https://contoso.sharepoint.com/_api/web/lists('5C77031A-9621-4DFC-BB5D-57803A94E91D')/subscriptions('a8e6d5e6-9f7f-497a-b97f-8ffe8f559dc7')",
"odata.editLink": "web/lists('5C77031A-9621-4DFC-BB5D-57803A94E91D')/subscriptions('a8e6d5e6-9f7f-497a-b97f-8ffe8f559dc7')",
"expirationDateTime": "2016-04-30T16:17:57Z",
"id": "a8e6d5e6-9f7f-497a-b97f-8ffe8f559dc7",
"notificationUrl": "https://contoso.azurewebistes.net/api/webhook/handlerequest",
"resource": "5c77031a-9621-4dfc-bb5d-57803a94e91d"
}
すべてのサブスクリプションの取得
リスト Webhook
GET _api/web/lists('list-id')/subscriptions
例
GET _api/web/lists('5C77031A-9621-4DFC-BB5D-57803A94E91D')/subscriptions
要求本文
このメソッドには、要求本文を指定しません。
応答
これにより、SharePoint リソースのすべてのサブスクリプションのコレクションが返されます。
HTTP/1.1 200 OK
Content-Type: application/json
{
"odata.metadata": "https://a830edad9050849295j16032914.sharepoint.com/_api/$metadata#SP.ApiData.Subscriptions",
"value": [
{
"odata.type": "Microsoft.SharePoint.Webhooks.Subscription",
"odata.id": "https://contoso.sharepoint.com/_api/Microsoft.SharePoint.Webhooks.Subscriptionc3175b9c-1491-454f-b5da-980431e36146",
"odata.editLink": "Microsoft.SharePoint.Webhooks.Subscriptionc3175b9c-1491-454f-b5da-980431e36146",
"clientState": "{A0A354EC-97D4-4D83-9DDB-144077ADB449}",
"expirationDateTime": "2016-04-30T16:17:57Z",
"id": "a8e6d5e6-9f7f-497a-b97f-8ffe8f559dc7",
"notificationUrl": "https://contoso.azurewebsites.net/api/webhook/handlerequest",
"resource": "5c77031a-9621-4dfc-bb5d-57803a94e91d"
}
]
}