Créer une propriété étendue à valeur unique

Espace de noms: microsoft.graph

Créez une ou plusieurs propriétés étendues à valeur unique dans une instance nouvelle ou existante d’une ressource.

Les ressources utilisateur suivantes sont prises en charge :

• calendar
• contact
• contactFolder
• event
• mailFolder
• message
• Tâche Outlook
• Dossier de tâches Outlook
• todoTask

Les ressources de groupe suivantes sont prises en charge :

• group calendar
• group event
• group post

Pour plus d’informations sur l’utilisation des extensions ouvertes ou des propriétés étendues et sur la façon de spécifier des propriétés étendues, consultez Vue d’ensemble des propriétés étendues.

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

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.

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, d’une publication de groupe et de todoTask.

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 /me/todo/lists/{todoTaskListId}/tasks/{todoTaskId}?$expand=singleValueExtendedProperties($filter=id eq '{singleValueExtendedPropertyId}')
POST /me/todo/lists/{todoTaskListId}/tasks?$expand=singleValueExtendedProperties($filter=id eq '{singleValueExtendedPropertyId}')

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 /me/todo/lists/{todoTaskListId}/tasks?$expand=singleValueExtendedProperties($filter=id eq '{singleValueExtendedPropertyId}')
PATCH /me/todo/lists/{todoTaskListId}/tasks/{todoTaskId}?$expand=singleValueExtendedProperties($filter=id eq '{singleValueExtendedPropertyId}')

PATCH /groups/{id}/events/{id}

En-têtes de demande

Corps de la demande

Fournissez un organisme JSON de chaque objet singleValueLegacyExtendedProperty dans la propriété de la collection singleValueExtendedProperties de l’instance de la ressource.

Lors de la création d’une propriété étendue dans une nouvelle ressource instance, en plus de la nouvelle collection singleValueExtendedProperties, fournissez une représentation JSON de cette ressource instance (autrement dit, un message, mailFolder, un événement, todoTask, etc.)

Réponse

Code de réponse

Une opération qui crée correctement une propriété étendue dans une nouvelle ressource instance retourne un 201 Created code de réponse. Dans le cas d’un nouveau billet de groupe, selon la méthode utilisée, l’opération retourne un 200 OK ou un 202 Accepted code de réponse.

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, la réponse inclut uniquement les instance nouvelles ou existantes, 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 nouveaubillet de groupe en répondant à un thread ou à un billet, la réponse inclut uniquement un code de réponse, mais pas le nouveau billet ni la propriété étendue.

Exemples

Demande 1

Le premier exemple crée événement et une propriété étendue à valeur unique dans la même opération POST. Outre les propriétés que vous incluriez normalement pour un nouvel événement, le corps de la demande inclut la collection singleValueExtendedProperties qui contient une propriété étendue à valeur unique et les informations suivantes pour la propriété :

• ID spécifie le type de propriété en tant que String, le GUID et la propriété nommée Fun.
• valeur spécifie Food comme valeur de la propriété Fun.

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

{
  "subject": "Celebrate Thanksgiving",
  "body": {
    "contentType": "HTML",
    "content": "Let's get together!"
  },
  "start": {
      "dateTime": "2015-11-26T18:00:00",
      "timeZone": "Pacific Standard Time"
  },
  "end": {
      "dateTime": "2015-11-26T23:00:00",
      "timeZone": "Pacific Standard Time"
  },
  "attendees": [
    {
      "emailAddress": {
        "address": "Terrie@contoso.com",
        "name": "Terrie Barrera"
      },
      "type": "Required"
    }
  ],
  "singleValueExtendedProperties": [
     {
       "id":"String {66f5a359-4659-4830-9070-00040ec6ac6e} Name Fun",
       "value":"Food"
     }
  ]
}

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 à valeur unique pour le message existant spécifié . Cette propriété étendue est le seul élément dans le tableau singleValueExtendedProperties. Le corps de la demande inclut les informations suivantes pour la propriété étendue :

• ID spécifie le type de propriété en tant que String, le GUID et la propriété nommée Color.
• valeur spécifie Green comme valeur de la propriété Color.

PATCH https://graph.microsoft.com/beta/me/messages('AAMkAGE1M2_bs88AACHsLqWAAA=')

Content-Type: application/json

{
  "singleValueExtendedProperties": [
      {
         "id":"String {66f5a359-4659-4830-9070-00047ec6ac6e} Name Color",
         "value":"Green"
      }
    ]
}

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.