listItem: createLink

  • Artikel

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Erstellen Sie einen Freigabelink für ein listItem.Create a sharing link for a listItem.

Die CreateLink-Aktion erstellt einen neuen Freigabelink, wenn der angegebene Linktyp noch nicht für die aufrufende Anwendung vorhanden ist. Wenn bereits ein Freigabelink des angegebenen Typs für die App vorhanden ist, gibt diese Aktion den vorhandenen Freigabelink zurück.

listItem-Ressourcen erben Freigabeberechtigungen aus der Liste , in der sich das Element befindet.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Globaler Dienst US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet
✅ ✅ ✅ ✅

Berechtigungen

Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) Files.ReadWrite Files.ReadWrite.All, Sites.ReadWrite.All
Delegiert (persönliches Microsoft-Konto) Files.ReadWrite Files.ReadWrite.All
Anwendung Files.ReadWrite.All Sites.ReadWrite.All

HTTP-Anforderung

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

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung der Parameter an.

In der folgenden Tabelle sind die Parameter aufgeführt, die mit dieser Aktion verwendet werden können.

Eigenschaft Typ Beschreibung
Typ String Der Typ Freigabelink, der erstellt werden soll. Optional.
Bereich String Der Bereich des zu erstellenden Links. Entweder anonymous, organization oder users. Optional.
expirationDateTime DateTimeOffset Eine Zeichenfolge im Format yyyy-MM-ddTHH:mm:ssZ von DateTime gibt die Ablaufzeit der Berechtigung an. Optional.
password String Das Kennwort des Freigabelinks, der vom Ersteller festgelegt wird. Optional.
recipients driveRecipient-Sammlung Eine Sammlung von Empfängern, die Zugriff auf den Freigabelink erhalten. Optional.
retainInheritedPermissions Boolescher Wert Optional. Wenn true (Standard), werden alle vorhandenen geerbten Berechtigungen für das freigegebene Element beibehalten, wenn dieses Element zum ersten Mal freigegeben wird. Gibt falsean, dass alle vorhandenen Berechtigungen bei der erstmaligen Freigabe entfernt werden.
Sendnotification Boolesch Wenn true, sendet diese Methode einen Freigabelink in einer E-Mail an benutzer, die in recipientsangegeben sind. Gilt für OneDrive for Business und SharePoint. Der Standardwert ist false. Optional.

Für den Parameter type sind die folgenden Werte zulässig:

Typwert Beschreibung
Ansicht Erstellt einen schreibgeschützten Link zum Element.
Bewertung Erstellt einen Überprüfungslink zum Element. Diese Option ist nur für Dateien in OneDrive for Business und SharePoint verfügbar.
Bearbeiten Erstellt einen Lese-/Schreiblink zum Element.
Einbinden Erstellt einen einbettbaren Link zum Element.
BlocksHerunterladen Erstellt einen schreibgeschützten Link, der das Herunterladen des Elements blockiert. Diese Option ist nur für Dateien in OneDrive for Business und SharePoint verfügbar.
createOnly Erstellt einen Nur-Upload-Link zum Element. Diese Option ist nur für Ordner in OneDrive for Business und SharePoint verfügbar.
Addressbar Erstellt den Standardlink, der in den Adressleisten des Browsers für neu erstellte Dateien angezeigt wird. Nur in OneDrive for Business und SharePoint verfügbar. Der organization-Administrator konfiguriert, ob dieser Linktyp unterstützt wird und welche Features von diesem Linktyp unterstützt werden.
adminDefault Erstellt den Standardlink zum Element, wie vom Administrator des organization festgelegt. Nur in OneDrive for Business und SharePoint verfügbar. Die Richtlinie wird für die organization vom Administrator erzwungen.

Bereichstypen

Für den Parameter scope sind die nachfolgend aufgeführten Werte zulässig.

Wert Beschreibung
Anonym Jeder Benutzer, der über den Link verfügt, hat Zugriff, ohne sich anmelden zu müssen. Dies kann auch Personen von außerhalb Ihrer Organisation einschließen. Die Unterstützung für anonyme Links kann von einem Administrator deaktiviert werden.
Organisation Jede Person, die bei Ihrer Organisation (Mandant) angemeldet ist, kann den Link verwenden, um Zugriff zu erhalten. Nur in OneDrive for Business und SharePoint verfügbar.
users Bestimmte Personen in der Empfängersammlung können den Link verwenden, um Zugriff zu erhalten. Nur in OneDrive for Business und SharePoint verfügbar.

Antwort

Bei erfolgreicher Ausführung gibt die Methode eine einzelne Berechtigungsressource im Antworttext zurück, die die angeforderten Freigabeberechtigungen darstellt.

Die Antwort lautet 201 Created , wenn ein neuer Freigabelink für das listItem-Objekt erstellt wird oder 200 OK wenn ein vorhandener Link zurückgegeben wird.

Beispiele

Im folgenden Beispiel wird angefordert, dass ein Freigabelink für das listItem-Objekt erstellt wird, das von {itemId} in der angegebenen Liste {listId} angegeben wird. Der Link zum Teilen ist schreibgeschützt konfiguriert und kann von allen verwendet werden. Verwenden Sie für OneDrive for Business- und SharePoint-Benutzer den sendNotification Parameter, um einen Freigabelink zu erstellen. Der sharingLink wird dann per E-Mail an Empfänger gesendet. Alle vorhandenen Berechtigungen werden bei der erstmaligen Freigabe entfernt, wenn retainInheritedPermissions false ist.

Anforderung

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
}

Antwort

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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 for Business und SharePoint unterstützen Links, die nur innerhalb eines Unternehmens geteilt werden können. Diese Links ähneln anonymen Links, mit der Ausnahme, dass sie nur für Mitglieder der besitzenden organization funktionieren. Verwenden Sie den Parameter scope mit dem Wert organization, um einen Link zu erstellen, der nur innerhalb eines Unternehmens geteilt werden kann.

Anforderung

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

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

Antwort

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

Wenn Sie den embed Linktyp verwenden, kann die zurückgegebene webUrl in ein <iframe> HTML-Element eingebettet werden. Wenn ein Einbettungslink erstellt wird, enthält die webHtml -Eigenschaft den HTML-Code für einen <iframe> zum Hosten des Inhalts.

Hinweis: Einbettungslinks werden nur für das persönliche OneDrive unterstützt.

Anforderung

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

{
  "type": "embed"
}

Antwort

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

Bemerkungen

  • Um einen Link basierend auf der Standardrichtlinie des organization und den Berechtigungen des Aufrufers für das listItem-Element zu erstellen, lassen Sie die Bereichs- und Typparameter aus.
  • Mit dieser Aktion erstellte Links laufen nur ab, wenn für die organization eine Standardablaufrichtlinie erzwungen wird.
  • Links sind in den Freigabeberechtigungen für das listItem sichtbar und können von einem Besitzer des listItem entfernt werden.
  • Links zeigen immer auf die aktuelle Version eines listItem-Objekts, es sei denn, das listItem ist ausgecheckt (nur SharePoint).