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

名前空間: microsoft.graph

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

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

• calendar
• contact
• contactFolder
• event
• mailFolder
• message
• Outlook タスク
• Outlook タスク フォルダー
• todoTask

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

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

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

この API は、次の国内クラウド展開で使用できます。

アクセス許可

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

HTTP 要求

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

1 つ以上の拡張プロパティを新しいリソースのインスタンスに作成するには、インスタンスの作成と同じ REST 要求を使用し、新しいリソース インスタンスのプロパティと拡張プロパティを要求の本文に含めます。 一部のリソースでは、複数の方法で作成がサポートされています。 これらのリソース インスタンスを作成する方法の詳細については、 メッセージ、 mailFolder、 イベント、 予定表、 連絡先、 contactFolder、 Outlook タスク、 Outlook タスク フォルダー、 グループ イベント、 グループ投稿、 todoTask を作成するための対応するトピックを参照してください。

以下に要求の構文を示します。

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 /me/todo/lists/{todoTaskListId}/tasks/{todoTaskId}?$expand=singleValueExtendedProperties($filter=id eq '{singleValueExtendedPropertyId}')
POST /me/todo/lists/{todoTaskListId}/tasks?$expand=singleValueExtendedProperties($filter=id eq '{singleValueExtendedPropertyId}')

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 /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 /me/todo/lists/{todoTaskListId}/tasks?$expand=singleValueExtendedProperties($filter=id eq '{singleValueExtendedPropertyId}')
PATCH /me/todo/lists/{todoTaskListId}/tasks/{todoTaskId}?$expand=singleValueExtendedProperties($filter=id eq '{singleValueExtendedPropertyId}')

PATCH /groups/{id}/events/{id}

要求ヘッダー

要求本文

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

新しいリソース インスタンスで拡張プロパティを作成する場合、新しい singleValueExtendedProperties コレクションに加えて、そのリソース インスタンスの JSON 表現 (つまり、メッセージ、mailFolder、イベント、todoTask など) を指定します。

応答

応答コード

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

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

応答本文

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

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

例

要求 1

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

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

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"
     }
  ]
}

応答 1

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

新しく作成された拡張プロパティを表示するには、拡張プロパティを使用して展開されているイベントを取得します。

要求 2

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

• id は、プロパティの型を String (GUID) として指定し、Color という名前のプロパティとして指定します。
• value は、Green プロパティの値として Color を指定します。

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"
      }
    ]
}

応答 2

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

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