Erweiterte einwertige Eigenschaft erstellen

Dient zum Erstellen einer oder mehrerer erweiterter einwertiger Eigenschaften in einer neuen oder vorhandenen Instanz einer Ressource.

Die folgenden Benutzerressourcen werden unterstützt:

Darüber hinaus werden die folgenden Gruppenressourcen unterstützt:

  • event-Ressourcen für Gruppen
  • calendar-Ressourcen für Gruppen
  • post-Ressourcen für Gruppen

Unter Überblick über erweiterte Eigenschaften finden Sie weitere Informationen dazu, wann Datenerweiterungen oder erweiterte Eigenschaften verwendet werden sollten und wie erweiterte Eigenschaften angegeben werden.

Voraussetzungen

Zur Ausführung dieser API ist einer der folgenden Bereiche erforderlich (je nachdem, in welcher Ressource Sie die erweiterte Eigenschaft erstellen):

  • Mail.ReadWrite
  • Calendars.ReadWrite
  • Contacts.ReadWrite
  • Group.ReadWrite.All

HTTP-Anforderung

Sie können erweiterte Eigenschaften in einer neuen oder vorhandenen Ressourceninstanz erstellen.

Verwenden Sie zum Erstellen einer oder mehrerer erweiterter Eigenschaften in einer neuen Ressourceninstanz die gleiche REST-Anforderung wie zum Erstellen der Instanz, und fügen Sie die Eigenschaften der neuen Ressourceninstanz und die erweiterte Eigenschaft zum Anforderungstext hinzu. Beachten Sie, dass für einige Ressourcen die Erstellung auf mehrere Weisen erfolgen kann. Weitere Informationen zum Erstellen dieser Ressourceninstanzen finden Sie unter den entsprechenden Themen zum Erstellen einer Nachricht, eines MailFolder-Elements, Ereignisses, Kalenders, Kontakts, contactFolder-Elements, Gruppenereignisses und eines Gruppenbeitrags.

So sieht die Syntax der Anforderungen aus:

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

Um eine oder mehrere erweiterte Eigenschaften in einer vorhandenen Ressourceninstanz zu erstellen,müssen Sie die Instanz in der Anforderung angeben und die erweiterte-Eigenschaft zum Anforderungstext hinzufügen.

Hinweis: Sie können keine erweiterte Eigenschaft in einem vorhandenen Gruppenbeitrag erstellen.

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}

Parameter

Parameter Typ Beschreibung
URL parameters    
id string Eine eindeutige ID für ein Objekt in der entsprechenden Sammlung. Erforderlich.
Body parameters    
singleValueExtendedProperties singleValueLegacyExtendedProperty-Sammlung Ein Array aus erweiterten mehrwertigen Eigenschaften.
id String Geben Sie diese für jede Eigenschaft in der singleValueExtendedProperties-Sammlung an, um die Eigenschaft zu identifizieren. Sie muss eins der unterstützten Formate aufweisen. Weitere Informationen finden Sie unter Überblick über erweiterte Eigenschaften in Outlook. Erforderlich.
value string Geben Sie für jede Eigenschaft in der singleValueExtendedProperties-Sammlung den Eigenschaftswert an. Erforderlich.

Anforderungsheader

Name Wert
Authorization Bearer %token%
Content-Type application/json

Anforderungstext

Stellen Sie einen JSON-Text für jedes singleValueLegacyExtendedProperty-Objekt in der singleValueExtendedProperties-Sammlungseigenschaft der Ressourceninstanz bereit.

Beim Erstellen einer erweiterten Eigenschaft in einer neuen Ressourceninstanz müssen Sie zusätzlich zu der neuen singleValueExtendedProperties-Sammlung eine JSON-Darstellung der betreffenden Ressourceninstanz spezifizieren (d. h. eine Ressource des Typs message, mailFolder, event usw.).

Antwort

Antwortcode

Ist die Operation zur Erstellung einer erweiterten Eigenschaft in einer neuen Ressourceninstanz erfolgreich, wird 201 Created zurückgegeben. Ausnahme: In einem neuen Gruppenbeitrag kann die Operation je nach verwendeter Methode 200 OK oder 202 Accepted zurückgeben.

Eine erfolgreiche Erstellungsoperation in einer vorhandenen Ressourceninstanz gibt 200 OK zurück.

Antworttext

Wenn Sie eine erweiterte Eigenschaft erstellen, enthält die Antwort nur die neue oder bereits vorhandene Instanz, nicht jedoch die neue erweiterte Eigenschaft. Möchten Sie die neu erstellte erweiterte Eigenschaft sehen, müssen Sie die um die erweiterte Eigenschaft erweiterte Instanz abrufen.

Beim Erstellen einer erweiterten Eigenschaft in einem neuen Gruppenbeitrag durch Antwort auf einen Thread oder Beitrag enthält die Antwort nur einen Antwortcode, nicht aber den neuen Beitrag oder die erweiterte Eigenschaft.

Beispiel

Anforderung 1

Im ersten Beispiel wird mit einer einzigen POST-Operation ein neuer Ereignis und eine einwertige erweiterte Eigenschaft erstellt. Abgesehen von den Eigenschaften, die Sie normalerweise für ein neues Ereignis definieren würden, enthält der Anforderungstext die singleValueExtendedProperties-Sammlung. Diese wiederum enthält eine erweiterte einwertige Eigenschaft und folgende Angaben für die Eigenschaft: - ID Gibt den Eigenschaftstyp als String, die GUID und die Eigenschaft mit dem Namen Fun an. - Wert Gibt Food als den Wert der Fun-Eigenschaft an.

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"
     }
  ]
}
Antwort 1

Eine erfolgreiche Antwort wird mit dem Antwortcode HTTP 201 Created gekennzeichnet und enthält das neue Ereignis im Antworttext, ähnlich wie die Antwort, die zurückgegeben wird, wenn Sie nur ein Ereignis erstellen. Die Antwort enthält keine neu erstellten erweiterten Eigenschaften.

Möchten Sie die neu erstellte erweiterte Eigenschaft sehen, müssen Sie das um die erweiterte Eigenschaft erweiterte Ereignis abrufen.


Anforderung 2

Das zweite Beispiel erstellt eine einwertige erweiterte Eigenschaft für die angegebene vorhandene Nachricht. Diese erweiterte Eigenschaft ist das einzige Element in dem singleValueExtendedProperties-Array. Der Anforderungstext enthält die folgenden Parameter für diese erweiterte Eigenschaft: - ID Gibt den Eigenschaftstyp als String, die GUID und die Color-Eigenschaft an. - Wert Gibt Green als den Wert der Color-Eigenschaft an.

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"
      }
    ]
}
Antwort 2

Eine erfolgreiche Antwort wird mit dem Antwortcode HTTP 200 OK gekennzeichnet und enthält die angegebene Nachricht im Antworttext, ähnlich wie die Antwort, die zurückgegeben wird, wenn Sie eine Nachricht aktualisieren. Die Antwort enthält nicht die neu erstellte erweiterte Eigenschaft.

Möchten Sie die neu erstellte erweiterte Eigenschaft sehen, müssen Sie die um die erweiterte Eigenschaft erweiterte Nachricht abrufen.