listItem: createLink

  • Artículo

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.

Cree un vínculo de uso compartido para un elemento listItem.

La acción createLink crea un nuevo vínculo de uso compartido si el tipo de vínculo especificado aún no existe para la aplicación que realiza la llamada. Si ya existe un vínculo de uso compartido del tipo especificado para la aplicación, esta acción devuelve el vínculo de uso compartido existente.

Los recursos listItem heredan permisos de uso compartido de la lista en la que reside el elemento.

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
✅ ✅ ✅ ✅

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 Files.ReadWrite.All, Sites.ReadWrite.All
Delegado (cuenta personal de Microsoft) Files.ReadWrite Files.ReadWrite.All
Aplicación Files.ReadWrite.All Sites.ReadWrite.All

Solicitud HTTP

POST /sites/{siteId}/lists/{listId}/items/{itemId}/createLink

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione una representación JSON de los parámetros.

La siguiente tabla muestra los parámetros que se pueden usar con esta acción.

Propiedad Tipo Descripción
tipo Cadena El tipo de vínculo para compartir que se creará. Opcional.
ámbito Cadena El ámbito del vínculo que se creará. Ya sea anonymous, organization o users. Opcional.
expirationDateTime DateTimeOffset Una cadena con formato aaaa-MM-ddTHH:mm:ssZ de DateTime indica la hora de expiración del permiso. Opcional.
password String Contraseña del vínculo de uso compartido que establece el creador. Opcional.
destinatarios colección driveRecipient Colección de destinatarios que recibirán acceso al vínculo de uso compartido. Opcional.
retainInheritedPermissions Booleano Opcional. Si true es (valor predeterminado), los permisos heredados existentes se conservan en el elemento compartido al compartir este elemento por primera vez. Si falsees , se quitan todos los permisos existentes al compartir por primera vez.
sendNotification Booleano Si truees , este método envía un vínculo de uso compartido en un correo electrónico a los usuarios especificados en recipients. Aplicable a OneDrive para la Empresa y SharePoint. El valor predeterminado es false. Opcional.

Se pueden usar los siguientes valores para el parámetro de tipo.

Valor del tipo Descripción
vista Crea un vínculo de solo lectura para el elemento.
Revisión Crea un vínculo de revisión al elemento. Esta opción solo está disponible para los archivos de OneDrive para la Empresa y SharePoint.
edit Crea un vínculo de solo escritura para el elemento.
Insertar Crea un vínculo insertable para el elemento.
blocksDownload Crea un vínculo de solo lectura que bloquea la descarga en el elemento. Esta opción solo está disponible para los archivos de OneDrive para la Empresa y SharePoint.
createOnly Crea un vínculo de solo carga al elemento. Esta opción solo está disponible para carpetas de OneDrive para la Empresa y SharePoint.
addressBar Crea el vínculo predeterminado que se muestra en las barras de direcciones del explorador para los archivos recién creados. Disponible solo en OneDrive para la Empresa y en SharePoint. El administrador de la organización configura si se admite este tipo de vínculo y qué características admite este tipo de vínculo.
adminDefault Crea el vínculo predeterminado al elemento según lo determinado por el administrador de la organización. Disponible solo en OneDrive para la Empresa y en SharePoint. El administrador aplica la directiva para la organización.

Tipos de ámbitos

Se permiten los siguientes valores para el parámetro scope.

Valor Descripción
Anónimo Cualquier persona con el vínculo tiene acceso, sin necesidad de iniciar sesión. Se incluyen personas de fuera de su organización. Un administrador puede deshabilitar la compatibilidad con vínculos anónimos.
organización Cualquier persona que haya iniciado sesión en su organización (espacio empresarial) podrá usar el vínculo para obtener acceso. Disponible solo en OneDrive para la Empresa y en SharePoint.
users Las personas específicas de la colección recipients pueden usar el vínculo para obtener acceso. Disponible solo en OneDrive para la Empresa y en SharePoint.

Respuesta

Si se ejecuta correctamente, este método devuelve un único recurso de permiso en el cuerpo de la respuesta que representa los permisos de uso compartido solicitados.

La respuesta es 201 Created si se crea un nuevo vínculo de uso compartido para listItem o 200 OK si se devuelve un vínculo existente.

Ejemplos

En el ejemplo siguiente se solicita la creación de un vínculo de uso compartido para el elemento listItem especificado por {itemId} en la lista especificada {listId}. El vínculo para compartir está configurado para que sea de solo lectura y lo pueda usar cualquier usuario que tenga el vínculo. Para los usuarios de OneDrive para la Empresa y SharePoint, use el sendNotification parámetro para crear un vínculo de uso compartido. sharingLink A continuación, se envía a los destinatarios por correo electrónico. Todos los permisos existentes se quitan al compartir por primera vez si retainInheritedPermissions es false.

Solicitud

POST https://graph.microsoft.com/beta/sites/{siteId}/lists/{listId}/items/{itemId}/createLink
Content-Type: application/json

{
  "type": "view",
  "scope": "anonymous",
  "password": "String",
  "recipients": [
    {
      "@odata.type": "microsoft.graph.driveRecipient"
    }
  ],
  "sendNotification": true,
  "retainInheritedPermissions": false
}

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": "123ABC",
  "roles": ["write"],
  "link": {
    "type": "view",
    "scope": "anonymous",
    "webUrl": "https://1drv.ms/A6913278E564460AA616C71B28AD6EB6",
    "application": {
      "id": "1234",
      "displayName": "Sample Application"
    },
  },
  "hasPassword": true
}

OneDrive para la Empresa y SharePoint admiten vínculos de empresa para compartir. Estos vínculos son similares a los vínculos anónimos, excepto que solo funcionan para miembros de la organización propietaria. Para crear un vínculo de empresa para compartir, utilice el parámetro de ámbito con un valor de organization.

Solicitud

POST https://graph.microsoft.com/beta/sites/{siteId}/lists/{listId}/items/{itemId}/createLink
Content-Type: application/json

{
  "type": "edit",
  "scope": "organization"
}

Respuesta

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

{
  "id": "123ABC",
  "roles": ["write"],
  "link": {
    "type": "edit",
    "scope": "organization",
    "webUrl": "https://contoso-my.sharepoint.com/personal/ellen_contoso_com/...",
    "application": {
      "id": "1234",
      "displayName": "Sample Application"
    },
  }
}

Cuando se usa el tipo de embed vínculo, la webUrl devuelta se puede incrustar en un <iframe> elemento HTML. Cuando se crea un vínculo de inserción, la webHtml propiedad contiene el código HTML de un <iframe> objeto para hospedar el contenido.

Nota: La acción de insertar vínculos solo se admite en OneDrive Personal.

Solicitud

POST https://graph.microsoft.com/beta/sites/{siteId}/lists/{listId}/items/{itemId}/createLink
Content-Type: application/json

{
  "type": "embed"
}

Respuesta

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

{
  "id": "123ABC",
  "roles": ["read"],
  "link": {
    "type": "embed",
    "webHtml": "<IFRAME src=\"https://onedrive.live.com/...\"></IFRAME>",
    "webUrl": "https://onedive.live.com/...",
    "application": {
      "id": "1234",
      "displayName": "Sample Application"
    },
  }
}

Comentarios

  • Para crear un vínculo basado en la directiva predeterminada de la organización y los permisos del autor de la llamada en listItem, omita los parámetros de ámbito y tipo.
  • Los vínculos creados con esta acción no expiran a menos que se aplique una directiva de expiración predeterminada para la organización.
  • Los vínculos son visibles en los permisos de uso compartido para listItem y los puede quitar un propietario de listItem.
  • Los vínculos siempre apuntan a la versión actual de un listItem a menos que se desprotegera listItem (solo SharePoint).