tipo de recurso de evento
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.
Un evento en un calendario de usuario o el calendario predeterminado de un grupo de Microsoft 365.
El número máximo de asistentes incluidos en un event y el número máximo de destinatarios en un eventMessage enviado desde un buzón de Exchange Online es 500. Para más información, consulte Límites de envíos.
Este recurso admite:
- que agregue sus propios datos a las propiedades personalizadas como extensiones.
- que se suscriba a notificaciones de cambios.
- El uso de una consulta delta para realizar un seguimiento de adiciones, eliminaciones y actualizaciones incrementales al proporcionar una función delta.
Nota: Hay algunas diferencias menores en la forma en que puede interactuar con los calendarios de usuario, grupo y sus eventos:
- Solo se pueden organizar los calendarios de usuario en un elemento calendarGroup.
- Puede agregar objetos de datos adjuntos a eventos de calendarios de usuario, pero no a eventos de calendarios de grupo.
- Outlook acepta automáticamente todas las convocatorias de reunión en nombre de grupos. Puede aceptar, aceptar provisionalmente o rechazar solicitudes de reunión solo para calendarios de usuario .
- Outlook no admite los recordatorios para eventos de grupo. Solo puede posponer o descartar un aviso en calendarios de usuario.
Métodos
| Método | Tipo de valor devuelto | Descripción |
|---|---|---|
| List | Colección event | Recupere una lista de los objetos de evento del buzón del usuario. La lista contiene patrones de serie y reuniones de instancia única. |
| Crear | evento | Crea un nuevo evento publicando en la colección de instancias. |
| Get | evento | Lee las propiedades y las relaciones del objeto de evento. |
| Actualizar | evento | Actualiza el mensaje de evento. |
| Eliminar | Ninguno | Elimina el objeto de evento. |
| Eliminar permanentemente | Ninguno | Elimine permanentemente un evento y colóelo en la carpeta Purgas de la carpeta Elementos recuperables del buzón del usuario. |
| Obtener delta | Colección event | Obtenga un conjunto de eventos que se agregaron, eliminaron o actualizaron en un calendarView (un intervalo de eventos) del calendario principal del usuario. |
| Reenviar evento | Ninguno | Permite al organizador o al asistente de un evento de reunión reenviar la solicitud de reunión a un nuevo destinatario. |
| Cancelar evento | Ninguno | Envía un mensaje de cancelación del organizador a todos los asistentes y elimina la reunión especificada. |
| Accept (evento) | Ninguno | Acepta el evento especificado en un calendario de usuario. |
| Aceptar provisionalmente | Ninguno | Acepta provisionalmente el evento especificado en un calendario de usuario. |
| Rechazar evento | Ninguno | Rechaza la invitación al evento especificado en un calendario de usuario. |
| Descartar recordatorio | Ninguno | Descarta el aviso para el evento especificado en un calendario de usuario. |
| Posponer recordatorio | Ninguno | Pospone un aviso para el evento especificado en el calendario del usuario hasta una nueva hora. |
| Enumerar instancias de eventos | Colección event | Obtiene una colección de objetos de evento. |
| Attachments | ||
| Enumerar datos adjuntos | Colección attachment | Obtiene todos los datos adjuntos en un evento. |
| Agregar datos adjuntos | Attachment | Agrega nuevos datos adjuntos a un evento al publicarlos en la colección de datos adjuntos. |
| Extensiones abiertas | ||
| Crear extensión abierta | openTypeExtension | Crea una extensión abierta y agrega propiedades personalizadas en una instancia nueva o un recurso existente. |
| Obtener extensión abierta | Colección openTypeExtension | Obtiene una extensión abierta identificada por el nombre de extensión. |
| Propiedades extendidas | ||
| Crear una propiedad de valor único | evento | Crea una o más propiedades extendidas de valor único en un evento nuevo o existente. |
| Obtener una propiedad de valor único | evento | Obtiene eventos que contienen una propiedad extendida de valor único mediante el uso de $expand o $filter. |
| Creación de una propiedad de varios valores | evento | Crea una o más propiedades extendidas de varios valores en un evento nuevo o existente. |
| Obtención de la propiedad multivalor | evento | Obtiene un evento que contiene una propiedad extendida de varios valores mediante el uso de $expand. |
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| allowNewTimeProposals | Boolean |
true si el organizador de la reunión permite a los invitados proponer una nueva hora al responder; de lo contrario, falsees . Opcional. El valor predeterminado es true. |
| attendees | Colección attendee | La colección de asistentes del evento. |
| body | ItemBody | El cuerpo del mensaje asociado con el evento. Puede mostrarse en formato de texto o HTML. |
| bodyPreview | Cadena | La vista previa del mensaje asociado al evento. Se muestra en formato de texto. |
| cancelledOccurrences | Colección de cadenas | Contiene valores de propiedad occurrenceId de instancias canceladas en una serie periódica, si el evento es el patrón de serie. Las instancias de una serie periódica que se cancelan se denominan cancelledOccurences. Se devuelve solo si se $select en un operación de Obtener que especifica el ID. de un evento de patrón de serie (es decir, el valor de la propiedad seriesMasterId). |
| categories | Colección string | Las categorías asociadas al evento. Cada categoría se corresponde con la propiedad displayName de un elemento outlookCategory definido para el usuario. |
| changeKey | String | Identifica la versión del objeto de evento. Cada vez que cambia el evento, cambia también ChangeKey. Esto permite que Exchange aplique los cambios a la versión correcta del objeto. |
| createdDateTime | DateTimeOffset | El tipo de marca de tiempo representa la información de fecha y hora con el formato ISO 8601 y está siempre en hora UTC. Por ejemplo, la medianoche en la zona horaria UTC del 1 de enero de 2014 sería 2014-01-01T00:00:00Z. |
| end | DateTimeTimeZone | La fecha, la hora y la zona horaria en que finaliza el evento. De manera predeterminada, la hora de finalización está en formato UTC. |
| exceptionOccurrences | Colección event | Contiene los valores de propiedad ID de las instancias de eventos que son excepciones en una serie periódica. Las excepciones pueden diferir de otros sucesos en una serie periódica, como el asunto, las horas de inicio y finalización o los asistentes. Las excepciones no incluyen repeticiones canceladas. Solo se devuelve en $select y $expand en una operación GET que especifica el identificador de un evento maestro de serie (es decir, el valor de la propiedad seriesMasterId ). |
| hasAttachments | Booleano | Se establece como true si el evento tiene datos adjuntos. |
| hideAttendees | Booleano | Cuando se establece en true, cada asistente solo se ve a sí mismo en la convocatoria de reunión y en la lista de Seguimiento de la reunión. El valor predeterminado es false. |
| iCalUId | String | Un identificador único para un evento entre calendarios. Este id. es diferente para cada repetición en una serie periódica. Solo lectura. |
| id | Cadena | Identificador único del evento.
De forma predeterminada, este valor cambia cuando el elemento se mueve de un contenedor (como una carpeta o un calendario) a otro. Para cambiar este comportamiento, use el encabezado Prefer: IdType="ImmutableId". Vea Obtener identificadores inmutables para recursos de Outlook para obtener más información. Distingue mayúsculas de minúsculas y de solo lectura. |
| importance | String | Importancia del evento. Los valores posibles son: low, normal y high. |
| isAllDay | Booleano | Se establece como true si el evento dura todo el día. Si es el valor es true, independientemente de si se trata de un evento de un día o de varios días, la hora de inicio y de finalización debe establecerse en medianoche y debe ser de la misma zona horaria. |
| isCancelled | Booleano | Se establece como true si el evento ha sido cancelado. |
| isDraft | Booleano | Establezca en true si el usuario ha actualizado la reunión en Outlook, pero no ha enviado las actualizaciones a los asistentes. Se establece como false si se han enviado todos los cambios, o si el evento es una cita sin asistentes. |
| IsOnlineMeeting | Boolean |
True si este evento tiene la información de la reunión en línea (es decir, onlineMeeting señala a un recurso onlineMeetingInfo), false en caso contrario. El valor predeterminado es false (onlineMeeting es null). Opcional. Una vez que haya establecido isOnlineMeeting como true, Microsoft Graph inicializará onlineMeeting. A continuación, Outlook omite los cambios adicionales en isOnlineMeeting y la reunión permanece disponible en línea. |
| isOrganizer | Booleano | Se establece en true si el propietario del calendario (especificado por la propiedad owner de calendar) es el organizador del evento (especificado por la propiedad organizer del event). Esto también se aplica si un delegado organizó el evento en nombre del propietario. |
| isReminderOn | Booleano | Se establece como true si se crea una alerta para recordarle el evento al usuario. |
| lastModifiedDateTime | DateTimeOffset | El tipo de marca de tiempo representa la información de fecha y hora con el formato ISO 8601 y está siempre en hora UTC. Por ejemplo, la medianoche en la zona horaria UTC del 1 de enero de 2014 sería 2014-01-01T00:00:00Z. |
| location | Location | La ubicación del evento. |
| locations | Colección location | Ubicaciones donde se celebra el evento o en las que se asiste. Las propiedades location y locations siempre se corresponden entre sí. Si se actualiza la propiedad location, se eliminarían las ubicaciones anteriores de la colección locations y se reemplazarían por el nuevo valor de location. |
| occurrenceId | Cadena | Un identificador para un suceso en una serie de eventos periódica. Null si el evento no forma parte de una serie periódica. El formato del valor de la propiedad es OID. {seriesMasterId-value}.{occurrence-start-date}. La zona horaria de {occurrence-start-date} es la propiedad recurrenceTimeZone definida para la recurrenceRange correspondiente. Esta propiedad puede identificar cualquier aparición en una serie periódica, incluida una aparición que se ha modificado o cancelado. Esta propiedad se puede usar para realizar todas las operaciones admitidas por apariciones de la serie periódica. |
| onlineMeeting | OnlineMeetingInfo | Detalles para que un asistente participe en la reunión en línea. El valor predeterminado es null. Solo lectura. Una vez que haya establecido las propiedades de isOnlineMeeting y onlineMeetingProvider para habilitar una reunión en línea, Microsoft Graph inicializará onlineMeeting. Cuando se establece, la reunión permanece disponible en línea y no se pueden cambiar las propiedades isOnlineMeeting, onlineMeetingProvider y onlneMeeting de nuevo. |
| onlineMeetingProvider | onlineMeetingProviderType | Representa el proveedor de servicios de reuniones en línea. De forma predeterminada, onlineMeetingProvider es unknown. Los valores posibles son unknown, teamsForBusiness, skypeForBusiness y skypeForConsumer. Opcional. Una vez que haya establecido onlineMeetingProvider, Microsoft Graph inicializará onlineMeeting. Posteriormente, no se puede volver a cambiar onlineMeetingProvider y la reunión permanece disponible en línea. |
| onlineMeetingUrl | String | Una dirección URL para una reunión en línea. Solo se establece la propiedad cuando el organizador especifica en Outlook un evento como reunión en línea (por ejemplo, Skype). Solo lectura. Para tener acceso a la dirección URL y unirse a una reunión en línea, use joinUrl que se muestra a través de la propiedad onlineMeeting del evento. En el futuro, la propiedad onlineMeetingUrl será retirada. |
| organizer | Recipient | El organizador del evento. |
| originalEndTimeZone | Cadena | Zona horaria de finalización que se estableció cuando se creó el evento. Un valor de tzone://Microsoft/Custom indica que se ha establecido una zona horaria heredada en el cliente de escritorio de Outlook. |
| originalStart | DateTimeOffset | Representa la hora de inicio de un evento cuando se crea inicialmente como una repetición o una excepción en una serie periódica. Esta propiedad no se devuelve para los eventos que son instancias únicas. Su información de fecha y hora se expresa en formato ISO 8601 y siempre está en hora UTC. Por ejemplo, la medianoche en la zona horaria UTC del 1 de enero de 2014 sería 2014-01-01T00:00:00Z. |
| originalStartTimeZone | Cadena | La zona horaria de inicio que se estableció cuando se creó el evento. Un valor de tzone://Microsoft/Custom indica que se ha establecido una zona horaria legado en el cliente de escritorio de Outlook. |
| recurrence | PatternedRecurrence | El patrón de periodicidad del evento. |
| reminderMinutesBeforeStart | Int32 | El número de minutos antes de la hora de inicio del evento en que se producirá la alerta del recordatorio. |
| responseRequested | Boolean | El valor predeterminado es verdadero. Esto indica que el organizador quiere que un invitado envíe una respuesta al evento. |
| responseStatus | ResponseStatus | Indica el tipo de respuesta que se envía en respuesta a un mensaje de evento. |
| confidencialidad | String | Los valores posibles son: normal, personal, private y confidential. |
| seriesMasterId | Cadena | Identificador del elemento de patrón de serie periódica, si el evento forma parte de una serie periódica. |
| showAs | String | El estado que se mostrará. Los valores posibles son: free, tentative, busy, oof, workingElsewhere, unknown. |
| start | DateTimeTimeZone | La fecha de inicio, la hora y la zona horaria del evento. De manera predeterminada, la hora de inicio está en formato UTC. |
| subject | String | El texto de la línea de asunto del evento. |
| transactionId | String | Identificador personalizado especificado por una aplicación cliente para que el servidor evite operaciones POST redundantes si el cliente vuelve a intentar crear el mismo evento. Esto es útil cuando la conectividad de red baja hace que el cliente agote el tiempo de espera antes de recibir una respuesta del servidor para la solicitud previa de creación de eventos del cliente. Después de establecer transactionId al crear un evento, no puede cambiar transactionId en una actualización posterior. Esta propiedad se devuelve solo en una carga de respuesta si una aplicación la ha configurado. Opcional. |
| type | String | El tipo de evento. Los valores posibles son: singleInstance, occurrence, exception y seriesMaster. Solo lectura |
| uid | Cadena | Identificador único para eventos de calendario. En el caso de los eventos periódicos, el valor es el mismo para el patrón de la serie y para todas sus repeticiones, incluidas las excepciones. |
| webLink | Cadena | Dirección URL para abrir el evento en Outlook en la web. Outlook en la web abre el evento en el explorador si ha iniciado sesión en el buzón. En caso contrario, Outlook en la Web le pedirá que inicie sesión. No se puede acceder a esta dirección URL desde dentro de un iFrame. |
Nota:
La propiedad webLink especifica una dirección URL que abre el evento solo en versiones anteriores de Outlook en la Web. El formato de la dirección URL es el siguiente, donde {event-id} es el valor codificado de la dirección URL de la propiedad id:
Para cuentas de trabajo o escuela:
https://outlook.office365.com/owa/?itemid={event-id}&exvsurl=1&path=/calendar/itemPara cuentas de Microsoft:
https://outlook.live.com/owa/?itemid={event-id}&exvsurl=1&path=/calendar/item
Para abrir el evento en una versión actual de Outlook en la Web, convierta la dirección URL a uno de los siguientes formatos y use esa URL para abrir el evento:
Para cuentas de trabajo o escuela:
https://outlook.office365.com/calendar/item/{event-id}Para cuentas de Microsoft:
https://outlook.live.com/calendar/item/{event-id}
Relaciones
| Relación | Tipo | Descripción |
|---|---|---|
| attachments | Colección attachment | La colección de datos adjuntos FileAttachment, ItemAttachment y referenceAttachment del evento. Propiedad de navegación. Solo lectura. Admite valores NULL. |
| calendar | Calendar | El calendario que contiene el evento. Propiedad de navegación. Solo lectura. |
| extensions | Colección Extension | La colección de extensiones abiertas definidas para el evento. Admite valores NULL. |
| instances | Colección event | Los suceso de una serie periódica, si el evento es un patrón de serie. Esta propiedad incluye repeticiones que forman parte del patrón de periodicidad y las excepciones que se han modificado. No incluye las repeticiones que se han cancelado de la serie. Propiedad de navegación. Solo lectura. Admite un valor NULL. |
| multiValueExtendedProperties | Colección multiValueLegacyExtendedProperty | La colección de propiedades extendidas de varios valores definidas para el evento. Solo lectura. Admite un valor NULL. |
| singleValueExtendedProperties | Colección singleValueLegacyExtendedProperty | La colección de propiedades extendidas de valor único definidas para el evento. Solo lectura. Admite valores NULL. |
Representación JSON
La siguiente representación JSON muestra el tipo de recurso.
{
"allowNewTimeProposals": "Boolean",
"attendees": [{"@odata.type": "microsoft.graph.attendee"}],
"body": {"@odata.type": "microsoft.graph.itemBody"},
"bodyPreview": "string",
"cancelledOccurrences":["string"],
"categories": ["string"],
"changeKey": "string",
"createdDateTime": "String (timestamp)",
"end": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"exceptionOccurrences":["microsoft.graph.event"],
"hasAttachments": true,
"hideAttendees": false,
"iCalUId": "String",
"id": "string (identifier)",
"importance": "String",
"isAllDay": true,
"isCancelled": true,
"isDraft": false,
"isOnlineMeeting": true,
"isOrganizer": true,
"isReminderOn": true,
"lastModifiedDateTime": "String (timestamp)",
"location": {"@odata.type": "microsoft.graph.location"},
"locations": [{"@odata.type": "microsoft.graph.location"}],
"occurrenceId":"string",
"onlineMeeting": {"@odata.type": "microsoft.graph.onlineMeetingInfo"},
"onlineMeetingProvider": "string",
"onlineMeetingUrl": "string",
"organizer": {"@odata.type": "microsoft.graph.recipient"},
"originalEndTimeZone": "string",
"originalStart": "String (timestamp)",
"originalStartTimeZone": "string",
"recurrence": {"@odata.type": "microsoft.graph.patternedRecurrence"},
"reminderMinutesBeforeStart": 1024,
"responseRequested": true,
"responseStatus": {"@odata.type": "microsoft.graph.responseStatus"},
"sensitivity": "String",
"seriesMasterId": "string",
"showAs": "String",
"start": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"subject": "string",
"type": "String",
"uid": "String",
"webLink": "string",
"attachments": [ { "@odata.type": "microsoft.graph.attachment" } ],
"calendar": { "@odata.type": "microsoft.graph.calendar" },
"extensions": [ { "@odata.type": "microsoft.graph.extension" } ],
"instances": [ { "@odata.type": "microsoft.graph.event" }],
"singleValueExtendedProperties": [ { "@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty" }],
"multiValueExtendedProperties": [ { "@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty" }]
}
Contenido relacionado
- Usar la consulta delta para realizar el seguimiento de los cambios en datos de Microsoft Graph
- Obtener los cambios incrementales de los eventos de una carpeta
- Agregar datos personalizados a los recursos mediante extensiones
- Agregar datos personalizados a los usuarios mediante extensiones abiertas
- Agregar datos personalizados a los grupos mediante extensiones de esquema
- Ejemplo de C# de reuniones masivas
- Ejemplo de Node.js de reuniones masivas