Créer personAnnotation

Article
10/30/2023

Espace de noms: microsoft.graph

Créez un objet personAnnotation dans le profil d’un utilisateur.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	✅	✅	✅

Autorisations

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

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	User.ReadWrite	User.ReadWrite.All
Déléguée (compte Microsoft personnel)	User.ReadWrite	Non disponible.
Application	Non prise en charge.	Non prise en charge.

Requête HTTP

POST /me/profile/notes
POST /users/{id | userPrincipalName}/profile/notes

En-têtes de demande

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

Corps de la demande

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

Le tableau suivant présente les propriétés qu’il est possible de définir dans un nouvel objet personAnnotation dans le profil d’un utilisateur.

Propriété	Type	Description
allowedAudiences	Chaîne	Audiences qui peuvent voir les valeurs contenues dans l’entité. Hérité de itemFacet. Les valeurs possibles sont les suivantes : `me`, `family`, `contacts`, `groupMembers`, `organization`, `federatedOrganizations`, `everyone` et `unknownFutureValue`.
Détail	itemBody	Contient les détails de la note elle-même.
displayName	Chaîne	Contient un nom convivial pour la note.
Inférence	inferenceData	Contient les détails de l’inférence si l’entité est déduite par l’application de création ou de modification. Hérité de itemFacet.
source	personDataSource	D’où proviennent les valeurs si elles sont synchronisées à partir d’un autre service. Hérité de itemFacet.

Réponse

Si elle réussit, cette méthode renvoie un 201 Created code de réponse et un objet personAnnotation dans le corps de la réponse.

Exemples

POST https://graph.microsoft.com/beta/me/profile/notes
Content-Type: application/json

{
  "detail": {
    "contentType": "text",
    "content": "I am originally from Australia, but grew up in Moscow, Russia."
  },
  "displayName": "About Me"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new PersonAnnotation
{
	Detail = new ItemBody
	{
		ContentType = BodyType.Text,
		Content = "I am originally from Australia, but grew up in Moscow, Russia.",
	},
	DisplayName = "About Me",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Profile.Notes.PostAsync(requestBody);

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta users profile notes create --user-id {user-id} --body '{\
  "detail": {\
    "contentType": "text",\
    "content": "I am originally from Australia, but grew up in Moscow, Russia."\
  },\
  "displayName": "About Me"\
}\
'

Importante



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewPersonAnnotation()
detail := graphmodels.NewItemBody()
contentType := graphmodels.TEXT_BODYTYPE 
detail.SetContentType(&contentType) 
content := "I am originally from Australia, but grew up in Moscow, Russia."
detail.SetContent(&content) 
requestBody.SetDetail(detail)
displayName := "About Me"
requestBody.SetDisplayName(&displayName) 

notes, err := graphClient.Me().Profile().Notes().Post(context.Background(), requestBody, nil)

Importante


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

PersonAnnotation personAnnotation = new PersonAnnotation();
ItemBody detail = new ItemBody();
detail.setContentType(BodyType.Text);
detail.setContent("I am originally from Australia, but grew up in Moscow, Russia.");
personAnnotation.setDetail(detail);
personAnnotation.setDisplayName("About Me");
PersonAnnotation result = graphClient.me().profile().notes().post(personAnnotation);

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

const personAnnotation = {
  detail: {
    contentType: 'text',
    content: 'I am originally from Australia, but grew up in Moscow, Russia.'
  },
  displayName: 'About Me'
};

await client.api('/me/profile/notes')
	.version('beta')
	.post(personAnnotation);

Importante


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\PersonAnnotation;
use Microsoft\Graph\Generated\Models\ItemBody;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new PersonAnnotation();
$detail = new ItemBody();
$detail->setContentType(new BodyType('text'));
$detail->setContent('I am originally from Australia, but grew up in Moscow, Russia.');
$requestBody->setDetail($detail);
$requestBody->setDisplayName('About Me');

$result = $graphServiceClient->me()->profile()->notes()->post($requestBody)->wait();

Importante


Import-Module Microsoft.Graph.Beta.People

$params = @{
	detail = @{
		contentType = "text"
		content = "I am originally from Australia, but grew up in Moscow, Russia."
	}
	displayName = "About Me"
}

# A UPN can also be used as -UserId.
New-MgBetaUserProfileNote -UserId $userId -BodyParameter $params

Importante


from msgraph import GraphServiceClient
from msgraph.generated.models.person_annotation import PersonAnnotation
from msgraph.generated.models.item_body import ItemBody

graph_client = GraphServiceClient(credentials, scopes)

request_body = PersonAnnotation(
	detail = ItemBody(
		content_type = BodyType.Text,
		content = "I am originally from Australia, but grew up in Moscow, Russia.",
	),
	display_name = "About Me",
)

result = await graph_client.me.profile.notes.post(request_body)

Importante

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

{
  "id": "0fb4c1e3-c1e3-0fb4-e3c1-b40fe3c1b40f",
  "allowedAudiences": "organization",
  "inference": null,
  "createdDateTime": "2020-07-06T06:34:12.2294868Z",
  "createdBy": {
    "application": null,
    "device": null,
    "user": {
      "displayName": "Innocenty Popov",
      "id": "db789417-4ccb-41d1-a0a9-47b01a09ea49"
    }
  },
  "lastModifiedDateTime": "2020-07-06T06:34:12.2294868Z",
  "lastModifiedBy": {
    "application": null,
    "device": null,
    "user": {
      "displayName": "Innocenty Popov",
      "id": "db789417-4ccb-41d1-a0a9-47b01a09ea49"
    }
  },
  "detail": {
    "contentType": "text",
    "content": "I am originally from Australia, but grew up in Moscow, Russia."
  },
  "displayName": "About Me"
}

Créer personAnnotation

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

Réponse

Exemples

Réponse

Commentaires

Commentaires

Ressources supplémentaires