Table of contents
TOC
Collapse the table of content
Expand the table of content
Última actualización: 20/06/2018

Crear vínculos de uso compartido en entidades de OneNote

Se aplica a: Cuadernos empresariales en Office 365

Crear un vínculo de uso compartido para compartir un archivo de OneNote con cualquier persona. Puede utilizar esta API para crear, obtener y revocar vínculos de invitado anónimo. Los vínculos de invitado otorgarán permisos de edición o de solo vista sin requerir un inicio de sesión.

GET ../sectiongroups/{sectiongroup-id}/Microsoft.OneNote.Api.GetAnonymousSharingLink

POST ../sectiongroups/{sectiongroup-id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink

DELETE ../sectiongroups/{sectiongroup-id}/Microsoft.OneNote.Api.RevokeAnonymousSharingLink

Los vínculos de uso compartido son compatibles con notebooks personales, de sitio y grupales de Office 365, pero no con notebooks de consumo en OneDrive. En este momento, solo las entidades de grupo de sección son actualmente compatibles.

Crear el URI de la solicitud

Para crear el URI de solicitud, comience con la URL raíz del servicio para su plataforma:

Blocs de notas en OneDrive para la Empresa
https://www.onenote.com/api/v1.0/me/notes/
https://www.onenote.com/api/v1.0/users/{id}/notes/

Blocs de notas del sitio de SharePoint
https://www.onenote.com/api/v1.0/myOrganization/siteCollections/{id}/sites/{id}/notes/

Blocs de notas de grupos unificados
https://www.onenote.com/api/v1.0/myOrganization/groups/{id}/notes/


A continuación, agregue la ruta a la entidad del grupo de sección, seguida de las Funciones de vínculo de uso compartido.

Su URI de solicitud completa se verá más o menos como estos ejemplos:

https://www.onenote.com/api/v1.0/me/notes/sectiongroups/{id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink

https://www.onenote.com/api/v1.0/users/{id}/notes/sectiongroups/{id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink

https://www.onenote.com/api/v1.0/myOrganization/siteCollections/{id}/sites/{id}/notes/sectiongroups/{id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink

https://www.onenote.com/api/v1.0/myOrganization/groups/{id}/notes/sections/{id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink

Obtenga más información sobre service root URL.

Para crear un vínculo anónimo para un grupo de sección, envíe una solicitud GET utilizando el punto final apropiado.

GET ../sectiongroups/{sectiongroup-id}/Microsoft.OneNote.Api.GetAnonymousSharingLink

El parámetro de función accessLevel enum indica el nivel de acceso del vínculo de uso compartido.

Valores del parámetro accessLevel enumEl nivel de acceso del vínculo de uso compartido para crear. Seleccione ver o editar.
VerCrea un vínculo de solo lectura para el elemento.
EditarCrea un vínculo de solo lectura para el elemento

Ejemplo

Solicitud

GET ../api/v1.0/me/notes/sectionGroups/{sectiongroup-id}/Microsoft.OneNote.Api.GetAnonymousSharingLink(accessLevel=Microsoft.OneNote.Api.SharingLinkAccessLevel'View') 
Authorization: Bearer {token}
Content-Type: application/json
Accept: application/json

Respuesta

HTTP/1.1 200 Ok

{
  "@odata.context":"https://www.onenote.com/api/v1.0/$metadata#Edm.String",
  "value":"https://www.contoso.com/_layouts/15/WopiFrame.aspx?folderid=084a6fcc95ab54a678257e1b9cba41e7e&authkey=AXXriBu-O475sT4tfJeJDkA&FixProgId=1"
}

Información de la solicitud y respuesta

La siguiente información se aplica a GET /GetAnonymousSharingLink solicitudes.

Datos de la solicitudDescripción
ProtocoloTodas las solicitudes usan el protocolo HTTPS SSL/TLS.
Encabezado Authorization

Bearer {token}, donde {token} es un token de acceso de OAuth 2.0 válido para la aplicación registrada.

Si falta o no es válido, se produce un error en la solicitud con un código de estado 401. Consulte Autenticar con Azure AD (aplicaciones empresariales).

Ámbito de permisosNotes.ReadWrite o Notes.ReadWrite.All
Datos de la respuestaDescripción
Código de correctoUn código de estado HTTP 200.
Cuerpo de la respuestaUna representación de OData del valor en formato JSON.
ErroresSi se produce un error en la solicitud, la API devuelve errores en el cuerpo de la respuesta.
Encabezado X-CorrelationIdGUID que identifica la solicitud de manera única. Puede usar este valor junto con el valor del encabezado de fecha al trabajar con el soporte técnico de Microsoft para solucionar problemas.

Siga estos pasos para obtener el vínculo existente o crear uno si no existe. El vínculo anónimo se puede usar para ver un archivo de OneNote sin iniciar sesión.

POST ../api/v1.0/me/notes/sectionGroups/{sectiongroup-id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink

En el cuerpo del mensaje, envíe un objeto JSON con el parámetro requerido.

Valores del parámetro accessLevel enumEl nivel de acceso del vínculo de uso compartido para crear. Seleccione ver o editar.
VerCrea un vínculo de solo lectura para el elemento.
EditarCrea un vínculo de solo lectura para el elemento

Ejemplo

Solicitud

POST ../api/v1.0/me/notes/sectionGroups/{sectiongroup-id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink 
Authorization: Bearer {token}
Content-Type: application/json
Accept: application/json

Respuesta

HTTP/1.1 200 Ok

{
  "@odata.context":"https://www.onenote.com/api/v1.0/$metadata#Edm.String",
  "value":"https://www.contoso.com/_layouts/15/WopiFrame.aspx?folderid=084a6fcc95ab54a678257e1b9cba41e7e&authkey=AXXriBu-O475sT4tfJeJDkA&FixProgId=1"
}

Información de la solicitud y respuesta

La siguiente información se aplica a POST /GetOrCreateAnonymousSharingLink solicitudes.

Datos de la solicitudDescripción
ProtocoloTodas las solicitudes usan el protocolo HTTPS SSL/TLS.
Encabezado Authorization

Bearer {token}, donde {token} es un token de acceso de OAuth 2.0 válido para la aplicación registrada.

Si falta o no es válido, se produce un error en la solicitud con un código de estado 401. Consulte Autenticar con Azure AD (aplicaciones empresariales).

Ámbito de permisosNotes.ReadWrite o Notes.ReadWrite.All
Datos de la respuestaDescripción
Código de correctoUn código de estado HTTP 200.
Cuerpo de la respuestaUna representación de OData del valor en formato JSON.
ErroresSi se produce un error en la solicitud, la API devuelve errores en el cuerpo de la respuesta.
Encabezado X-CorrelationIdGUID que identifica la solicitud de manera única. Puede usar este valor junto con el valor del encabezado de fecha al trabajar con el soporte técnico de Microsoft para solucionar problemas.

Siga estos pasos para revocar un vínculo de uso compartido existente para un grupo de sección.

DELETE ../v1.0/me/notes/sectiongroups/{sectiongroup-id}/Microsoft.OneNote.Api.RevokeAnonymousSharingLink

En el cuerpo del mensaje, envíe un objeto JSON con el parámetro requerido.

Valores del parámetro accessLevel enumEl nivel de acceso del vínculo de uso compartido para crear. Seleccione ver o editar.
VerCrea un vínculo de solo lectura para el elemento.
EditarCrea un vínculo de solo lectura para el elemento

Ejemplo

Solicitud

DELETE ../v1.0/me/notes/sectiongroups/{sectiongroup-id}/Microsoft.OneNote.Api.RevokeAnonymousSharingLink
Authorization: Bearer {token}
Accept: application/json

{ 
  “accessLevel”: “view” 
} 

Respuesta

HTTP/1.1 204 No Content

Información de la solicitud y respuesta

La siguiente información se aplica a DELETE /RevokeAnonymousSharingLink solicitudes.

Datos de la solicitudDescripción
ProtocoloTodas las solicitudes usan el protocolo HTTPS SSL/TLS.
Encabezado Authorization

Bearer {token}, donde {token} es un token de acceso de OAuth 2.0 válido para la aplicación registrada.

Si falta o no es válido, se produce un error en la solicitud con un código de estado 401. Consulte Autenticar con Azure AD (aplicaciones empresariales).

Ámbito de permisosNotes.ReadWrite o Notes.ReadWrite.All
Datos de la respuestaDescripción
Código de correctoUn código de estado HTTP 204.
ErroresSi se produce un error en la solicitud, la API devuelve errores en el cuerpo de la respuesta.
Encabezado X-CorrelationIdGUID que identifica la solicitud de manera única. Puede usar este valor junto con el valor del encabezado de fecha al trabajar con el soporte técnico de Microsoft para solucionar problemas.

Activar o desactivar el uso compartido externo para un entorno de SharePoint Online

Administre el uso compartido externo para su entorno de SharePoint Online

Crear la URL raíz del servicio de OneNote

La dirección URL raíz del servicio de OneNote utiliza el siguiente formato para todas las llamadas a la API de OneNote.

https://www.onenote.com/api/{version}/{location}/notes/


El segmento version de la URL representa la versión de la API de OneNote que desea utilizar.

  • Utilice v1.0 para un código de producción estable.
  • Use beta para probar una característica que esté en desarrollo. Las características y funciones pueden cambiar en la versión beta, por lo que le recomendamos que no la use en su código de producción.


El segmento location de la URL representa la ubicación de los blocs de notas a los que desea acceder.

Blocs de notas en OneDrive para la Empresa
Use me para el contenido de OneNote que sea propiedad del usuario actual.

Utilice users/{id} para el contenido de OneNote que el usuario especificado (en la URL) haya compartido con el usuario actual. Use la API de Azure AD Graph para obtener id. de usuario.

Blocs de notas del sitio de SharePoint
Los sitios de grupo y otros sitios de SharePoint pueden contener blocs de notas de OneNote en sus bibliotecas de documentos.

Utilice myOrganization/siteCollections/{id}/sites/{id} para el contenido de OneNote en un sitio de la cuenta empresarial en la que el usuario actual haya iniciado sesión. Solo se admite la cuenta empresarial actual, a la que se accede empleando la palabra clave myOrganization. Descubra cómo obtener id. de sitio.

Blocs de notas de grupo de Office 365
Los grupos de Office 365 son parte de la experiencia conectada de Office 365. Los miembros del grupo pueden compartir blocs de notas, archivos y correos electrónicos.

Utilice myOrganization/groups/{id} para el contenido de OneNote en el grupo especificado del que el usuario actual sea miembro. Los grupos de Office 365 (que devuelven el unified groupType) son el único tipo de grupo admitido. Use la API de Azure AD Graph para obtener id. de usuario.


Utilizar el método FromUrl para obtener la colección y los id. de sitios
Puede usar el método FromUrl para obtener la colección y los id. de sitios para una URL de sitio absoluta y específica. Debe realizar esta llamada solo cuando sea necesario y luego guardar los valores para usarlos en el futuro.

El formato de la URL de sitio depende de su configuración, por ejemplo https://domain.sharepoint.com/site-a o https://domain.com/sites/site-a.

Ejemplo de solicitud:

GET https://www.onenote.com/api/v1.0/myOrganization/siteCollections/FromUrl(url='{full-path-to-SharePoint-site}')
Authorization: Bearer {token}
Accept: application/json

Ejemplo de respuesta:

{
  "@odata.context":"https://www.onenote.com/api/v1.0/$metadata#Microsoft.OneNote.Api.SiteMetadata",
  "siteCollectionId":"09d1a587-a84b-4264-3d15-669429be8cc5",
  "siteId":"d9e4d5c8-683f-4363-89ae-18c4e3da91e9"
}

Requisitos para usar FromUrl y trabajar con blocs de notas del sitio de SharePoint:

  • Solo puede crear blocs de notas de OneNote, grupos de secciones, secciones y páginas en sitios que tengan una biblioteca de documentos predeterminada. (Algunas plantillas de sitio no crean una biblioteca de documentos predeterminada). Sin embargo, las solicitudes GET devuelven contenido de OneNote de todas las bibliotecas de documentos del sitio.
  • La URL raíz del servicio de OneNote es inmutable, lo que significa que no puede usar una ruta de sitio de la API de REST de SharePoint y luego añadirle el punto de conexión notes.
  • El usuario en cuyo nombre está realizando la llamada debe ser miembro del sitio.
  • FromUrl funciona solo con sitios que hayan sido indexados. Puede llevar varias horas indexar un nuevo sitio.

Recursos adicionales

© 2018 Microsoft