プランの作成ContextLink

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

新しい planContextLink オブジェクトを作成します。

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) サポートされていません。 サポートされていません。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション サポートされていません。 サポートされていません。

HTTP 要求

POST /me/planner/plans_v2/{planId}/contexts
POST /users/{usersId}/planner/plans_v2/{planId}/contexts

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

リクエストの本文には、 planContextLink オブジェクトの JSON 表現を指定します。

planContextLink を作成するときに、次のプロパティを指定できます。

プロパティ 型 説明
key 文字列 プランが表示されるコンテキストの識別子。 省略可能。
displayNameSegments String collection 平面図が表示される場所をレンダリングするために使用される表示名セグメント。 省略可能。
webUrl String プランが表示されているサーフェスの URL。 省略可能。
associationType 文字列 プランをサーフェスに関連付ける方法について説明します。 省略可能。
displayAs plannerPlanContextType コンテキスト リンクの表示方法。 使用可能な値: teamsTab、sharePointPage、meetingNotes、other、unknownFutureValue、loopPage、project。 Prefer: include-unknown-enum-members 要求ヘッダーを使用して、この進化可能な列挙型から次の値を取得します: loopPage , project。 省略可能。
isActive ブール型 コンテキスト リンクが現在アクティブかどうかを示します。 省略可能。
customLinkText 文字列 リンクのレンダリングに使用されるカスタム テキスト (指定された場合)。 省略可能。
ownerAppId 文字列 プランのリンク元のサーフェスを所有するアプリのアプリケーション ID。 省略可能。
isCreation ブール型 このコンテキスト リンクがプランの元の作成サーフェイスを表すかどうかを示します。 省略可能。

応答

成功した場合、このメソッドは応答本文で 201 Created 応答コードと planContextLink オブジェクトを返します。

例

要求

次の例は要求を示しています。

POST https://graph.microsoft.com/beta/me/planner/plans_v2/{planId}/contexts
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.planContextLink",
  "key": "19:abcdef1234567890abcdef1234567890@thread.tacv2",
  "displayNameSegments": [
    "Contoso Project"
  ],
  "webUrl": "https://teams.microsoft.com/l/entity/com.microsoft.teamspace.tab.planner/tab-contoso-project",
  "associationType": "primary",
  "displayAs": "teamsTab",
  "isActive": true,
  "customLinkText": "Project plan",
  "ownerAppId": "4d1c9a3e-7b52-4f8a-9d31-6c2e8f4b9a17",
  "isCreation": true
}

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.planContextLink",
  "id": "901187ee-a684-eeaa-61d0-b0fb4774cdab",
  "key": "String",
  "displayNameSegments": [
    "String"
  ],
  "webUrl": "String",
  "associationType": "String",
  "displayAs": "String",
  "isActive": "Boolean",
  "customLinkText": "String",
  "ownerAppId": "String",
  "isCreation": "Boolean",
  "createdDateTime": "String (timestamp)"
}
  • 最終更新: