Créer une propriété étendue à valeurs multiples
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 .
Attention
Les applications existantes qui utilisent cette fonctionnalité avec les tâches Outlook doivent être mises à jour, car les tâches Outlook sont déconseillées. Pour plus d’informations, consultez API To Do en préversion publique .
Créez une ou plusieurs propriétés étendues à valeurs multiples dans une instance nouvelle ou existante d’une ressource.
Les ressources utilisateur suivantes sont prises en charge :
Et les ressources de groupe suivantes :
Consultez la rubrique relative à la vue d’ensemble des propriétés étendues pour savoir quand utiliser les extensions d’ouverture ou les propriétés étendues, et comment spécifier les propriétés étendues.
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
Selon la ressource dans laquelle vous créez la propriété étendue et le type d’autorisation (délégué ou application) que vous demandez, l’autorisation spécifiée dans le tableau suivant est la valeur minimale requise pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.
| Ressource prise en charge | Déléguée (compte professionnel ou scolaire) | Déléguée (compte Microsoft personnel) | Application |
|---|---|---|---|
| calendar | Calendars.ReadWrite | Calendars.ReadWrite | Calendars.ReadWrite |
| contact | Contacts.ReadWrite | Contacts.ReadWrite | Contacts.ReadWrite |
| contactFolder | Contacts.ReadWrite | Contacts.ReadWrite | Contacts.ReadWrite |
| event | Calendars.ReadWrite | Calendars.ReadWrite | Calendars.ReadWrite |
| group calendar | Group.ReadWrite.All | Non pris en charge | Non pris en charge |
| group event | Group.ReadWrite.All | Non pris en charge | Non pris en charge |
| group post | Group.ReadWrite.All | Non pris en charge | Non pris en charge |
| mailFolder | Mail.ReadWrite | Mail.ReadWrite | Mail.ReadWrite |
| message | Mail.ReadWrite | Mail.ReadWrite | Mail.ReadWrite |
| Tâche Outlook | Tasks.ReadWrite | Tasks.ReadWrite | Non pris en charge |
| Dossier de tâches Outlook | Tasks.ReadWrite | Tasks.ReadWrite | Non pris en charge |
Requête HTTP
Vous pouvez créer des propriétés étendues dans une instance de la ressource nouvelle ou existante.
Pour créer une ou plusieurs propriétés étendues dans une nouvelle instance de la ressource, utilisez la même demande REST que celle utilisée lors de la création de l’instance et incluez les propriétés de la nouvelle instance de la ressource et propriété étendue dans le corps de la requête. Certaines ressources prennent en charge la création de plusieurs façons. Pour plus d’informations sur la création de ces instances de ressources, consultez les rubriques correspondantes pour la création d’un message, d’un mailFolder, d’un événement, d’un calendrier, d’un contact, d’un contactFolder, d’une tâche Outlook, d’un dossier de tâches Outlook, d’un événement de groupe et d’un billet de groupe.
Voici la syntaxe des demandes.
POST /me/messages
POST /users/{id|userPrincipalName}/messages
POST /me/mailFolders/{id}/messages
POST /me/mailFolders
POST /users/{id|userPrincipalName}/mailFolders
POST /me/events
POST /users/{id|userPrincipalName}/events
POST /me/calendars
POST /users/{id|userPrincipalName}/calendars
POST /me/contacts
POST /users/{id|userPrincipalName}/contacts
POST /me/contactFolders
POST /users/{id|userPrincipalName}/contactFolders
POST /me/outlook/tasks
POST /users/{id|userPrincipalName}/outlook/tasks
POST /me/outlook/taskFolders/{id}/tasks
POST /users/{id|userPrincipalName}/outlook/taskFolders/{id}/tasks
POST /me/outlook/taskGroups/{id}/taskFolders/{id}/tasks
POST /users/{id|userPrincipalName}/outlook/taskGroups/{id}/taskFolders/{id}/tasks
POST /me/outlook/taskFolders
POST /users/{id|userPrincipalName}/outlook/taskFolders
POST /me/outlook/taskGroups/{id}/taskFolders
POST /users/{id|userPrincipalName}/outlook/taskGroups/{id}/taskFolders
POST /groups/{id}/events
POST /groups/{id}/threads/{id}/posts/{id}/reply
POST /groups/{id}/conversations/{id}/threads/{id}/posts/{id}/reply
POST /groups/{id}/threads/{id}/reply
POST /groups/{id}/conversations/{id}/threads/{id}/reply
POST /groups/{id}/threads
POST /groups/{id}/conversations
Pour créer une ou plusieurs propriétés étendues dans une instance de ressource existante, spécifiez l’instance dans la demande et incluez la propriété étendue dans le corps de la requête.
Note Vous ne pouvez pas créer une propriété étendue dans un billet de groupe existant.
PATCH /me/messages/{id}
PATCH /users/{id|userPrincipalName}/messages/{id}
PATCH /me/mailFolders/{id}/messages/{id}
PATCH /me/mailFolders/{id}
PATCH /users/{id|userPrincipalName}/mailFolders/{id}
PATCH /me/events/{id}
PATCH /users/{id|userPrincipalName}/events/{id}
PATCH /me/calendars/{id}
PATCH /users/{id|userPrincipalName}/calendars/{id}
PATCH /me/contacts/{id}
PATCH /users/{id|userPrincipalName}/contacts/{id}
PATCH /me/contactFolders/{id}
PATCH /users/{id|userPrincipalName}/contactFolders/{id}
PATCH /me/outlook/tasks/{id}
PATCH /users/{id|userPrincipalName}/outlook/tasks/{id}
PATCH /me/outlook/taskFolders/{id}/tasks/{id}
PATCH /users/{id|userPrincipalName}/outlook/taskFolders/{id}/tasks/{id}
PATCH /me/outlook/taskGroups/{id}/taskFolders/{id}/tasks/{id}
PATCH /users/{id|userPrincipalName}/outlook/taskGroups/{id}/taskFolders/{id}/tasks/{id}
PATCH /me/outlook/taskFolders/{id}
PATCH /users/{id|userPrincipalName}/outlook/taskFolders/{id}
PATCH /me/outlook/taskGroups/{id}/taskFolders/{id}
PATCH /users/{id|userPrincipalName}/outlook/taskGroups/{id}/taskFolders/{id}
PATCH /groups/{id}/events/{id}
En-têtes de demande
| Nom | Valeur |
|---|---|
| Autorisation | Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation. |
| Content-Type | application/json |
Corps de la demande
Indiquez le corps JSON de chaque objet multiValueLegacyExtendedProperty dans la propriété de la collection multiValueExtendedProperties de l’instance de la ressource.
| Propriété | Type | Description |
|---|---|---|
| multiValueExtendedProperties | collection multiValueLegacyExtendedProperty | Tableau d’une ou plusieurs propriétés étendues à valeurs multiples. |
| id | String | Pour chaque propriété de la collection multiValueExtendedProperties, spécifiez ce paramètre pour identifier la propriété. Il doit respecter l’un des formats pris en charge. Voir Vue d’ensemble des propriétés étendues Outlook pour plus d’informations. Obligatoire. |
| value | chaîne | Pour chaque propriété de la collection multiValueExtendedProperties, spécifiez la valeur de propriété. Obligatoire. |
Lorsque vous créez une propriété étendue dans une nouvelle instance de la ressource, outre la nouvelle collection multiValueExtendedProperties, fournissez une représentation JSON de cette instance de la ressource (autrement dit, une ressource message, mailFolder, event, etc.)
Réponse
Code de réponse
Une opération réussie de création d’une propriété étendue dans une nouvelle instance de ressource renvoie 201 Created, sauf dans un nouveau billet de groupe, selon la méthode utilisée, l’opération peut renvoyer 200 OK ou 202 Accepted.
Dans une instance de ressource existante, une opération de création réussie renvoie 200 OK.
Corps de la réponse
Lorsque vous créez une propriété étendue dans une ressource prise en charge autre que group post, la réponse inclut uniquement l’instance nouvelle ou existante, mais pas la nouvelle propriété étendue. Pour afficher la propriété étendue nouvellement créée, obtenez l’instance développée avec la propriété étendue.
Lorsque vous créez une propriété étendue dans un nouveau billet de groupe, la réponse inclut uniquement un code de réponse, mais pas le nouveau billet ni la propriété étendue. Vous ne pouvez pas créer une propriété étendue dans un billet de groupe existant.
Exemple
Demande 1
Le premier exemple crée une propriété étendue à valeurs multiples dans un nouvel événement dans la même opération POST. Outre les propriétés que vous incluez normalement pour un nouvel événement, le corps de la requête inclut la collection multiValueExtendedProperties qui contient une propriété étendue. Le corps de la demande inclut les informations suivantes sur la propriété étendue à valeurs multiples :
- id, qui spécifie la propriété sous la forme d’un tableau de chaînes avec le GUID spécifié et le nom
Recreation. - value, qui spécifie
Recreationsous forme d’un tableau de 3 valeurs de chaîne,["Food", "Hiking", "Swimming"].
POST https://graph.microsoft.com/beta/me/events
Content-Type: application/json
{
"subject": "Family reunion",
"body": {
"contentType": "HTML",
"content": "Let's get together this Thanksgiving!"
},
"start": {
"dateTime": "2015-11-26T09:00:00",
"timeZone": "Pacific Standard Time"
},
"end": {
"dateTime": "2015-11-29T21:00:00",
"timeZone": "Pacific Standard Time"
},
"attendees": [
{
"emailAddress": {
"address": "Terrie@contoso.com",
"name": "Terrie Barrera"
},
"type": "Required"
},
{
"emailAddress": {
"address": "Lauren@contoso.com",
"name": "Lauren Solis"
},
"type": "Required"
}
],
"multiValueExtendedProperties": [
{
"id":"StringArray {66f5a359-4659-4830-9070-00050ec6ac6e} Name Recreation",
"value": ["Food", "Hiking", "Swimming"]
}
]
}
Réponse 1
Une réponse correcte est indiquée par un code de réponse HTTP 201 Created et inclut le nouvel événement dans le corps de la réponse, semblable à la réponse de créer simplement un événement.
La réponse n’inclut pas de propriétés étendues nouvellement créées.
Pour afficher la propriété étendue nouvellement créée, obtenez l’événement développé avec la propriété étendue.
Demande 2
Le deuxième exemple crée une propriété étendue à valeurs multiples pour le message spécifié . Cette propriété étendue est le seul élément dans la collection multiValueExtendedProperties. Le corps de la demande inclut les informations suivantes sur la propriété étendue :
- id, qui spécifie la propriété sous la forme d’un tableau de chaînes avec le GUID spécifié et le nom
Palette. - value, qui spécifie
Palettesous forme de tableau de 3 valeurs de chaîne,["Green", "Aqua", "Blue"].
PATCH https://graph.microsoft.com/beta/me/messages('AAMkAGE1M2_as77AACHsLrBBBA=')
Content-Type: application/json
{
"multiValueExtendedProperties": [
{
"id":"StringArray {66f5a359-4659-4830-9070-00049ec6ac6e} Name Palette",
"value":["Green", "Aqua", "Blue"]
}
]
}
Réponse 2
Une réponse correcte est indiquée par un code de réponse HTTP 200 OK et inclut le message spécifié dans le corps de la réponse, semblable à la réponse de mettre à jour un message. La réponse n’inclut pas la propriété étendue nouvellement créée.
Pour afficher la propriété étendue nouvellement créée, obtenez le message développé avec la propriété étendue.
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour