複数値の拡張プロパティを作成するCreate multi-value extended property

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでは、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

リソースの新規または既存のインスタンスに、1 つ以上の複数値の拡張プロパティを作成します。Create one or more multi-value extended properties in a new or existing instance of a resource.

次のユーザー リソースがサポートされます。The following user resources are supported:

次のグループ リソースもサポートされます。As well as the following group resources:

オープン拡張機能または拡張プロパティを使用するのに適した状況と、拡張プロパティを指定する方法の詳細については、「拡張プロパティの概要」を参照してください。See Extended properties overview for more information about when to use open extensions or extended properties, and how to specify extended properties.

アクセス許可Permissions

この 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. アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。To learn more, including how to choose permissions, see Permissions.

サポートされているリソースSupported resource 委任 (職場または学校のアカウント)Delegated (work or school account) 委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) アプリケーションApplication
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
イベントevent Calendars.ReadWriteCalendars.ReadWrite Calendars.ReadWriteCalendars.ReadWrite Calendars.ReadWriteCalendars.ReadWrite
グループ calendargroup calendar Group.ReadWrite.AllGroup.ReadWrite.All サポート対象外Not supported 非サポートNot supported
グループ eventgroup event Group.ReadWrite.AllGroup.ReadWrite.All サポート対象外Not supported 非サポートNot supported
グループ postgroup post Group.ReadWrite.AllGroup.ReadWrite.All サポート対象外Not supported 非サポートNot supported
mailFoldermailFolder Mail.ReadWriteMail.ReadWrite Mail.ReadWriteMail.ReadWrite Mail.ReadWriteMail.ReadWrite
メッセージmessage Mail.ReadWriteMail.ReadWrite Mail.ReadWriteMail.ReadWrite Mail.ReadWriteMail.ReadWrite
Outlook タスクOutlook task Tasks.ReadWriteTasks.ReadWrite Tasks.ReadWriteTasks.ReadWrite サポートされていませんNot supported
Outlook タスク フォルダーOutlook task folder Tasks.ReadWriteTasks.ReadWrite Tasks.ReadWriteTasks.ReadWrite 非サポートNot supported

HTTP 要求HTTP request

新規または既存のリソースのインスタンスに、拡張プロパティを作成できます。You can create extended properties in a new or existing resource instance.

1 つ以上の拡張プロパティを_新しい_リソースのインスタンスに作成するには、インスタンスの作成と同じ REST 要求を使用し、新しいリソース インスタンスのプロパティ_と拡張プロパティを_要求の本文に含めます。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. これらのリソースインスタンスを作成する方法の詳細については、「 message, mailfolder, event, calendar, contact, contactfolder, Outlook task, 」を作成するための対応するトピックを参照してください。Outlook のタスクフォルダーグループイベント、およびグループ投稿For more information on creating these resource instances, see the corresponding topics for creating a message, mailFolder, event, calendar, contact, contactFolder, Outlook task, Outlook task folder, group event, and group post.

以下に要求の構文を示します。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 /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

既存のリソースのインスタンスで 1 つ以上の拡張プロパティを作成するには、要求でインスタンスを指定し、要求本文に拡張プロパティを含めます。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.

既存のグループ投稿には拡張プロパティを作成できません。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 /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}

要求ヘッダーRequest headers

名前Name Value
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.
Content-TypeContent-Type application/jsonapplication/json

要求本文Request body

リソース インスタンスの multiValueExtendedProperties コレクション プロパティに、各 multiValueLegacyExtendedProperty オブジェクトの JSON 本文を指定します。Provide a JSON body of each multiValueLegacyExtendedProperty object in the multiValueExtendedProperties collection property of the resource instance.

プロパティProperty Type 説明Description
multiValueExtendedPropertiesmultiValueExtendedProperties multiValueLegacyExtendedProperty コレクションmultiValueLegacyExtendedProperty collection 1 つ以上の複数値を持つ拡張プロパティの配列。An array of one or more multi-valued extended properties.
idid StringString multiValueExtendedProperties コレクションの各プロパティに対してこれを指定し、プロパティを特定します。サポートされている形式のいずれかに従う必要があります。詳しくは、「Outlook の拡張プロパティの概要」をご覧ください。必須。For each property in the multiValueExtendedProperties 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 multiValueExtendedProperties コレクションの各プロパティに対し、プロパティの値を特定します。必須。For each property in the multiValueExtendedProperties collection, specify the property value. Required.

_新しい_リソース インスタンスに拡張プロパティを作成する場合は、新しい multiValueExtendedProperties コレクションのほか、そのリソース インスタンスの JSON 表現を指定します (messagemailFolderevent など)。When creating an extended property in a new resource instance, in addition to the new multiValueExtendedProperties collection, provide a JSON representation of that resource instance (that is, a message, mailFolder, event, etc.)

応答Response

応答コードResponse code

新しいリソース インスタンスに拡張プロパティが正常に作成されると、201 Created が返されます。ただし新しいグループ投稿の場合は別で、使用するメソッドに応じて、200 OK または 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.

既存のリソース インスタンスに拡張プロパティが正常に作成されると、200 OK が返されます。In an existing resource instance, a successful create operation returns 200 OK.

応答本文Response body

グループ投稿以外のサポートされているリソースで拡張プロパティを作成する場合、応答には新規または既存のインスタンスだけが含まれ、新しい拡張プロパティは含まれません。新しく作成された拡張プロパティを表示するには、拡張プロパティを使用して展開されているインスタンスを取得します。When creating an extended property in a supported resource other than group post, 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.

_新しい_グループ投稿に拡張プロパティを作成する場合、応答には応答コードだけが含まれ、新しい投稿や拡張プロパティは含まれません。既存のグループ投稿には拡張プロパティを作成できません。When creating an extended property in a new group post, the response includes only a response code but not the new post nor the extended property. You cannot create an extended property in an existing group post.

Example

要求 1Request 1

最初の例では、すべて同じ POST 操作の新しいイベントで複数値の拡張プロパティを作成します。新しいイベントに通常含まれるプロパティとは別に、要求の本文に 1 つの拡張プロパティを含む multiValueExtendedProperties コレクションが含まれます。要求本文には、その複数値の拡張プロパティに関する次のものが含まれています。The first example creates a multi-value extended property in a new event all in the same POST operation. Apart from the properties you'd normally include for a new event, the request body includes the multiValueExtendedProperties collection which contains one extended property. The request body includes the following for that multi-value extended property:

  • id 指定された GUID と名前 Recreation の文字列の配列としてプロパティを指定します。id which specifies the property as an array of strings with the specified GUID and the name Recreation.
  • value は、3 つの文字列値 Recreation の配列として ["Food", "Hiking", "Swimming"] を指定します。value which specifies Recreation as an array of 3 string values, ["Food", "Hiking", "Swimming"].
POST https://graph.microsoft.com/beta/me/events
Content-Type: application/json

{
  "subject": "Family reunion",
  "body": {
    "contentType": "HTML",
    "content": "Let's get together this Thanksgiving!"
  },
  "start": {
      "dateTime": "2015-11-26T09:00:00",
      "timeZone": "Pacific Standard Time"
  },
  "end": {
      "dateTime": "2015-11-29T21:00:00",
      "timeZone": "Pacific Standard Time"
  },
  "attendees": [
    {
      "emailAddress": {
        "address": "Terrie@contoso.com",
        "name": "Terrie Barrera"
      },
      "type": "Required"
    },
    {
      "emailAddress": {
        "address": "Lauren@contoso.com",
        "name": "Lauren Solis"
      },
      "type": "Required"
    }
  ],
  "multiValueExtendedProperties": [
     {
           "id":"StringArray {66f5a359-4659-4830-9070-00050ec6ac6e} Name Recreation",
           "value": ["Food", "Hiking", "Swimming"]
     }
  ]
}
応答 1Response 1

HTTP 201 Createdからの応答と同様に、 応答コードによって正常な応答が示され、応答の本文に新しいイベントが含まれます。応答には、新しく作成された拡張プロパティは含まれません。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.

新しく作成された拡張プロパティを表示するには、拡張プロパティを使用して展開されているイベントを取得します。To see the newly created extended property, get the event expanded with the extended property.


要求 2Request 2

2 番目の例では、指定したメッセージに対して 1 つの複数値の拡張プロパティを作成します。拡張プロパティは、multiValueExtendedProperties コレクションの唯一の要素です。要求本文には、拡張プロパティに関する次のものが含まれています。The second example creates one multi-value extended property for the specified message. That extended property is the only element in the multiValueExtendedProperties collection. The request body includes the following for the extended property:

  • id 指定された GUID と名前 Palette を使って、文字列の配列としてプロパティを指定します。id specifies the property as an array of strings with the specified GUID and the name Palette.
  • value 3 つの文字列値 Palette の配列として ["Green", "Aqua", "Blue"] を指定します。value specifies Palette as an array of 3 string values, ["Green", "Aqua", "Blue"].
PATCH https://graph.microsoft.com/beta/me/messages('AAMkAGE1M2_as77AACHsLrBBBA=')

Content-Type: application/json

{
  "multiValueExtendedProperties": [
      {
         "id":"StringArray {66f5a359-4659-4830-9070-00049ec6ac6e} Name Palette",
         "value":["Green", "Aqua", "Blue"]
      }
    ]
}
応答 2Response 2

メッセージの更新からの応答と同様に、HTTP 200 OK 応答コードによって正常な応答が示され、応答の本文に指定したメッセージが含まれています。応答には、新しく作成された拡張プロパティは含まれません。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.

新しく作成された拡張プロパティを表示するには、拡張プロパティを使用して展開されているメッセージを取得します。To see the newly created extended property, get the message expanded with the extended property.