Obter singleValueLegacyExtendedProperty
Namespace: microsoft.graph
Você pode acessar uma instância de recurso único expandida com uma propriedade estendida específica ou uma coleção de instâncias de recurso que incluem as propriedades estendidas que correspondem a um filtro.
Usar o parâmetro de consulta $expand permite que você acesse a instância de recurso especificada expandida com uma propriedade estendida específica. Use um $filter e um operador eq na propriedade id para especificar a propriedade estendida. Atualmente, esta é a única maneira de acessar o objeto singleValueLegacyExtendedProperty que representa uma propriedade estendida.
Para acessar instâncias de recurso com determinadas propriedades estendidas, use o parâmetro de consulta $filter e aplique um operador eq na propriedade id. Além disso, em propriedades estendidas numéricas, aplique um dos seguintes operadores na propriedade valor: eq, ne,ge, gt, le ou lt. Para propriedades estendidas de cadeia de caracteres digitados, aplique um operador contains, startswith, eq ou ne em value.
O filtro é aplicado a todas as instâncias do recurso na caixa de correio do usuário conectado.
Maiúsculas e minúsculas são diferenciadas ao filtrar o nome de cadeia de caracteres (Name) na id de uma propriedade estendida. Maiúsculas e minúsculas não são diferenciadas ao filtrar a propriedade value de uma propriedade estendida.
Há suporte para os seguintes recursos de usuário:
Também há suporte para os seguintes recursos de grupo:
Confira Visão geral de propriedades estendidas para saber mais sobre quando usar extensões abertas ou propriedades estendidas e sobre como especificar propriedades estendidas.
Essa API está disponível nas seguintes implantações nacionais de nuvem.
| Serviço global | Governo dos EUA L4 | GOVERNO DOS EUA L5 (DOD) | China operada pela 21Vianet |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
Permissões
Dependendo do recurso do qual você está recebendo a propriedade estendida e do tipo de permissão (delegado ou aplicativo) solicitado, a permissão especificada na tabela a seguir é o mínimo necessário para chamar essa API. Para saber mais, incluindo como escolher permissões, confira Permissões.
| Recurso com suporte | Delegada (conta corporativa ou de estudante) | Delegada (conta pessoal da Microsoft) | Application |
|---|---|---|---|
| calendar | Calendars.Read | Calendars.Read | Calendars.Read |
| contato | Contacts.Read | Contacts.Read | Contacts.Read |
| contactFolder | Contacts.Read | Contacts.Read | Contacts.Read |
| event | Calendars.Read | Calendars.Read | Calendars.Read |
| grupo calendar | Group.Read.All | Sem suporte | Sem suporte |
| grupo event | Group.Read.All | Sem suporte | Sem suporte |
| grupo post | Group.Read.All | Sem suporte | Group.Read.All |
| mailFolder | Mail.Read | Mail.Read | Mail.Read |
| message | Mail.Read | Mail.Read | Mail.Read |
Solicitação HTTP
Instância de recurso GET expandida com uma propriedade estendida que corresponde a um filtro
Obtenha uma instância de recurso expandida com uma propriedade estendida que corresponde a um filtro na propriedade id. Certifique-se de aplicar a codificação de URL aos caracteres de espaço na cadeia de filtro.
Obtenha uma instância de message:
GET /me/messages/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/messages/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
GET /me/mailFolders/{id}/messages/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
Obtenha uma instância de mailFolder:
GET /me/mailFolders/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/mailFolders/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
Obtenha uma instância de event:
GET /me/events/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/events/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
Obtenha uma instância de calendar:
GET /me/calendars/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/calendars/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
Obtenha uma instância de contact:
GET /me/contacts/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/contacts/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
GET /me/contactFolders/{id}/contacts/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/contactFolders/{id}/contacts/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
Obtenha uma instância de contactFolder:
GET /me/contactfolders/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/contactFolders/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
Obtenha uma instância de group event:
GET /groups/{id}/events/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
Acesse uma instância de postar em grupo:
GET /groups/{id}/threads/{id}/posts/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
GET /groups/{id}/conversations/{id}/threads/{id}/posts/{id}?$expand=singleValueExtendedProperties($filter=id eq '{id_value}')
Instâncias de recurso GET que incluem as propriedades estendidas numéricas que correspondem a um filtro.
Acesse as instâncias de um recurso com suporte que têm uma propriedade estendida numérica que corresponde a um filtro. O filtro usa um operador eq na propriedade id e um dos seguintes operadores na propriedade value: eq, ne,ge, gt, le ou lt.
Aplique a codificação de URL aos seguintes caracteres na cadeia de filtro: dois pontos, barra inclinada e espaço.
As linhas de sintaxe a seguir mostram um filtro que usa um operador eq na id e outro operador eq no valor da propriedade. Você pode substituir o operador eq no value por qualquer um dos outros operadores (ne,ge, gt, le ou lt) que se aplicam aos valores numéricos.
Acesse as instâncias de mensagem:
GET /me/messages?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
GET /users/{id|userPrincipalName}/messages?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
GET /me/mailFolders/{id}/messages?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
Acesse as instâncias de mailFolder:
GET /me/mailFolders?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
GET /users/{id|userPrincipalName}/mailFolders?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
Acesse as instâncias de event:
GET /me/events?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
GET /users/{id|userPrincipalName}/events?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
Acesse as instâncias de calendar:
GET /me/calendars?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
GET /users/{id|userPrincipalName}/calendars?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
Acesse as instâncias de contact:
GET /me/contacts?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
GET /users/{id|userPrincipalName}/contacts?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
GET /me/contactFolders/{id}/contacts?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
GET /users/{id|userPrincipalName}/contactFolders/{id}/contacts?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
Acesse as instâncias de contactFolder:
GET /me/contactfolders?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
GET /users/{id|userPrincipalName}/contactFolders?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
Acesse as instâncias de group event:
GET /groups/{id}/events?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
Acesse as instâncias de postar em grupo:
GET /groups/{id}/threads/{id}/posts?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
GET /groups/{id}/conversations/{id}/threads/{id}/posts?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
Instâncias de recurso GET com propriedades estendidas de cadeia de caracteres digitados que correspondem a um filtro
Acesse as instâncias do recurso message ou event que têm uma propriedade estendida de cadeia de caracteres digitados que correspondem a um filtro. O filtro usa um operador eq na propriedade id e um dos seguintes operadores na propriedade valor: contains, startswith, eq ou ne. Aplique a codificação de URL aos seguintes caracteres na cadeia de filtro: dois pontos, barra inclinada e espaço.
Acesse as instâncias de mensagem:
GET /me/messages?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and contains(ep/value, '{property_value}'))
GET /users/{id|userPrincipalName}/messages?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and contains(ep/value, '{property_value}'))
GET /me/mailFolders/{id}/messages?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and contains(ep/value, '{property_value}'))
GET /me/messages?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and startswith(ep/value, '{property_value}'))
GET /users/{id|userPrincipalName}/messages?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and startswith(ep/value, '{property_value}'))
GET /me/mailFolders/{id}/messages?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and startswith(ep/value, '{property_value}'))
GET /me/messages?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
GET /users/{id|userPrincipalName}/messages?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
GET /me/mailFolders/{id}/messages?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
GET /me/messages?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value ne '{property_value}')
GET /users/{id|userPrincipalName}/messages?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value ne '{property_value}')
GET /me/mailFolders/{id}/messages?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value ne '{property_value}')
Acesse as instâncias de event:
GET /me/events?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and contains(ep/value, '{property_value}'))
GET /users/{id|userPrincipalName}/events?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and contains(ep/value, '{property_value}'))
GET /me/events?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and startswith(ep/value, '{property_value}'))
GET /users/{id|userPrincipalName}/events?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and startswith(ep/value, '{property_value}'))
GET /me/events?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
GET /users/{id|userPrincipalName}/events?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
GET /me/events?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value ne '{property_value}')
GET /users/{id|userPrincipalName}/events?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value ne '{property_value}')
Acesse as instâncias de group event:
GET /groups/{id}/events?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and contains(ep/value, '{property_value}'))
GET /groups/{id}/events?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and startswith(ep/value, '{property_value}'))
GET /groups/{id}/events?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value eq '{property_value}')
GET /groups/{id}/events?$filter=singleValueExtendedProperties/Any(ep: ep/id eq '{id_value}' and ep/value ne '{property_value}')
Parâmetros do caminho
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id_value | String | A ID da propriedade estendida a ser correspondida. Deve seguir um dos formatos com suporte. Para saber mais, confira Visão geral das propriedades estendidas do Outlook. Obrigatório. |
| property_value | String | O valor da propriedade estendida a ser correspondida. Obrigatório quando indicado na seção Solicitação HTTP acima. Se {property_value} não for uma cadeia de caracteres, converta o ep/value para o tipo de dado Edm apropriado ao compará-lo com {property_value}. Confira exemplos na solicitação 4 abaixo. |
Cabeçalhos de solicitação
| Nome | Descrição |
|---|---|
| Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
Corpo da solicitação
Não forneça um corpo de solicitação para esse método.
Resposta
Se tiver êxito, este método retornará o código de resposta 200 OK.
Instância de recurso GET expandida com uma propriedade estendida correspondente.
O corpo da resposta inclui um objeto que representa a instância de recurso solicitada, expandida com o objeto singleValueLegacyExtendedProperty correspondente.
Instâncias de recurso GET que contenham uma propriedade estendida correspondente a um filtro
O corpo da resposta inclui um ou mais objetos que representam as instâncias de recursos contendo uma propriedade estendida correspondente. O corpo da resposta não inclui a propriedade estendida.
Exemplo
Solicitação 1
O primeiro exemplo obtém e expande a mensagem especificada, incluindo uma propriedade estendida de valor único. O filtro retorna a propriedade estendida cuja id corresponde à cadeia de caracteres String {66f5a359-4659-4830-9070-00047ec6ac6e} Name Color (com a URL de codificação removida aqui para facilitar a leitura).
GET https://graph.microsoft.com/v1.0/me/messages/AAMkAGE1M2_bs88AACHsLqWAAA=?$expand=singleValueExtendedProperties($filter=id%20eq%20'String%20{66f5a359-4659-4830-9070-00047ec6ac6e}%20Name%20Color')
Resposta 1
O corpo da resposta inclui todas as propriedades da mensagem especificada e a propriedade estendida retornada do filtro.
Observação: O objeto message mostrado aqui está truncado por motivos de concisão. Todas as propriedades serão retornadas de uma chamada real.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Me/messages/$entity",
"@odata.id": "https://graph.microsoft.com/v1.0/users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/messages('AAMkAGE1M2_bs88AACHsLqWAAA=')",
"@odata.etag": "W/\"CQAAABYAAACY4MQpaFz9SbqUDe4+bs88AACbyS4H\"",
"id": "AAMkAGE1M2_bs88AACHsLqWAAA=",
"subject": "RE: Talk about emergency prep",
"sender": {
"emailAddress": {
"name": "Christine Irwin",
"address": "christine@contoso.com"
}
},
"from": null,
"toRecipients": [
{
"emailAddress": {
"name": "Christine Irwin",
"address": "christine@contoso.com"
}
}
],
"singleValueExtendedProperties": [
{
"id": "String {66f5a359-4659-4830-9070-00047ec6ac6e} Name Color",
"value": "Green"
}
]
}
Solicitação 2
O segundo exemplo obtém mensagens que possuem a propriedade estendida de valor único com cadeia de caracteres digitada especificada no filtro. O filtro procura a propriedade estendida com:
id igual à cadeia de caracteres
String {66f5a359-4659-4830-9070-00047ec6ac6e} Name Color(com a URL de codificação aqui removida para facilitar a leitura).O valor igual à cadeia de caracteres
Green.
GET https://graph.microsoft.com/v1.0/me/messages?$filter=singleValueExtendedProperties%2FAny(ep%3A%20ep%2Fid%20eq%20'String%20{66f5a359-4659-4830-9070-00047ec6ac6e}%20Name%20Color'%20and%20ep%2Fvalue%20eq%20'Green')
Resposta 2
Uma resposta bem-sucedida é indicada por um código de resposta HTTP 200 OK, e o corpo da resposta inclui todas as propriedades das mensagens cuja propriedade estendida corresponde ao filtro. O corpo da resposta é semelhante à resposta da obtenção de uma coleção de mensagens. A resposta não inclui a propriedade estendida correspondente.
Solicitação 3
O terceiro exemplo obtém mensagens que possuem a propriedade estendida de valor único com cadeia de caracteres digitada especificada no filtro. O filtro procura a propriedade estendida com:
id igual à cadeia de caracteres
String {66f5a359-4659-4830-9070-00047ec6ac6e} Name Color(com a URL de codificação aqui removida para facilitar a leitura).O value que contém a cadeia de caracteres
green.
GET https://graph.microsoft.com/v1.0/Me/messages?$filter=singleValueExtendedProperties/any(ep:ep/Id eq 'String {66f5a359-4659-4830-9070-00047ec6ac6e} Name Color' and contains(ep/Value, 'green'))
Resposta 3
Uma resposta bem-sucedida é indicada por um código de resposta HTTP 200 OK e o corpo da resposta inclui todas as propriedades das mensagens cuja propriedade estendida corresponde ao filtro. Por exemplo, uma mensagem que tem uma propriedade estendida de valor único com a id igual à cadeia de caracteres String {66f5a359-4659-4830-9070-00047ec6ac6e} Name Colore o valorLight green corresponderia ao filtro e seria incluída na resposta.
O corpo da resposta é semelhante à resposta da obtenção de uma coleção de mensagens. A resposta não inclui a propriedade estendida correspondente.
Solicitação 4
Os próximos dois exemplos mostram como acessar mensagens que possuam propriedades estendidas de valor único sem cadeia de caracteres digitada. Para facilitar a leitura, elas não incluem a codificação de URL necessária.
O exemplo a seguir mostra um filtro que procura a propriedade estendida com:
O id correspondente à cadeia de caracteres
CLSID {00062008-0000-0000-C000-000000000046} Name ConnectorSenderGuid.Sendo o valor o GUID
b9cf8971-7d55-4b73-9ffa-a584611b600b. Para comparar o valor da propriedade com um GUID, converta oep/valueparaEdm.Guid.
GET https://graph.microsoft.com/v1.0/me/messages?$filter=singleValueExtendedProperties/any(ep:ep/id eq 'CLSID {00062008-0000-0000-C000-000000000046} Name ConnectorSenderGuid' and cast(ep/value, Edm.Guid) eq (b9cf8971-7d55-4b73-9ffa-a584611b600b))
O próximo exemplo mostra um filtro que procura a propriedade estendida com:
O id correspondente à cadeia de caracteres
Integer {66f5a359-4659-4830-9070-00047ec6ac6e} Name Pallete.O valor igual inteiro 12. Para comparar o valor da propriedade com um número inteiro, converta o
ep/valueparaEdm.Int32.
GET https://graph.microsoft.com/v1.0/me/messages?$filter=singleValueExtendedProperties/any(ep:ep/id eq 'Integer {66f5a359-4659-4830-9070-00047ec6ac6e} Name Pallete' and cast(ep/value, Edm.Int32) eq 12)
Resposta 4
Para cada um dos dois exemplos anteriores, uma resposta bem-sucedida é indicada por um código de resposta HTTP 200 OK, e o corpo da resposta inclui todas as propriedades das mensagens cuja propriedade estendida corresponde ao filtro. O corpo da resposta é semelhante à resposta da obtenção de uma coleção de mensagens. A resposta não inclui a propriedade estendida correspondente.
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de