Créer planContextLink

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Créez un objet planContextLink.

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation	Autorisation de moindre privilège	Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire)	Non prise en charge.	Non prise en charge.
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	Non prise en charge.	Non prise en charge.

Requête HTTP

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

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
Content-Type	application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON de l’objet planContextLink .

Vous pouvez spécifier les propriétés suivantes lors de la création d’un planContextLink.

Propriété	Type	Description
clé	String	Identificateur du contexte dans lequel le plan est affiché. Facultatif.
displayNameSegments	String collection	Nom d’affichage des segments utilisés pour afficher l’emplacement de surface du plan. Facultatif.
webUrl	String	URL de la surface sur laquelle le plan est affiché. Facultatif.
AssociationType	String	Décrit comment le plan est associé à la surface. Facultatif.
displayAs	plannerPlanContextType	Comment le lien de contexte doit être affiché. Les valeurs possibles sont teamsTab, sharePointPage, meetingNotes, other, unknownFutureValue, loopPage, project. Utilisez l’en-tête de Prefer: include-unknown-enum-members requête pour obtenir les valeurs suivantes à partir de cette énumération évolutive : loopPage , project. Facultatif.
isActive	Booléen	Indique si le lien de contexte est actuellement actif. Facultatif.
customLinkText	String	Texte personnalisé utilisé pour afficher le lien, le cas échéant. Facultatif.
ownerAppId	String	ID de l’application propriétaire de la surface à partir de laquelle le plan est lié. Facultatif.
isCreation	Booléen	Indique si ce lien de contexte représente la surface de création d’origine du plan. Facultatif.

Réponse

En cas de succès, cette méthode renvoie un code de 201 Created réponse et un objet planContextLink dans le corps de la réponse.

Exemples

Demande

L’exemple suivant illustre une demande.

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
}

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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)"
}