Obtener eventoGet event

Importante

Las API de /beta la versión de Microsoft Graph están sujetas a cambios.APIs under the /beta version in Microsoft Graph are subject to change. No se admite el uso de estas API en aplicaciones de producción.Use of these APIs in production applications is not supported.

Obtenga las propiedades y relaciones del objeto event especificado.Get the properties and relationships of the specified event object.

Hay dos posibles escenarios donde una aplicación puede obtener un evento en el calendario de otro usuario:There are two scenarios where an app can get an event in another user's calendar:

  • Si la aplicación tiene permisos de aplicación, o bien,If the app has application permissions, or,
  • Si la aplicación tiene los correspondientes permisos delegados de un usuario y otro usuario ha compartido un calendario con ese usuario, o bien, le ha concedido acceso delegado a ese usuario.If the app has the appropriate delegated permissions from one user, and another user has shared a calendar with that user, or, has given delegated access to that user. Vea detalles y un ejemplo.See details and an example.

Dado que el recurso event admite extensiones, también puede utilizar la operación GET para obtener propiedades personalizadas y datos de extensión en una instancia event.Since the event resource supports extensions, you can also use the GET operation to get custom properties and extension data in an event instance.

Compatibilidad con varias zonas horariasSupport various time zones

Para todas las operaciones GET que devuelven eventos, puede usar el encabezado Prefer: outlook.timezone para especificar la zona horaria de las horas de inicio y finalización del evento en la respuesta.For all GET operations that return events, you can use the Prefer: outlook.timezone header to specify the time zone for the event start and end times in the response.

Por ejemplo, el siguiente encabezado Prefer: outlook.timezone establece las horas de inicio y finalización en la respuesta en la hora estándar del Este.For example, the following Prefer: outlook.timezone header sets the start and end times in the response to Eastern Standard Time.

Prefer: outlook.timezone="Eastern Standard Time"

Si el evento se ha creado en una zona horaria diferente, las horas de inicio y finalización se ajustarán a la zona horaria especificada en ese encabezado Prefer. Consulte esta lista para ver los nombres de zona horaria admitidos. Si no se especifica el encabezado Prefer: outlook.timezone, se devuelven las horas de inicio y finalización en hora UTC.If the event was created in a different time zone, the start and end times will be adjusted to the time zone specified in that Prefer header. See this list for the supported time zone names. If the Prefer: outlook.timezone header is not specified, the start and end times are returned in UTC.

Puede usar las propiedades OriginalStartTimeZone y OriginalEndTimeZone del recurso event para averiguar la zona horaria usada al crear el evento.You can use the OriginalStartTimeZone and OriginalEndTimeZone properties on the event resource to find out the time zone used when the event was created.

PermisosPermissions

Se requiere uno de los siguientes permisos para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, vea Permisos.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Tipo de permisoPermission type Permisos (de menos a más privilegiados)Permissions (from least to most privileged)
Delegado (cuenta profesional o educativa)Delegated (work or school account) Calendars.ReadCalendars.Read
Delegado (cuenta personal de Microsoft)Delegated (personal Microsoft account) Calendars.ReadCalendars.Read
AplicaciónApplication Calendars.ReadCalendars.Read

Solicitud HTTPHTTP request

GET /me/events/{id}
GET /users/{id | userPrincipalName}/events/{id}
GET /groups/{id}/events/{id}

GET /me/calendar/events/{id}
GET /users/{id | userPrincipalName}/calendar/events/{id}
GET /groups/{id}/calendar/events/{id}

GET /me/calendars/{id}/events/{id}
GET /users/{id | userPrincipalName}/calendars/{id}/events/{id}

GET /me/calendargroup/calendars/{id}/events/{id}
GET /users/{id | userPrincipalName}/calendargroup/calendars/{id}/events/{id}

GET /me/calendargroups/{id}/calendars/{id}/events/{id}
GET /users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}

Parámetros de consulta opcionalesOptional query parameters

Este método admite los parámetros de consulta de OData a modo de ayuda para personalizar la respuesta.This method supports the OData Query Parameters to help customize the response.

Encabezados de solicitudRequest headers

NombreName TipoType DescripciónDescription
AuthorizationAuthorization cadenastring {token} de portador. Obligatorio.Bearer {token}. Required.
Prefer: outlook.timezonePrefer: outlook.timezone stringstring Se usa para especificar la zona horaria de las horas de inicio y final de la respuesta.Use this to specify the time zone for start and end times in the response. Si no se especifican, estos valores de hora se devuelven en UTC.If not specified, those time values are returned in UTC. Opcional.Optional.
Prefer: outlook.body-content-typePrefer: outlook.body-content-type stringstring Formato de la propiedad body que se devolverá.The format of the body property to be returned in. Los valores pueden ser "text" o "html".Values can be "text" or "html". Se devuelve un encabezado Preference-Applied como confirmación si se especifica este encabezado Prefer.A Preference-Applied header is returned as confirmation if this Prefer header is specified. Si no se especifica el encabezado, la propiedad body se devuelve en formato HTML.If the header is not specified, the body property is returned in HTML format. Opcional.Optional.

Cuerpo de solicitudRequest body

No proporcione un cuerpo de solicitud para este método.Do not supply a request body for this method.

RespuestaResponse

Si se ejecuta correctamente, este método devuelve un código de respuesta 200 OK y el objeto event en el cuerpo de la respuesta.If successful, this method returns a 200 OK response code and event object in the response body.

EjemploExample

Solicitud 1Request 1

El primer ejemplo obtiene el evento especificado. Especifica lo siguiente:The first example gets the specified event. It specifies the following:

  • Un encabezado Prefer: outlook.timezone para obtener valores de fecha y hora devueltos en la hora estándar del Pacífico.A Prefer: outlook.timezone header to get date time values returned in Pacific Standard Time.
  • Un parámetro de consulta $select para devolver propiedades específicas. Sin ningún parámetro $select, se devolverán todas las propiedades de evento.A $select query parameter to return specific properties. Without a $select parameter, all of the event properties will be returned.

La solicitud no especifica ningún encabezado Prefer: outlook.body-content-type para indicar un formato específico para el cuerpo del evento devuelto.The request does not specify any Prefer: outlook.body-content-type header to indicate a specific format for the returned event body.

GET https://graph.microsoft.com/beta/me/events/AAMkAGIAAAoZDOFAAA=/?$select=subject,body,bodyPreview,organizer,attendees,start,end,location 
Prefer: outlook.timezone="Pacific Standard Time"
Respuesta 1Response 1

Aquí tiene un ejemplo de la respuesta.Here is an example of the response. Como no se especificó ningún encabezado Prefer: outlook.body-content-type, se devuelve la propiedad body en el formato HTML predeterminado.Because no Prefer: outlook.body-content-type header was specified, the body property is returned in the default HTML format.

HTTP/1.1 200 OK
Content-type: application/json
Preference-Applied: outlook.timezone="Pacific Standard Time"
Content-length: 1928

{
    "@odata.context":"https://graph.microsoft.com/beta/$metadata#users('cd209b0b-3f83-4c35-82d2-d88a61820480')/events(subject,body,bodyPreview,organizer,attendees,start,end,location)/$entity",
    "@odata.etag":"W/\"ZlnW4RIAV06KYYwlrfNZvQAAKGWwbw==\"",
    "id":"AAMkAGIAAAoZDOFAAA=",
    "subject":"Orientation ",
    "bodyPreview":"Dana, this is the time you selected for our orientation. Please bring the notes I sent you.",
    "body":{
        "contentType":"html",
        "content":"<html><head></head><body><p>Dana, this is the time you selected for our orientation. Please bring the notes I sent you.</p></body></html>"
    },
    "start":{
        "dateTime":"2017-04-21T10:00:00.0000000",
        "timeZone":"Pacific Standard Time"
    },
    "end":{
        "dateTime":"2017-04-21T12:00:00.0000000",
        "timeZone":"Pacific Standard Time"
    },
    "location": {
        "displayName": "Assembly Hall",
        "locationType": "default",
        "uniqueId": "Assembly Hall",
        "uniqueIdType": "private"
    },
    "locations": [
        {
            "displayName": "Assembly Hall",
            "locationType": "default",
            "uniqueIdType": "unknown"
        }
    ],
    "attendees":[
        {
            "type":"required",
            "status":{
                "response":"none",
                "time":"0001-01-01T00:00:00Z"
            },
            "emailAddress":{
                "name":"Samantha Booth",
                "address":"samanthab@a830edad905084922E17020313.onmicrosoft.com"
            }
        },
        {
            "type":"required",
            "status":{
                "response":"none",
                "time":"0001-01-01T00:00:00Z"
            },
            "emailAddress":{
                "name":"Dana Swope",
                "address":"danas@a830edad905084922E17020313.onmicrosoft.com"
            }
        }
    ],
    "organizer":{
        "emailAddress":{
            "name":"Samantha Booth",
            "address":"samanthab@a830edad905084922E17020313.onmicrosoft.com"
        }
    }
}
Solicitud 2Request 2

En el segundo ejemplo se muestra cómo usar Prefer: outlook.body-content-type="text" un encabezado para obtener la propiedad Body del evento especificado en formato de texto.The second example shows how to use a Prefer: outlook.body-content-type="text" header to get the body property of the specified event in text format.

La solicitud también usa un parámetro de consulta $select para devolver propiedades específicas.The request also uses a $select query parameter to return specific properties. Sin ningún parámetro $select, se devolverán todas las propiedades de evento.Without a $select parameter, all of the event properties will be returned.

GET https://graph.microsoft.com/beta/me/events/AAMkAGI1AAAoZDOFAAA=/?$select=subject,body,bodyPreview
Prefer: outlook.body-content-type="text"
Respuesta 2Response 2

Aquí tiene un ejemplo de la respuesta.Here is an example of the response. Se devuelve la propiedad body en formato de texto.The body property is returned in text format.

HTTP/1.1 200 OK
Content-type: application/json
Preference-Applied: outlook.body-content-type="text"
Content-length: 636

{
    "@odata.context":"https://graph.microsoft.com/beta/$metadata#users('cd209b0b-3f83-4c35-82d2-d88a61820480')/events(subject,body,bodyPreview)/$entity",
    "@odata.etag":"W/\"ZlnW4RIAV06KYYwlrfNZvQAAKGWwbw==\"",
    "id":"AAMkAGI1AAAoZDOFAAA=",
    "subject":"Orientation ",
    "bodyPreview":"Dana, this is the time you selected for our orientation. Please bring the notes I sent you.",
    "body":{
        "contentType":"text",
        "content":"Dana, this is the time you selected for our orientation. Please bring the notes I sent you.\r\n"
    }
}
Solicitud 3Request 3

En el tercer ejemplo se muestra cómo obtener un evento que especifica más de una ubicación.The third example shows getting an event that specifies more than one location. La solicitud especifica un parámetro de consulta $select para devolver propiedades específicas.The request specifies a $select query parameter to return specific properties.

GET https://graph.microsoft.com/beta/me/events/AAMkADAGAADDdm4NAAA=/?$select=subject,body,bodyPreview,organizer,attendees,start,end,location,locations
Respuesta 3Response 3

Este es un ejemplo de la respuesta.Here is an example of the response. La propiedad locations incluye detalles de las tres ubicaciones en las que se organiza el evento.The locations property includes details for the 3 locations that the event is organized for.

Debido a que la solicitud no especifica Prefer: outlook.timezone ningún Prefer: outlook.body-content-type encabezado o, las propiedades Start y End se muestran en la zona horaria UTC predeterminada y el cuerpo está en el formato HTML predeterminado.Because the request does not specify any Prefer: outlook.timezone or Prefer: outlook.body-content-type header, the start and end properties are displayed in the default UTC time zone, and the body is in the default HTML format.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 1992

{
  "@odata.context":"https://graph.microsoft.com/beta/$metadata#users('d1a2fae9-db66-4cc9-8133-2184c77af1b8')/events(subject,body,bodyPreview,organizer,attendees,start,end,location,locations)/$entity",
  "@odata.etag":"W/\"y53lbKh6jkaxHzFwGhgyxgAAw5zhug==\"",
  "id":"AAMkADAGAADDdm4NAAA=",
  "subject":"Plan summer company picnic",
  "bodyPreview":"Let's kick-start this event planning!",
  "body":{
    "contentType":"html",
    "content":"<html>\r\n<head>\r\n</head>\r\n<body>\r\nLet's kick-start this event planning!\r\n</body>\r\n</html>\r\n"
  },
  "start":{
    "dateTime":"2017-08-30T11:00:00.0000000",
    "timeZone":"UTC"
  },
  "end":{
    "dateTime":"2017-08-30T12:00:00.0000000",
    "timeZone":"UTC"
  },
  "location":{
    "displayName":"Conf Room 3; Fourth Coffee; Home Office",
    "locationType":"default",
    "uniqueId":"Conf Room 3; Fourth Coffee; Home Office",
    "uniqueIdType":"private"
  },
  "locations":[
    {
      "displayName":"Conf Room 3",
      "locationType":"default",
      "uniqueIdType":"unknown"
    },
    {
      "displayName":"Fourth Coffee",
      "locationType":"default",
      "uniqueId":"Fourth Coffee",
      "uniqueIdType":"private",
      "address":{
        "type":"unknown",
        "street":"4567 Main St",
        "city":"Redmond",
        "state":"WA",
        "countryOrRegion":"US",
        "postalCode":"32008"
      },
      "coordinates":{
        "latitude":47.672,
        "longitude":-102.103
      }
    },
    {
      "displayName":"Home Office",
      "locationType":"default",
      "uniqueIdType":"unknown"
    }
  ],
  "attendees":[
    {
      "type":"required",
      "status":{
        "response":"none",
        "time":"0001-01-01T00:00:00Z"
      },
      "emailAddress":{
        "name":"Dana Swope",
        "address":"DanaS@contoso.onmicrosoft.com"
      }
    },
    {
      "type":"required",
      "status":{
        "response":"none",
        "time":"0001-01-01T00:00:00Z"
      },
      "emailAddress":{
        "name":"Alex Wilber",
        "address":"AlexW@contoso.onmicrosoft.com"
      }
    }
  ],
  "organizer":{
    "emailAddress":{
      "name":"Adele Vance",
      "address":"AdeleV@contoso.onmicrosoft.com"
    }
  }
}

Vea tambiénSee also