Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
Espacio de nombres: microsoft.graph
Importante
Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.
Precaución
Las tareas de Outlook quedaron en desuso y dejaron de devolver datos el 10 de agosto de 2022. Actualice las aplicaciones existentes que usan esta característica con tareas de Outlook.
Cree una o varias propiedades extendidas de valor único en una instancia nueva o existente de un recurso.
Se admiten los siguientes recursos de usuario:
- calendar
- contact
- contactFolder
- event
- carpeta de buzón
- mailFolder
- message
- Nota
- Tarea de Outlook
- Carpeta de tareas de Outlook
- todoTask
- todoTaskList
Se admiten los siguientes recursos de grupo:
Para obtener más información sobre cuándo usar extensiones abiertas o propiedades extendidas, y cómo especificar propiedades extendidas, vea Información general sobre propiedades extendidas.
Esta API está disponible en las siguientes implementaciones en la nube nacional.
| Servicio global | Administración pública de EE. UU. | Gobierno de EE. UU. L5 (DOD) | China operado por 21Vianet |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
Permissions
Según el recurso en el que esté creando la propiedad extendida y el tipo de permiso (delegado o de aplicación) que solicite, el permiso especificado en la tabla siguiente es el mínimo necesario para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, vea Permisos.
| Recurso admitido | Delegado (cuenta profesional o educativa) | Delegado (cuenta de Microsoft personal) | Aplicación |
|---|---|---|---|
| calendar | Calendars.ReadWrite | Calendars.ReadWrite | Calendars.ReadWrite |
| contact | Contacts.ReadWrite | Contacts.ReadWrite | Contacts.ReadWrite |
| contactFolder | Contacts.ReadWrite | Contacts.ReadWrite | Contacts.ReadWrite |
| evento | Calendars.ReadWrite | Calendars.ReadWrite | Calendars.ReadWrite |
| calendar de grupo | Group.ReadWrite.All | No admitida. | No admitida. |
| evento de grupo | Group.ReadWrite.All | No admitida. | No admitida. |
| post de grupo | Group.ReadWrite.All | No admitida. | No admitida. |
| carpeta de buzón | MailboxFolder.Read | No admitida. | MailboxFolder.Read.All |
| mailFolder | Mail.ReadWrite | Mail.ReadWrite | Mail.ReadWrite |
| mensaje | Mail.ReadWrite | Mail.ReadWrite | Mail.ReadWrite |
| Nota | ShortNotes.ReadWrite | ShortNotes.ReadWrite | ShortNotes.ReadWrite |
| Tarea de Outlook | Tasks.ReadWrite | Tasks.ReadWrite | No admitida. |
| Carpeta de tareas de Outlook | Tasks.ReadWrite | Tasks.ReadWrite | No admitida. |
| todoTask | Tasks.ReadWrite | No admitida. | No admitida. |
| todoTaskList | Tasks.ReadWrite | No admitida. | No admitida. |
Solicitud HTTP
Puede crear propiedades extendidas en una instancia de recurso nueva o existente.
Para crear una o varias propiedades extendidas en una instancia de recurso nueva, use la misma solicitud de REST que al crear la instancia e incluya las propiedades de la nueva instancia de recurso y de la propiedad extendida en el cuerpo de la solicitud. Algunos recursos admiten la creación de más de una manera. Para obtener más información sobre cómo crear estas instancias de recursos, consulte los temas correspondientes para crear un mensaje, mailFolder, event, calendar, contact, contactFolder, mailboxFolder, tarea de Outlook, carpeta de tareas de Outlook, evento de grupo, publicación de grupo y todoTask.
A continuación tiene la sintaxis de las solicitudes.
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 /admin/exchange/mailboxes/{mailboxId}/folders
POST /me/notes
POST /users/{id|userPrincipalName}/notes
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 /me/todo/lists?$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
Nota:
Para llamar al punto de conexión /me, se requiere un usuario con la sesión iniciada y, por lo tanto, un permiso delegado. Los permisos de aplicación no se admiten al usar el /me punto de conexión.
Para crear una o varias propiedades extendidas en una instancia de recurso existente, especifique la instancia en la solicitud e incluya la propiedad extendida en el cuerpo de la solicitud.
Nota No se puede crear una propiedad extendida en una publicación de grupo existente.
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 /admin/exchange/mailboxes/{mailboxId}/folders/{mailboxFolderId}
PATCH /me/notes/{id}
PATCH /users/{id|userPrincipalName}/notes/{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 /me/todo/lists/{todoTaskListId}?$expand=singleValueExtendedProperties($filter=id eq '{singleValueExtendedPropertyId}')
PATCH /groups/{id}/events/{id}
Nota:
Para llamar al punto de conexión /me, se requiere un usuario con la sesión iniciada y, por lo tanto, un permiso delegado. Los permisos de aplicación no se admiten al usar el /me punto de conexión.
Encabezados de solicitud
| Nombre | Valor |
|---|---|
| Authorization | {token} de portador. Obligatorio. Obtenga más información sobre autenticación y autorización. |
| Content-Type | application/json |
Cuerpo de la solicitud
Proporcione un cuerpo JSON para cada objeto singleValueLegacyExtendedProperty en la propiedad de la colección singleValueExtendedProperties de la instancia de recurso.
| Propiedad | Tipo | Descripción |
|---|---|---|
| singleValueExtendedProperties | Colección singleValueLegacyExtendedProperty | Una matriz de una o varias propiedades extendidas de valor único. |
| id | String | Para cada propiedad de la colección singleValueExtendedProperties, especifique esto para identificar la propiedad. Debe tener uno de los formatos compatibles. Para obtener más información, vea Información general sobre las propiedades extendidas. Obligatorio. |
| value | string | Para cada propiedad de la colección singleValueExtendedProperties, especifique el valor de la propiedad. Obligatorio. |
Al crear una propiedad extendida en una nueva instancia de recursos, además de la nueva colección singleValueExtendedProperties , proporcione una representación JSON de esa instancia de recurso (es decir, un mensaje, una carpeta de correo, un evento, todoTask, etc.)
Respuesta
Código de respuesta
Una operación que crea correctamente una propiedad extendida en una nueva instancia de recursos devuelve un código de 201 Created respuesta. En el caso de una nueva publicación de grupo, dependiendo del método utilizado, la operación devuelve un código de respuesta o a 200 OK202 Accepted .
En una instancia de recurso existente, una operación que se ejecuta correctamente devuelve 200 OK.
Cuerpo de la respuesta
Cuando se crea una propiedad extendida, la respuesta incluye solo la instancia nueva o existente, pero no la nueva propiedad extendida. Para ver la propiedad extendida recién creada, expanda la instancia con la propiedad extendida.
Cuando crea una propiedad extendida en una nuevapublicación grupal respondiendo a un hilo o publicación, la respuesta incluye solo un código de respuesta, pero no la nueva publicación ni la propiedad extendida.
Ejemplos
Solicitud 1
El primer ejemplo crea un evento nuevo y una propiedad extendida de valor único en la misma operación POST. Aparte de las propiedades que normalmente incluiría en un nuevo evento, el cuerpo de la solicitud incluye la colección singleValueExtendedProperties que contiene una propiedad extendida de valor único y lo siguiente para la propiedad:
-
id especifica el tipo de propiedad como
String, el GUID y la propiedad denominadaFun. -
value especifica
Foodcomo el valor de la propiedadFun.
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"
}
]
}
Respuesta 1
Una respuesta correcta se indica mediante un HTTP 201 Created código de respuesta e incluye el nuevo evento en el cuerpo de la respuesta, de forma similar a la respuesta de crear solo un evento.
La respuesta no incluye ninguna propiedad extendida recién creada.
Para ver la propiedad extendida recién creada, expanda el evento con la propiedad extendida.
Solicitud 2
El segundo ejemplo crea una propiedad extendida de valor único para el mensaje existente especificado. La propiedad extendida es el único elemento de la matriz singleValueExtendedProperties. El cuerpo de la solicitud incluye lo siguiente para la propiedad extendida:
-
id especifica el tipo de propiedad como
String, el GUID y la propiedad denominadaColor. -
value especifica
Greencomo el valor de la propiedadColor.
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"
}
]
}
Respuesta 2
Una respuesta correcta se indica mediante un HTTP 200 OK código de respuesta e incluye el mensaje especificado en el cuerpo de la respuesta, de forma similar a la respuesta de la actualización de un mensaje. La respuesta no incluye la propiedad extendida recién creada.
Para ver la propiedad extendida recién creada, expanda el mensaje con la propiedad extendida.