创建单值扩展属性

在新建或现有的资源实例中创建一个或多个单值扩展属性。

支持以下用户资源:

以及以下组资源:

有关何时使用开放扩展或扩展属性,以及如何指定扩展属性的详细信息,请参阅扩展属性概述

先决条件

要执行此 API,需要以下范围之一,具体取决于将在其中创建扩展属性的资源:

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

HTTP 请求

可以在新建或现有的资源实例中创建扩展属性。

若要在_新的_资源实例中创建一个或多个扩展属性,请使用与创建实例相同的 REST 请求,并包括新资源实例的属性和请求正文中的_扩展属性_。注意,一些资源支持以多种方式创建。有关创建这些资源实例的详细信息,请参阅创建 邮件mailFolder事件日历联系人contactFolder组事件组帖子 的相应主题。

以下是请求的语法。

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

若要在现有资源实例中创建一个或多个扩展属性,请在请求中指定实例,并在请求正文中包括扩展属性。

注意不能在现有的组帖子中创建扩展属性。

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}

参数

参数 类型 说明
URL parameters    
id string 对象在相应集合中的唯一标识符。必需。
Body parameters    
singleValueExtendedProperties singleValueLegacyExtendedProperty collection 一个或多个单值扩展属性的数组。
id String 对于 singleValueExtendedProperties 集合中的每个属性,请指定此参数以标识属性。它必须遵照其中一种支持的格式。有关详细信息,请参阅 Outlook 扩展属性概述。必需。
string 对于 singleValueExtendedProperties 集合中的每个属性,请指定属性值。必需。

请求标头

名称
Authorization Bearer %token%
Content-Type application/json

请求正文

提供每个 singleValueLegacyExtendedProperty 对象在资源实例的 singleValueExtendedProperties 集合属性中的 JSON 正文。

在_新的_资源实例中创建扩展属性时,除了新的 singleValueExtendedProperties 集合,请提供资源实例的 JSON 表示形式(即 邮件mailFolder事件 等)。

响应

响应代码

在新建资源实例中成功创建扩展属性的操作返回 201 Created(在新的组帖子中除外),根据所用的方法,该操作可以返回 200 OK202 Accepted

在现有的资源实例中,成功的创建操作返回 200 OK

响应正文

创建扩展属性时,该响应只包括新建或现有的实例,但不包括新的扩展属性。若要查看新创建的扩展属性,请 获取通过扩展属性扩展的实例

通过回复线程或帖子在_新建_组帖子中创建扩展属性时,响应仅包括响应代码,但不包括新帖子或扩展属性。

示例

请求 1

第一个示例在相同的 POST 操作中创建一个新事件和一个单值扩展属性。除了通常要包括的新事件的属性,请求正文还包括 singleValueExtendedProperties 集合,该集合包含一个单值扩展属性和以下属性: - id 将属性类型指定为 String、GUID 和名为 Fun 的属性。 - valueFood 指定为 Fun 属性的值。

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

成功的响应由 HTTP 201 Created 响应代码表示,并在响应正文中包括新事件,类似于 仅创建事件 中的响应。该响应不包括任何新建的扩展属性。

若要查看新建的扩展属性,请 获取通过扩展属性扩展的事件


请求 2

第二个示例为指定的现有邮件创建一个单值扩展属性。扩展属性是 singleValueExtendedProperties 数组中的唯一元素。请求正文包括扩展属性的以下参数: - id 将属性类型指定为 String、GUID 和名为 Color 的属性。 - valueGreen 指定为 Color 属性的值。

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

成功的响应由 HTTP 200 OK 响应代码表示,并在响应正文中包括指定的邮件,类似于 更新邮件 中的响应。该响应不包括新建的扩展属性。

若要查看新建的扩展属性,请 获取通过扩展属性扩展的邮件