単一値の拡張プロパティを作成する

名前空間: microsoft.graph

リソースの新規または既存のインスタンスに、1 つ以上の単一値の拡張プロパティを作成します。

次のユーザー リソースがサポートされます。

• calendar
• contact
• contactFolder
• event
• mailFolder
• message

次のグループ リソースもサポートされます。

• グループ calendar
• グループ event
• グループ post

オープン拡張機能または拡張プロパティを使用するのに適した状況と、拡張プロパティを指定する方法の詳細については、「拡張プロパティの概要」を参照してください。

アクセス許可

拡張プロパティを作成するリソースと、要求するアクセス許可の種類 (委任またはアプリケーション) に応じて、次の表に示すアクセス許可は、この API の呼び出しに必要な最小限の権限です。 アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

サポートされているリソース	委任 (職場または学校のアカウント)	委任 (個人用 Microsoft アカウント)	アプリケーション
calendar	Calendars.ReadWrite	Calendars.ReadWrite	Calendars.ReadWrite
contact	Contacts.ReadWrite	Contacts.ReadWrite	Contacts.ReadWrite
contactFolder	Contacts.ReadWrite	Contacts.ReadWrite	Contacts.ReadWrite
イベント	Calendars.ReadWrite	Calendars.ReadWrite	Calendars.ReadWrite
グループ calendar	Group.ReadWrite.All	非サポート	非サポート
グループ event	Group.ReadWrite.All	非サポート	非サポート
グループ post	Group.ReadWrite.All	非サポート	非サポート
mailFolder	Mail.ReadWrite	Mail.ReadWrite	Mail.ReadWrite
メッセージ	Mail.ReadWrite	Mail.ReadWrite	Mail.ReadWrite

HTTP 要求

新規または既存のリソースのインスタンスに、拡張プロパティを作成できます。

1 つ以上の拡張プロパティを 新しい リソースのインスタンスに作成するには、インスタンスの作成と同じ 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

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

注 既存のグループ投稿には拡張プロパティを作成できません。

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}

要求ヘッダー

名前	値
Authorization	ベアラー {token}。必須。
Content-Type	application/json

要求本文

リソース インスタンスの singleValueExtendedProperties コレクション プロパティに、各 singleValueLegacyExtendedProperty オブジェクトの JSON 本文を指定します。

プロパティ	種類	説明
singleValueExtendedProperties	singleValueLegacyExtendedProperty コレクション	1 つ以上の単一値を持つ拡張プロパティの配列。
id	String	singleValueExtendedProperties コレクションの各プロパティに対して、これを指定することでプロパティを特定します。サポートされている形式のいずれかに従う必要があります。詳しくは、「Outlook の拡張プロパティの概要」を参照してください。必須。
value	string	singleValueExtendedProperties コレクションの各プロパティについて、プロパティの値を特定します。必須。

新しい リソース インスタンスに拡張プロパティを作成する場合は、新しい singleValueExtendedProperties コレクションのほか、そのリソース インスタンスの JSON 表現を指定します (message、mailFolder、event など)。

応答

応答コード

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

既存のリソース インスタンスに拡張プロパティが正常に作成されると、200 OK が返されます。

応答本文

拡張プロパティを作成する場合、応答には新規または既存のインスタンスのみを含めて、新しい拡張プロパティは含めません。新しく作成された拡張プロパティを表示するには、拡張プロパティを使用して展開されているインスタンスを取得します。

スレッドまたは投稿に返信することで、新しいグループ投稿に拡張プロパティを作成する場合、応答には応答コードのみを含めて、新しい投稿や拡張プロパティは含めません。

例

要求 1

最初の例では、同じ POST 操作で新しいイベントと単一値の拡張プロパティを作成します。新しいイベントに通常含めるプロパティとは別に、1 つの単一値の拡張プロパティを含む singleValueExtendedProperties コレクションを要求の本文に含め、そのプロパティは次のようにします。

• id は、プロパティの型を String (GUID) として指定し、Fun という名前のプロパティとして指定します。
• value は、Food プロパティの値として 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

2 番目の例では、指定した既存のメッセージに 1 つの単一値の拡張プロパティを作成します。拡張プロパティは、singleValueExtendedProperties 配列内の唯一の要素です。要求本文には、拡張プロパティに関する次のものが含まれています。

• id は、プロパティの型を String (GUID) として指定し、Color という名前のプロパティとして指定します。
• value は、Green プロパティの値として 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 応答コードによって正常な応答が示され、応答の本文に指定したメッセージが含まれています。応答には、新しく作成された拡張プロパティは含まれません。

新しく作成された拡張プロパティを表示するには、拡張プロパティを使用して展開されているメッセージを取得します。