listItem: createLink

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Crie um link de compartilhamento para um listItem.

A ação createLink cria um novo link de compartilhamento se o tipo de link especificado ainda não existir para o aplicativo de chamada. Se um link de compartilhamento do tipo especificado já existir para o aplicativo, essa ação retornará o link de compartilhamento existente.

os recursos listItem herdam permissões de compartilhamento da lista em que o item reside.

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global Governo dos EUA L4 GOVERNO DOS EUA L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões privilegiadas mais altas
Delegado (conta corporativa ou de estudante) Files.ReadWrite Files.ReadWrite.All, Sites.ReadWrite.All
Delegado (conta pessoal da Microsoft) Files.ReadWrite Files.ReadWrite.All
Aplicativo Files.ReadWrite.All Sites.ReadWrite.All

Solicitação HTTP

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

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON dos parâmetros.

A tabela a seguir mostra os parâmetros que podem ser usados com esta ação.

Propriedade Tipo Descrição
type Cadeia de caracteres O tipo de link de compartilhamento a ser criado. Opcional.
scope Cadeia de caracteres O escopo do link a ser criado. Ou anonymous, organization ou users. Opcional.
expirationDateTime DateTimeOffset Uma cadeia de caracteres com formato de yyyy-MM-ddTHH:mm:ssZ do DateTime indica a hora de expiração da permissão. Opcional.
password String A senha do link de compartilhamento que é definido pelo criador. Opcional.
destinatários coleção driveRecipient Uma coleção de destinatários que receberão acesso ao link de compartilhamento. Opcional.
retainInheritedPermissions Booleano Opcional. Se true (padrão), todas as permissões herdadas existentes serão mantidas no item compartilhado ao compartilhar esse item pela primeira vez. Se false, todas as permissões existentes forem removidas ao compartilhar pela primeira vez.
sendNotification Booliano Se true, esse método enviará um link de compartilhamento em um email para usuários especificados em recipients. Aplicável a OneDrive for Business e SharePoint. O valor padrão é false. Opcional.

Os seguintes valores são permitidos para o parâmetro type.

Valor do tipo Descrição
modo de exibição Cria um link somente leitura para o item.
Revisão Cria um link de revisão para o item. Essa opção só está disponível para arquivos no OneDrive for Business e no SharePoint.
edit Cria um link de leitura e gravação para o item.
Incorporar Cria um link inserível para o item.
blocksDownload Cria um link somente leitura que bloqueia o download para o item. Essa opção só está disponível para arquivos no OneDrive for Business e no SharePoint.
createOnly Cria um link somente upload para o item. Essa opção só está disponível para pastas no OneDrive for Business e no SharePoint.
addressBar Cria o link padrão mostrado nas barras de endereço do navegador para arquivos recém-criados. Disponível apenas no OneDrive for Business e no SharePoint. O administrador da organização configura se esse tipo de link tem suporte e quais recursos são compatíveis com esse tipo de link.
adminDefault Cria o link padrão para o item conforme determinado pelo administrador da organização. Disponível apenas no OneDrive for Business e no SharePoint. A política é imposta para a organização pelo administrador

Tipos de escopo

Os seguintes valores são permitidos para o parâmetro scope.

Valor Descrição
Anônimo Qualquer pessoa com o link tem acesso, sem precisar fazer logon. Isso pode incluir pessoas de fora da organização. O suporte para links anônimos pode ser desativado por um administrador.
organization Qualquer pessoa que tenha feito logon em sua organização (locatário) pode usar o link para obter acesso. Disponível apenas no OneDrive for Business e no SharePoint.
usuários Pessoas específicas na coleção de destinatários podem usar o link para obter acesso. Disponível apenas no OneDrive for Business e no SharePoint.

Resposta

Se for bem-sucedido, esse método retornará um único recurso de permissão no corpo da resposta que representa as permissões de compartilhamento solicitadas.

A resposta será 201 Created se um novo link de compartilhamento for criado para o listItem ou 200 OK se um link existente for retornado.

Exemplos

O exemplo a seguir solicita um link de compartilhamento a ser criado para o listItem especificado por {itemId} na lista especificada {listId}. O link de compartilhamento é configurado como somente leitura e utilizável por qualquer pessoa com o link. Para usuários do OneDrive for Business e do SharePoint, use o sendNotification parâmetro para criar um link de compartilhamento. Em sharingLink seguida, o é enviado aos destinatários por email. Todas as permissões existentes são removidas ao compartilhar pela primeira vez se retainInheritedPermissions for falso.

Solicitação

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
}

Resposta

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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
}

O OneDrive for Business e o SharePoint oferecem suporte a links compartilháveis pela empresa. Esses links são semelhantes a links anônimos, exceto que funcionam apenas para membros da organização proprietária. Para criar um link compartilhável pela empresa, use o parâmetro scope com um valor de organization.

Solicitação

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

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

Resposta

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"
    },
  }
}

Quando você usa o tipo de embed link, o WebUrl retornado pode ser inserido em um <iframe> elemento HTML. Quando um link de inserção é criado, a webHtml propriedade contém o código HTML para um <iframe> hospedar o conteúdo.

Observação: os links de inseridos só tem suporte no OneDrive Pessoal.

Solicitação

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

{
  "type": "embed"
}

Resposta

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"
    },
  }
}

Comentários

  • Para criar um link com base na política padrão da organização e nas permissões do chamador no listItem, omita os parâmetros de escopo e tipo
  • Os links criados usando essa ação não expiram a menos que uma política de expiração padrão seja imposta para a organização.
  • Os links estão visíveis nas permissões de compartilhamento para o listItem e podem ser removidos por um proprietário do listItem.
  • Os links sempre apontam para a versão atual de um listItem, a menos que o listItem seja verificado (somente SharePoint).