Mit dieser API können Sie offene Erweiterungen (Objekte des Typs openTypeExtension) erstellen und einer neuen oder bereits vorhandenen Ressourceninstanz benutzerdefinierte Eigenschaften hinzufügen. Sie können im Rahmen ein und desselben Vorgangs in einer Ressourceninstanz eine offene Erweiterung erstellen und benutzerdefinierte Daten speichern. Ausgenommen sind bestimmte Ressourcen.
In der Tabelle im Abschnitt Berechtigungen sind die Ressourcen aufgelistet, die offene Erweiterungen unterstützen.
Hinweis: Wenn Sie offene Erweiterungen auf Outlook-Ressourcen erstellen, ziehen Sie Outlook-spezifische Überlegungen unter openTypeExtension-Ressourcentyp zurate.
Abhängig von der Ressource, die Sie erstellen, der Erweiterung und dem angeforderten Berechtigungstyp (delegiert oder Anwendung), ist die in der folgenden Tabelle angegebene Berechtigung die geringsten Berechtigungen, die zum Aufrufen dieser API erforderlich sind. Um mehr zu erfahren und vor der Wahl weiterer privilegierterer Berechtigungen mit Umsicht vorzugehen, suchen Sie unter Berechtigungen nach den folgenden Berechtigungen.
Erstellen einer Erweiterung in einer neuen Ressourceninstanz
Verwenden Sie die gleiche REST-Anforderung, die Sie zum Erstellen der Instanz verwenden.
POST /users/{id|userPrincipalName}/events
POST /users/{id|userPrincipalName}/messages
POST /groups/{id}/events
POST /groups/{id}/threads/{id}/posts/{id}/reply
POST /users/{id|userPrincipalName}/contacts
POST /users/{id|userPrincipalName}/todo/lists/{id}/tasks
POST /users/{id|userPrincipalName}/todo/lists
Hinweis: Diese Syntax zeigt mehrere häufig verwendete Möglichkeiten zum Erstellen der unterstützten Ressourceninstanzen. Alle anderen POST-Syntaxen, mit denen Sie diese Ressourceninstanzen erstellen können, unterstützen das Erstellen offener Erweiterungen darin in einer ähnlichen Weise.
Im Abschnitt Anforderungstext ist beschrieben, wie Sie die Eigenschaften der neuen Ressourceninstanz und die Erweiterung in den Anforderungstext einschließen können.
Erstellen einer Erweiterung in einer vorhandenen Ressourceninstanz
Geben Sie die Ressourceninstanz in der Anforderung an, und wenden Sie den Befehl POST auf die Navigationseigenschaft extensions an.
POST /devices/{id}/extensions
POST /users/{id|userPrincipalName}/events/{id}/extensions
POST /groups/{id}/extensions
POST /groups/{id}/events/{id}/extensions
POST /groups/{id}/threads/{id}/posts/{id}/extensions
POST /users/{id|userPrincipalName}/messages/{id}/extensions
POST /organization/{id}/extensions
POST /users/{id|userPrincipalName}/contacts/{id}/extensions
POST /users/{id|userPrincipalName}/extensions
POST /users/{id|userPrincipalName}/todo/lists/{id}/tasks/{id}/extensions
POST /users/{id|userPrincipalName}/todo/lists/{id}/extensions
Hinweis: Diese Syntax zeigt mehrere häufig verwendete Möglichkeiten zum Identifizieren einer Ressourceninstanz, um eine Erweiterung darin zu erstellen. Alle anderen Syntaxen, mit denen Sie diese Ressourceninstanzen identifizieren können, unterstützen das Erstellen offener Erweiterungen darin in einer ähnlichen Weise.
Im Abschnitt Anforderungstext wird beschrieben, wie Sie die Erweiterung in den Anforderungstext einschließen können.
Pfadparameter
Parameter
Typ
Beschreibung
id
string
Eine eindeutige ID für ein Objekt in der entsprechenden Sammlung. Erforderlich.
Geben Sie einen JSON-Text einer openTypeExtension mit den folgenden erforderlichen Name-Wert-Paaren und allen anderen benutzerdefinierten Daten an. Die Daten in der JSON-Nutzlast können Grundtypen oder Arrays von Grundtypen sein.
Name
Wert
@odata.type
microsoft.graph.openTypeExtension
extensionName
%unique_string%
Beim Erstellen einer Erweiterung in einer neuen Ressourceninstanz müssen Sie zusätzlich zu dem neuen openTypeExtension-Objekt eine JSON-Darstellung der zur Erstellung einer solchen Ressourceninstanz erforderlichen Eigenschaften angeben.
Antwort
Antwortcode
Je nach Vorgang lautet der Antwortcode 201 Created oder 202 Accepted.
Wenn Sie eine Erweiterung mit dem gleichen Vorgang erstellen, mit dem Sie eine Ressourceninstanz erstellt haben, gibt der Vorgang den gleichen Antwortcode zurück, der zurückgegeben wird, wenn Sie den Vorgang zum Erstellen der Ressourceninstanz ohne die Erweiterung verwenden.
Informationen zum Erstellen des instance finden Sie in den entsprechenden Artikeln, wie oben aufgeführt.
Antworttext
Szenario
Ressource
Antworttext
Erstellen einer Erweiterung bei gleichzeitiger expliziter Erstellung einer neuen Ressourceninstanz
Die Antwort enthält nur einen Antwortcode, keinen Antworttext.
Erstellen einer Erweiterung in einer vorhandenen Ressourceninstanz
Alle unterstützten Ressourcen
Enthält das openTypeExtension-Objekt.
Beispiele
Beispiel 1: Erstellen einer Nachricht und einer Erweiterung im selben Aufruf
Anforderung
Im folgenden Beispiel werden eine Nachricht und eine Erweiterung im selben Aufruf erstellt. Der Anforderungstext enthält Folgendes:
Die für eine neue Nachricht typischen Eigenschaften subject, body und toRecipients
Daneben die folgenden Parameter der Erweiterung:
Den Typ microsoft.graph.openTypeExtension
Den Erweiterungsnamen „Com.Contoso.Referral“
Zusätzliche Daten, die als drei benutzerdefinierte Eigenschaften in der JSON-Nutzlast gespeichert werden sollen: companyName, expirationDate und dealValue
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new Message
{
Subject = "Annual review",
Body = new ItemBody
{
ContentType = BodyType.Html,
Content = "You should be proud!",
},
ToRecipients = new List<Recipient>
{
new Recipient
{
EmailAddress = new EmailAddress
{
Address = "rufus@contoso.com",
},
},
},
Extensions = new List<Extension>
{
new OpenTypeExtension
{
OdataType = "microsoft.graph.openTypeExtension",
ExtensionName = "Com.Contoso.Referral",
AdditionalData = new Dictionary<string, object>
{
{
"companyName" , "Wingtip Toys"
},
{
"expirationDate" , "2015-12-30T11:00:00.000Z"
},
{
"dealValue" , 10000
},
},
},
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Messages.PostAsync(requestBody);
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
Message message = new Message();
message.setSubject("Annual review");
ItemBody body = new ItemBody();
body.setContentType(BodyType.Html);
body.setContent("You should be proud!");
message.setBody(body);
LinkedList<Recipient> toRecipients = new LinkedList<Recipient>();
Recipient recipient = new Recipient();
EmailAddress emailAddress = new EmailAddress();
emailAddress.setAddress("rufus@contoso.com");
recipient.setEmailAddress(emailAddress);
toRecipients.add(recipient);
message.setToRecipients(toRecipients);
LinkedList<Extension> extensions = new LinkedList<Extension>();
OpenTypeExtension extension = new OpenTypeExtension();
extension.setOdataType("microsoft.graph.openTypeExtension");
extension.setExtensionName("Com.Contoso.Referral");
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("companyName", "Wingtip Toys");
additionalData.put("expirationDate", "2015-12-30T11:00:00.000Z");
additionalData.put("dealValue", 10000);
extension.setAdditionalData(additionalData);
extensions.add(extension);
message.setExtensions(extensions);
Message result = graphClient.me().messages().post(message);
Das folgende Beispiel zeigt die Antwort für das erste Beispiel. Der Antworttext enthält die Eigenschaften der neuen Nachricht sowie die folgenden Parameter der neuen Erweiterung:
Die Eigenschaft id mit dem vollqualifizierten Namen microsoft.graph.openTypeExtension.Com.Contoso.Referral
Die in der Anforderung angegebene Standardeigenschaft extensionName
Die in der Anforderung angegebenen benutzerdefinierten Daten, die als drei benutzerdefinierte Eigenschaften gespeichert sind.
Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.
Beispiel 2: Erstellen einer Erweiterung in der angegebenen Nachricht
Anforderung
Im folgenden Beispiel wird eine Erweiterung in der angegebenen Nachricht erstellt. Der Anforderungstext enthält die folgenden Parameter für die Erweiterung:
Den Typ microsoft.graph.openTypeExtension
Den Erweiterungsnamen „Com.Contoso.Referral“
Zusätzliche Daten, die als drei benutzerdefinierte Eigenschaften in der JSON-Nutzlast gespeichert werden sollen: companyName, dealValue und expirationDate
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new OpenTypeExtension
{
OdataType = "microsoft.graph.openTypeExtension",
ExtensionName = "Com.Contoso.Referral",
AdditionalData = new Dictionary<string, object>
{
{
"companyName" , "Wingtip Toys"
},
{
"dealValue" , 500050
},
{
"expirationDate" , "2015-12-03T10:00:00.000Z"
},
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Messages["{message-id}"].Extensions.PostAsync(requestBody);
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
OpenTypeExtension extension = new OpenTypeExtension();
extension.setOdataType("microsoft.graph.openTypeExtension");
extension.setExtensionName("Com.Contoso.Referral");
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("companyName", "Wingtip Toys");
additionalData.put("dealValue", 500050);
additionalData.put("expirationDate", "2015-12-03T10:00:00.000Z");
extension.setAdditionalData(additionalData);
Extension result = graphClient.me().messages().byMessageId("{message-id}").extensions().post(extension);
Beispiel 3: Erstellen einer Erweiterung im angegebenen Gruppenereignis
Anforderung
Im folgenden Beispiel wird eine Erweiterung im angegebenen Gruppenereignis erstellt. Der Anforderungstext enthält die folgenden Parameter für die Erweiterung:
Den Typ microsoft.graph.openTypeExtension
Den Erweiterungsnamen „Com.Contoso.Deal“
Zusätzliche Daten, die als drei benutzerdefinierte Eigenschaften in der JSON-Nutzlast gespeichert werden sollen: companyName, dealValue und expirationDate
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new OpenTypeExtension
{
OdataType = "microsoft.graph.openTypeExtension",
ExtensionName = "Com.Contoso.Deal",
AdditionalData = new Dictionary<string, object>
{
{
"companyName" , "Alpine Skis"
},
{
"dealValue" , 1010100
},
{
"expirationDate" , "2015-07-03T13:04:00.000Z"
},
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Groups["{group-id}"].Events["{event-id}"].Extensions.PostAsync(requestBody);
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
OpenTypeExtension extension = new OpenTypeExtension();
extension.setOdataType("microsoft.graph.openTypeExtension");
extension.setExtensionName("Com.Contoso.Deal");
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("companyName", "Alpine Skis");
additionalData.put("dealValue", 1010100);
additionalData.put("expirationDate", "2015-07-03T13:04:00.000Z");
extension.setAdditionalData(additionalData);
Extension result = graphClient.groups().byGroupId("{group-id}").events().byEventId("{event-id}").extensions().post(extension);
Beispiel 4: Erstellen einer Erweiterung in einem neuen Gruppenbeitrag
Anforderung
Im folgenden Beispiel wird eine Erweiterung in einem neuen Gruppenbeitrag erstellt, wobei derselbe Antwortaktionsaufruf für einen vorhandenen Gruppenbeitrag verwendet wird. Die Aktion reply erstellt einen neuen Beitrag und eine neue, in diesen Beitrag eingebettete Erweiterung. Der Antworttext enthält eine Eigenschaft post mit dem Text des neuen Beitrags sowie die folgenden Daten der neuen Erweiterung:
Den Typ microsoft.graph.openTypeExtension
Den Erweiterungsnamen „Com.Contoso.HR“
Zusätzliche Daten, die als drei benutzerdefinierte Eigenschaften in der JSON-Nutzlast gespeichert werden sollen: companyName, expirationDateund das Array der Zeichenfolgen topPicks.
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Groups.Item.Threads.Item.Posts.Item.Reply;
using Microsoft.Graph.Models;
var requestBody = new ReplyPostRequestBody
{
Post = new Post
{
Body = new ItemBody
{
ContentType = BodyType.Html,
Content = "<html><body><div><div><div><div>When and where? </div></div></div></div></body></html>",
},
Extensions = new List<Extension>
{
new OpenTypeExtension
{
OdataType = "microsoft.graph.openTypeExtension",
ExtensionName = "Com.Contoso.HR",
AdditionalData = new Dictionary<string, object>
{
{
"companyName" , "Contoso"
},
{
"expirationDate" , "2015-07-03T13:04:00.000Z"
},
{
"topPicks" , new List<string>
{
"Employees only",
"Add spouse or guest",
"Add family",
}
},
},
},
},
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Groups["{group-id}"].Threads["{conversationThread-id}"].Posts["{post-id}"].Reply.PostAsync(requestBody);
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc groups threads posts reply post --group-id {group-id} --conversation-thread-id {conversationThread-id} --post-id {post-id}
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.groups.item.threads.item.posts.item.reply.ReplyPostRequestBody replyPostRequestBody = new com.microsoft.graph.groups.item.threads.item.posts.item.reply.ReplyPostRequestBody();
Post post = new Post();
ItemBody body = new ItemBody();
body.setContentType(BodyType.Html);
body.setContent("<html><body><div><div><div><div>When and where? </div></div></div></div></body></html>");
post.setBody(body);
LinkedList<Extension> extensions = new LinkedList<Extension>();
OpenTypeExtension extension = new OpenTypeExtension();
extension.setOdataType("microsoft.graph.openTypeExtension");
extension.setExtensionName("Com.Contoso.HR");
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("companyName", "Contoso");
additionalData.put("expirationDate", "2015-07-03T13:04:00.000Z");
LinkedList<String> topPicks = new LinkedList<String>();
topPicks.add("Employees only");
topPicks.add("Add spouse or guest");
topPicks.add("Add family");
additionalData.put("topPicks", topPicks);
extension.setAdditionalData(additionalData);
extensions.add(extension);
post.setExtensions(extensions);
replyPostRequestBody.setPost(post);
graphClient.groups().byGroupId("{group-id}").threads().byConversationThreadId("{conversationThread-id}").posts().byPostId("{post-id}").reply().post(replyPostRequestBody);
Das folgende Beispiel zeigt die Antwort. Wird eine Erweiterung in einem neuen Gruppenbeitrag erstellt, wird nur der Antwortcode „HTTP 202“ zurückgegeben.
Beispiel 5: Erstellen einer Erweiterung in einem neuen Gruppenbeitrag mithilfe des POST-Vorgangs
Anforderung 5
Im folgenden Beispiel wird eine Erweiterung in einem neuen Gruppenbeitrag mithilfe des gleichen POST-Vorgangs erstellt, um eine Konversation zu erstellen. Die POST-Operation erstellt eine neue Unterhaltung, einen neuen Thread, einen neuen Beitrag und eine neue, in diesen Beitrag eingebettete Erweiterung. Der Anforderungstext enthält die Eigenschaften Topic und Threads sowie ein untergeordnetes Objekt des Typs post der neuen Unterhaltung. Das post-Objekt wiederum enthält den Text des neuen Beitrags sowie die folgenden Daten der Erweiterung:
Den Typ microsoft.graph.openTypeExtension
Den Erweiterungsnamen „Com.Contoso.HR“
Zusätzliche Daten, die als drei benutzerdefinierte Eigenschaften in der JSON-Nutzlast gespeichert werden sollen: companyName, expirationDateund das Array der Zeichenfolgen topPicks.
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new Conversation
{
Topic = "Does anyone have a second?",
Threads = new List<ConversationThread>
{
new ConversationThread
{
Posts = new List<Post>
{
new Post
{
Body = new ItemBody
{
ContentType = BodyType.Html,
Content = "This is urgent!",
},
Extensions = new List<Extension>
{
new OpenTypeExtension
{
OdataType = "microsoft.graph.openTypeExtension",
ExtensionName = "Com.Contoso.Benefits",
AdditionalData = new Dictionary<string, object>
{
{
"companyName" , "Contoso"
},
{
"expirationDate" , "2016-08-03T11:00:00.000Z"
},
{
"topPicks" , new List<string>
{
"Employees only",
"Add spouse or guest",
"Add family",
}
},
},
},
},
},
},
},
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Groups["{group-id}"].Conversations.PostAsync(requestBody);
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
Conversation conversation = new Conversation();
conversation.setTopic("Does anyone have a second?");
LinkedList<ConversationThread> threads = new LinkedList<ConversationThread>();
ConversationThread conversationThread = new ConversationThread();
LinkedList<Post> posts = new LinkedList<Post>();
Post post = new Post();
ItemBody body = new ItemBody();
body.setContentType(BodyType.Html);
body.setContent("This is urgent!");
post.setBody(body);
LinkedList<Extension> extensions = new LinkedList<Extension>();
OpenTypeExtension extension = new OpenTypeExtension();
extension.setOdataType("microsoft.graph.openTypeExtension");
extension.setExtensionName("Com.Contoso.Benefits");
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("companyName", "Contoso");
additionalData.put("expirationDate", "2016-08-03T11:00:00.000Z");
LinkedList<String> topPicks = new LinkedList<String>();
topPicks.add("Employees only");
topPicks.add("Add spouse or guest");
topPicks.add("Add family");
additionalData.put("topPicks", topPicks);
extension.setAdditionalData(additionalData);
extensions.add(extension);
post.setExtensions(extensions);
posts.add(post);
conversationThread.setPosts(posts);
threads.add(conversationThread);
conversation.setThreads(threads);
Conversation result = graphClient.groups().byGroupId("{group-id}").conversations().post(conversation);
Das folgende Beispiel zeigt die Antwort, die die neue Konversation und eine Thread-ID enthält. Dieser neue Thread enthält einen automatisch erstellten Beitrag, der wiederum die neue Erweiterung enthält.
Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt sein.
Um die neue Erweiterung zu erhalten, rufen Sie zunächst alle Beiträge in diesem Thread ab, und zunächst sollte es nur einen geben. Wenden Sie dann die Beitrags-ID und den Erweiterungsnamen Com.Contoso.Benefits an, um die Erweiterung abzurufen.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.