Feedback Bearbeiten

listItem: createLink

  • Artikel
  • 10 Minuten Lesedauer

Namespace: microsoft.graph

Wichtig

APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .

Erstellen Sie einen Freigabelink für ein listItem.

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

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

Berechtigungen

Eine der folgenden Berechtigungen ist erforderlich, um diese API aufzurufen. Weitere Informationen, einschließlich der Auswahl von Berechtigungen, finden Sie unter "Berechtigungen".

Berechtigungstyp Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)
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.
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
type Zeichenfolge Der Typ Freigabelink, der erstellt werden soll. Optional.
scope String Der Bereich des zu erstellenden Links. Entweder anonymousoder organization 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.

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

Typwert Beschreibung
Ansicht Erstellt einen schreibgeschützten Link zum Element.
Bewertung Erstellt einen Rezensionslink zu dem Element. Diese Option ist nur für Dateien in OneDrive for Business und SharePoint verfügbar.
Bearbeiten Erstellt einen Link mit Lese-/Schreibzugriff auf das Element.
Einbinden Erstellt einen einbettbaren Link zum Element.
blocksDownload Erstellt einen schreibgeschützten Link, der den Download 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 Browseradressleisten für neu erstellte Dateien angezeigt wird. Nur in OneDrive for Business und SharePoint verfügbar. Der Organisationsadministrator konfiguriert, ob dieser Linktyp unterstützt wird und welche Features von diesem Linktyp unterstützt werden.
adminDefault Erstellt den Standardlink zu dem Element, wie vom Administrator der Organisation festgelegt. Nur in OneDrive for Business und SharePoint verfügbar. Die Richtlinie wird vom Administrator für die Organisation 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 ist 201 Created , wenn ein neuer Freigabelink für das listItem erstellt wird oder 200 OK wenn ein vorhandener Link zurückgegeben wird.

Beispiele

Im folgenden Beispiel wird ein Freigabelink angefordert, der für das von {itemId} in der liste angegebene {listId} angegebene listItem erstellt werden soll. Der Link zum Teilen ist schreibgeschützt konfiguriert und kann von allen verwendet werden.

Anforderung

POST sites/{siteId}/lists/{listId}/items/{itemId}/createLink
Content-Type: application/json

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

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 ähneln anonymen Links, funktionieren aber nur für Mitglieder der Besitzorganisation. Verwenden Sie den Parameter scope mit dem Wert organization, um einen Link zu erstellen, der nur innerhalb eines Unternehmens geteilt werden kann.

Anforderung

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

Bei Verwendung des Linktyps embed kann der zurückgegebene Wert für „webUrl“ in ein HTML-Element des Typs <iframe> eingebettet werden. Wird ein Einbettungslink erstellt, enthält die Eigenschaft webHtml den HTML-Code für einen <iframe>, der den Inhalt hostet.

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

Anforderung

POST /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

  • Wenn Sie einen Link basierend auf der Standardrichtlinie der Organisation und den Berechtigungen des Aufrufers für das listItem erstellen möchten, lassen Sie den Bereich und die Typparameter aus.
  • Mit dieser Aktion erstellte Links laufen nicht ab, es sei denn, für die Organisation wird eine Standardablaufrichtlinie erzwungen.
  • 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-Objekt, es sei denn, das listItem ist ausgecheckt (nur SharePoint).