Créer une propriété étendue à valeur uniqueCreate single-value extended property

Espace de noms: microsoft.graphNamespace: microsoft.graph

Créez une ou plusieurs propriétés étendues à valeur unique dans une instance nouvelle ou existante d’une ressource.Create one or more single-value extended properties in a new or existing instance of a resource.

Les ressources utilisateur suivantes sont prises en charge :The following user resources are supported:

Les ressources de groupe suivantes sont également prises en charge :As well as the following group resources:

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.See Extended properties overview for more information about when to use open extensions or extended properties, and how to specify extended properties.

AutorisationsPermissions

En fonction de la ressource dans laquelle vous créez la propriété étendue et du type d’autorisation (délégué ou application) que vous demandez, l’autorisation spécifiée dans le tableau suivant est le minimum requis pour appeler cette API.Depending on the resource you're creating the extended property in and the permission type (delegated or application) you request, the permission specified in the following table is the minimum required to call this API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.To learn more, including how to choose permissions, see Permissions.

Ressource prise en chargeSupported resource Déléguée (compte professionnel ou scolaire)Delegated (work or school account) Déléguée (compte Microsoft personnel)Delegated (personal Microsoft account) ApplicationApplication
calendarcalendar Calendars.ReadWriteCalendars.ReadWrite Calendars.ReadWriteCalendars.ReadWrite Calendars.ReadWriteCalendars.ReadWrite
contactcontact Contacts.ReadWriteContacts.ReadWrite Contacts.ReadWriteContacts.ReadWrite Contacts.ReadWriteContacts.ReadWrite
contactFoldercontactFolder Contacts.ReadWriteContacts.ReadWrite Contacts.ReadWriteContacts.ReadWrite Contacts.ReadWriteContacts.ReadWrite
eventevent Calendars.ReadWriteCalendars.ReadWrite Calendars.ReadWriteCalendars.ReadWrite Calendars.ReadWriteCalendars.ReadWrite
group calendargroup calendar Group.ReadWrite.AllGroup.ReadWrite.All Non pris en chargeNot supported Non pris en chargeNot supported
group eventgroup event Group.ReadWrite.AllGroup.ReadWrite.All Non pris en chargeNot supported Non pris en chargeNot supported
group postgroup post Group.ReadWrite.AllGroup.ReadWrite.All Non pris en chargeNot supported Non pris en chargeNot supported
mailFoldermailFolder Mail.ReadWriteMail.ReadWrite Mail.ReadWriteMail.ReadWrite Mail.ReadWriteMail.ReadWrite
messagemessage Mail.ReadWriteMail.ReadWrite Mail.ReadWriteMail.ReadWrite Mail.ReadWriteMail.ReadWrite

Requête HTTPHTTP request

Vous pouvez créer des propriétés étendues dans une instance de la ressource nouvelle ou existante.You can create extended properties in a new or existing resource instance.

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. Notez que 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, mailFolder, événement, calendrier, contact, contactFolder, événement de groupe et billet de groupe.To create one or more extended properties in a new resource instance, use the same REST request as creating the instance, and include the properties of the new resource instance and extended property in the request body. Note that some resources support creation in more than one way. For more information on creating these resource instances, see the corresponding topics for creating a message, mailFolder, event, calendar, contact, contactFolder, group event, and group post.

Voici la syntaxe des demandes.The following is the syntax of the requests.

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 /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.To create one or more extended properties in an existing resource instance, specify the instance in the request, and include the extended property in the request body.

Remarque Vous ne pouvez pas créer une propriété étendue dans un billet de groupe existant.Note You cannot create an extended property in an existing group post.

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 /groups/{id}/events/{id}

En-têtes de demandeRequest headers

NomName ValeurValue
AutorisationAuthorization Porteur {token}. Obligatoire.Bearer {token}. Required.
Content-TypeContent-Type application/jsonapplication/json

Corps de la demandeRequest body

Fournissez un organisme JSON de chaque objet singleValueLegacyExtendedProperty dans la propriété de la collection singleValueExtendedProperties de l’instance de la ressource.Provide a JSON body of each singleValueLegacyExtendedProperty object in the singleValueExtendedProperties collection property of the resource instance.

PropriétéProperty TypeType DescriptionDescription
singleValueExtendedPropertiessingleValueExtendedProperties Collection singleValueLegacyExtendedPropertysingleValueLegacyExtendedProperty collection Tableau d’une ou plusieurs propriétés étendues à valeur unique.An array of one or more single-valued extended properties.
idid ChaîneString Pour chaque propriété dans la collection singleValueExtendedProperties, spécifiez ceci pour identifier la propriété. Il doit suivre l’un des formats pris en charge. Voir Vue d’ensemble des propriétés étendues Outlook pour plus d’informations. Obligatoire.For each property in the singleValueExtendedProperties collection, specify this to identify the property. It must follow one of the supported formats. See Outlook extended properties overview for more information. Required.
valuevalue stringstring Pour chaque propriété dans la collection singleValueExtendedProperties, spécifiez la valeur de la propriété. Obligatoire.For each property in the singleValueExtendedProperties collection, specify the property value. Required.

Lorsque vous créez une propriété étendue dans une nouvelle instance de la ressource, outre la nouvelle collection singleValueExtendedProperties, fournissez une représentation JSON de cette instance de la ressource (autrement dit, un message, mailFolder, événement, etc.)When creating an extended property in a new resource instance, in addition to the new singleValueExtendedProperties collection, provide a JSON representation of that resource instance (that is, a message, mailFolder, event, etc.)

RéponseResponse

Code de réponseResponse code

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.An operation successful in creating an extended property in a new resource instance returns 201 Created, except in a new group post, depending on the method used, the operation can return 200 OK or 202 Accepted.

Dans une instance de ressource existante, une opération de création réussie renvoie 200 OK.In an existing resource instance, a successful create operation returns 200 OK.

Corps de la réponseResponse body

Lorsque vous créez une propriété étendue, 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.When creating an extended property, the response includes only the new or existing instance but not the new extended property. To see the newly created extended property, get the instance expanded with the extended property.

Lorsque vous créez une propriété étendue dans un nouveau billet 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.When creating an extended property in a new group post by replying to a thread or post, the response includes only a response code but not the new post nor the extended property.

ExempleExample

Demande 1Request 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é :The first example creates a new event and a single-value extended property in the same POST operation. Apart from the properties you'd normally include for a new event, the request body includes the singleValueExtendedProperties collection that contains one single-value extended property, and the following for the property:

  • ID spécifie le type de propriété en tant que String, le GUID et la propriété nommée Fun.id specifies the property type as String, the GUID, and the property named Fun.
  • valeur spécifie Food comme valeur de la propriété Fun.value specifies Food as the value of the Fun property.
POST https://graph.microsoft.com/v1.0/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 1Response 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 les propriétés étendues nouvellement créées.A successful response is indicated by an HTTP 201 Created response code, and includes the new event in the response body, similar to the response from creating just an event. The response does not include any newly created extended properties.

Pour afficher la propriété étendue nouvellement créée, obtenez l’événement développé avec la propriété étendue.To see the newly created extended property, get the event expanded with the extended property.


Demande 2Request 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 :The second example creates one single-value extended property for the specified existing message. That extended property is the only element in the singleValueExtendedProperties array. The request body includes the following for the extended property:

  • ID spécifie le type de propriété en tant que String, le GUID et la propriété nommée Color.id specifies the property type as String, the GUID, and the property named Color.
  • valeur spécifie Green comme valeur de la propriété Color.value specifies Green as the value of the Color property.
PATCH https://graph.microsoft.com/v1.0/me/messages/AAMkAGE1M2_bs88AACHsLqWAAA=

Content-Type: application/json

{
  "singleValueExtendedProperties": [
      {
         "id":"String {66f5a359-4659-4830-9070-00047ec6ac6e} Name Color",
         "value":"Green"
      }
    ]
}
Réponse 2Response 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.A successful response is indicated by an HTTP 200 OK response code, and includes the specified message in the response body, similar to the response from updating a message. The response does not include the newly created extended property.

Pour afficher la propriété étendue nouvellement créée, obtenez le message développé avec la propriété étendue.To see the newly created extended property, get the message expanded with the extended property.