Freigeben über

Einwertige erweiterte Eigenschaft erstellen

  • Artikel

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Achtung

Outlook-Aufgaben sind veraltet und geben am 10. August 2022 keine Daten mehr zurück. Aktualisieren Vorhandener Apps, die dieses Feature verwenden, mit Outlook-Aufgaben.

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

Die folgenden Benutzerressourcen werden unterstützt:

Die folgenden Gruppenressourcen werden unterstützt:

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

Im Übersichtsartikel zu erweiterten Eigenschaften finden Sie weitere Informationen dazu, wann Sie offene Erweiterungen verwenden sollten und wann erweiterte Eigenschaften. Außerdem erfahren Sie dort, wie erweiterte Eigenschaften angegeben werden.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet
✅ ✅ ✅ ✅

Berechtigungen

Abhängig von der Ressource, in der Sie die erweiterte Eigenschaft erstellen, und dem berechtigungstyp (delegiert oder anwendung), den Sie anfordern, ist die in der folgenden Tabelle angegebene Berechtigung die mindeste erforderliche Berechtigung, um diese API aufzurufen. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie unter Berechtigungen.

Unterstützte Ressource Delegiert (Geschäfts-, Schul- oder Unikonto) Delegiert (persönliches Microsoft-Konto) Application
Kalender 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
calendar-Ressourcen für Gruppen Group.ReadWrite.All Nicht unterstützt Nicht unterstützt
event-Ressourcen für Gruppen Group.ReadWrite.All Nicht unterstützt Nicht unterstützt
post-Ressourcen für Gruppen Group.ReadWrite.All Nicht unterstützt Nicht unterstützt
mailFolder Mail.ReadWrite Mail.ReadWrite Mail.ReadWrite
message Mail.ReadWrite Mail.ReadWrite Mail.ReadWrite
Outlook-Aufgabe Tasks.ReadWrite Tasks.ReadWrite Nicht unterstützt
Outlook-Aufgabenordner Tasks.ReadWrite Tasks.ReadWrite Nicht unterstützt

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. Einige Ressourcen unterstützen die Erstellung auf mehr als eine Weise. Weitere Informationen zum Erstellen dieser Ressourceninstanzen finden Sie in den entsprechenden Themen zum Erstellen einer Nachricht, mailFolder, eines Ereignisses, eines Kalenders, eines Kontakts, eines Kontaktordners, einer Outlook-Aufgabe, einesGruppenereignisses 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 /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

Hinweis

Das Aufrufen des /me-Endpunkts erfordert einen angemeldeten Benutzer und daher eine delegierte Berechtigung. Anwendungsberechtigungen werden bei Verwendung des /me Endpunkts nicht unterstützt.

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.

Anmerkung 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 /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}

Hinweis

Das Aufrufen des /me-Endpunkts erfordert einen angemeldeten Benutzer und daher eine delegierte Berechtigung. Anwendungsberechtigungen werden bei Verwendung des /me Endpunkts nicht unterstützt.

Anforderungsheader

Name Wert
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json

Anforderungstext

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

Eigenschaft Type Beschreibung
singleValueExtendedProperties singleValueLegacyExtendedProperty-Sammlung Ein Array aus erweiterten mehrwertigen Eigenschaften.
id Zeichenfolge 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 Zeichenfolge Geben Sie für jede Eigenschaft in der singleValueExtendedProperties-Sammlung den Eigenschaftswert an. Erforderlich.

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 neuenGruppenbeitrag durch Antworten auf einen Thread oder Beitrag enthält die Antwort nur einen Antwortcode, aber weder den neuen Beitrag noch die erweiterte Eigenschaft.

Beispiel

Anforderung 1

Im ersten Beispiel werden ein neues Ereignis und eine einwertige erweiterte Eigenschaft im gleichen POST-Vorgang erstellt. Abgesehen von den Eigenschaften, die Sie normalerweise für ein neues Ereignis einschließen würden, enthält der Anforderungstext die singleValueExtendedProperties-Auflistung , die eine einwertige erweiterte Eigenschaft enthält, und folgendes 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/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"
     }
  ]
}
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/beta/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.