Compartir a través de


Crear sesión

Espacio de nombres: microsoft.graph

Cree una nueva sesión de libro.

Se puede llamar a las API de Excel de dos modos:

  1. Sesión persistente - Todos los cambios realizados en el libro son persistentes (se guardan). Este es el modo de operación habitual.
  2. Sesión no persistente - Los cambios realizados por la API no se guardan en la ubicación de origen. En su lugar, el servidor backend de Excel conserva una copia temporal del archivo que refleja los cambios realizados durante esa sesión API en concreto. Cuando expira la sesión de Excel, se pierden los cambios. Este modo es útil para aplicaciones que necesitan realizar análisis u obtener los resultados de un cálculo o una imagen de gráfico, pero no afecta al estado de documento.

Para representar la sesión en la API, utilice el encabezado workbook-session-id: {session-id}.

Nota: El encabezado de sesión no es necesario para que funcione una API de Excel. Sin embargo, recomendamos que utilice el encabezado de sesión para mejorar el rendimiento. Si no utiliza un encabezado de sesión, los cambios realizados durante la llamada API persisten en el archivo.

En algunos casos, la creación de una nueva sesión requiere un tiempo indeterminado para completarse. Microsoft Graph también proporciona un patrón de operaciones de larga duración. Este patrón proporciona una manera de sondear las actualizaciones de estado de creación, sin esperar a que se complete la creación. Estos son los pasos siguientes:

  1. Se Prefer: respond-async agrega un encabezado a la solicitud para indicar que se trata de una operación de larga duración.
  2. La respuesta devuelve un Location encabezado para especificar la dirección URL para sondear el estado de la operación de creación. Puede obtener el estado de la operación accediendo a la dirección URL especificada. El estado será uno de los siguientes: notStarted, running, succeededo failed.
  3. Una vez completada la operación, puede volver a solicitar el estado y la respuesta mostrará o succeededfailed.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet

Control de errores

En ocasiones, esta solicitud puede recibir el error HTTP 504. La respuesta adecuada a este error es repetir la solicitud.

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) Files.ReadWrite No disponible.
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación No admitida. No admitida.

Solicitud HTTP

POST /me/drive/items/{id}/workbook/createSession
POST /me/drive/root:/{item-path}:/workbook/createSession

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione una representación JSON del objeto WorkbookSessionInfo.

Respuesta

Si se ejecuta correctamente, este método devuelve un 201 Created código de respuesta y un objeto workbookSessionInfo en el cuerpo de la respuesta. Para una operación de larga duración, devuelve un 202 Accepted código de respuesta y un Location encabezado con un cuerpo vacío en la respuesta.

Ejemplos

Ejemplo 1: Creación de sesiones con patrón de operación de ejecución prolongada

Solicitud

POST https://graph.microsoft.com/beta/me/drive/items/{drive-item-id}/workbook/createSession
Prefer: respond-async
Content-type: application/json

{
    "persistChanges": true
}

Respuesta

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

HTTP/1.1 202 Accepted
Location: https://graph.microsoft.com/v1.0/me/drive/items/{drive-item-id}/workbook/operations/{operation-id}
Content-type: application/json

{
}

Con la 202 Accepted respuesta, consulte Trabajar con API que tardan mucho tiempo en completarse para obtener información sobre cómo recuperar el estado de la operación y obtener el resultado de creación de la sesión.

Ejemplo 2: Creación de sesión básica

Solicitud

POST https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/createSession
Content-type: application/json

{
  "persistChanges": true
}

Respuesta

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

HTTP/1.1 201 Created
Content-type: application/json

{
  "id": "id-value",
  "persistChanges": true
}