multiValueLegacyExtendedProperty を取得するGet multiValueLegacyExtendedProperty

$expand を使用して、複数値の拡張プロパティを含むリソース インスタンスを取得します。Get a resource instance that contains a multi-value extended property by using $expand.

クエリ パラメーター $expand を使用すると、指示された拡張プロパティで展開された特定のインスタンスを取得できます。Using the query parameter $expand allows you to get the specified instance expanded with the indicated extended property. これは、現時点で、拡張プロパティを表す multiValueLegacyExtendedProperty オブジェクトを取得する唯一の方法です。This is currently the only way to get the multiValueLegacyExtendedProperty object that represents an extended property.

次のユーザー リソースがサポートされます。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 getting the extended property from 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.ReadCalendars.Read Calendars.ReadCalendars.Read Calendars.ReadCalendars.Read
連絡先contact Contacts.ReadContacts.Read Contacts.ReadContacts.Read Contacts.ReadContacts.Read
contactFoldercontactFolder Contacts.ReadContacts.Read Contacts.ReadContacts.Read Contacts.ReadContacts.Read
eventevent Calendars.ReadCalendars.Read Calendars.ReadCalendars.Read Calendars.ReadCalendars.Read
グループ calendargroup calendar Group.Read.AllGroup.Read.All サポート対象外Not supported 非サポートNot supported
グループ eventgroup event Group.Read.AllGroup.Read.All サポート対象外Not supported 非サポートNot supported
グループ postgroup post Group.Read.AllGroup.Read.All サポート対象外Not supported Group.Read.AllGroup.Read.All
mailFoldermailFolder Mail.ReadMail.Read Mail.ReadMail.Read Mail.ReadMail.Read
messagemessage Mail.ReadMail.Read Mail.ReadMail.Read Mail.ReadMail.Read

HTTP 要求HTTP request

id プロパティに対するフィルターと一致する拡張プロパティで展開された、リソース インスタンスを取得します。フィルター文字列内のスペース文字に URL エンコードを適用していることを確認してください。Get a resource instance expanded with the extended property which matches a filter on the id property. Make sure you apply URL encoding to the space characters in the filter string.

message インスタンスの取得:Get a message instance:

GET /me/messages/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/messages/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /me/mailFolders/{id}/messages/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')

mailFolder インスタンスの取得:Get a mailFolder instance:

GET /me/mailFolders/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/mailFolders/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')

event インスタンスの取得:Get an event instance:

GET /me/events/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/events/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')

calendar インスタンスの取得:Get a calendar instance:

GET /me/calendars/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/calendars/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')

contact インスタンスの取得:Get a contact instance:

GET /me/contacts/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/contacts/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /me/contactFolders/{id}/contacts/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/contactFolders/{id}/contacts/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')

contactFolder インスタンスの取得:Get a contactFolder instance:

GET /me/contactfolders/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/contactFolders/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')

グループ event インスタンスの取得:Get a group event instance:

GET /groups/{id}/events/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')

グループ post インスタンスの取得:Get a group post instance:

GET /groups/{id}/threads/{id}/posts/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /groups/{id}/conversations/{id}/threads/{id}/posts/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')

パス パラメーターPath parameters

パラメーターParameter Type 説明Description
id_valueid_value StringString 照合する拡張プロパティの ID。サポートされている形式のいずれかに従う必要があります。詳しくは、「Outlook の拡張プロパティの概要」を参照してください。必須。The ID of the extended property to match. It must follow one of the supported formats. See Outlook extended properties overview for more information. Required.

要求ヘッダーRequest headers

名前Name 説明Description
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.

要求本文Request body

このメソッドには、要求本文を指定しません。Do not supply a request body for this method.

応答Response

成功した場合、このメソッドは 200 OK 応答コードを返します。If successful, this method returns a 200 OK response code.

応答本文には、一致する multiValueLegacyExtendedProperty オブジェクトで展開された、要求したリソース インスタンスで表されるオブジェクトが含まれます。The response body includes an object representing the requested resource instance, expanded with the matching multiValueLegacyExtendedProperty object.

Example

要求Request

この例では、複数値の拡張プロパティを含めることで指定されたイベントを取得して展開します。フィルターは、id が文字列 StringArray {66f5a359-4659-4830-9070-00050ec6ac6e} Name Recreation と一致する拡張プロパティを返します (ここでは、読みやすくするため URL エンコードを削除しています)。This example gets and expands the specified event by including a multi-value extended property. The filter returns the extended property that has its id matching the string StringArray {66f5a359-4659-4830-9070-00050ec6ac6e} Name Recreation (with URL encoding removed here for ease of reading).

GET https://graph.microsoft.com/v1.0/me/events('AAMkAGE1M2_bs88AACbuFiiAAA=')?$expand=multiValueExtendedProperties($filter=id%20eq%20'StringArray%20{66f5a359-4659-4830-9070-00050ec6ac6e}%20Name%20Recreation')
応答Response

応答本文には、指定されたイベントのすべてのプロパティと、フィルターから返される拡張プロパティが含まれています。The response body includes all the properties of the specified event and extended property returned from the filter.

注:簡潔にするために、ここに示すイベント オブジェクトは切り詰められています。すべてのプロパティは実際の呼び出しから返されます。Note: The event object shown here is truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json
{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Me/events/$entity",
    "@odata.id": "https://graph.microsoft.com/v1.0/users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/events('AAMkAGE1M2_bs88AACbuFiiAAA=')",
    "@odata.etag": "W/\"mODEKWhc/Um6lA3uPm7PPAAAm8k15A==\"",
    "id": "AAMkAGE1M2_bs88AACbuFiiAAA=",
    "start": {
        "dateTime": "2015-11-26T17:00:00.0000000",
        "timeZone": "UTC"
    },
    "end": {
        "dateTime": "2015-11-30T05:00:00.0000000",
        "timeZone": "UTC"
    },
    "organizer": {
        "emailAddress": {
            "name": "Christine Irwin",
            "address": "christine@contoso.com"
        }
    },
    "multiValueExtendedProperties@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Me/events('AAMkAGE1M2_bs88AACbuFiiAAA%3D')/multiValueExtendedProperties",
    "multiValueExtendedProperties": [
        {
            "id": "StringArray {66f5a359-4659-4830-9070-00050ec6ac6e} Name Recreation",
            "value": [
                "Food",
                "Hiking",
                "Swimming"
            ]
        }
    ]
}