Add Shared Link to File

Projektkompatibilität

Windows | Plattformübergreifend

Überblick

Beschreibung	API-Methode	API-Pfad
Erstellen Sie einen freigegebenen Link für eine Datei in Box.	PUT	/files/{file_id}/add_shared_link

Eingabe

Parameter	Beschreibung	Datentyp
Datei	Das Dateiobjekt, für das der freigegebene Link erstellt wird.	Datenliste
Zugriff	Definiert, wer auf den freigegebenen Link zugreifen kann. Unterstützte Werte: Öffnen – Jeder mit dem Link Unternehmen – Nur Benutzer in Ihrer Organisation Mitarbeitende – Nur Benutzer, die Mitarbeitende der Datei oder des übergeordneten Ordners sind	options
Passwort	Ein optionales Kennwort, das für den Zugriff auf den freigegebenen Link erforderlich ist. Auf NULL festlegen, um ein vorhandenes Kennwort zu entfernen. Kennwörter müssen mindestens 8 Zeichen lang sein und eine Ziffer, einen Großbuchstaben oder ein Symbol enthalten. Der Kennwortschutz ist nur zulässig, wenn Zugriff = open.	string
Herunterladen (Download)	Gibt an, ob Benutzer die Datei über den freigegebenen Link herunterladen können. Dies kann nur aktiviert werden, wenn Zugriff = open oder company.	boolean
Vorschau	Gibt an, ob Benutzer über den freigegebenen Link eine Vorschau der Datei anzeigen können. Dieser Wert ist immer „true“. Für freigegebene Ordnerlinks gilt dies für alle Elemente innerhalb des Ordners.	boolean
Zeit zum Aufheben der Freigabe	Optionaler Zeitstempel, der angibt, wann der freigegebene Link automatisch abläuft.	DateTime
Freigegebener Link Vanity-Name	Ein benutzerdefinierter, für Menschen benutzerfreundlicher Bezeichner, der in vanity_url des geteilten Links verwendet wird.	string

Ausgabe

Parameter	Beschreibung	Datentyp
Add Shared Link to File	Das Objekt für den freigegebenen Link, das für die Datei erstellt oder aktualisiert wurde.	options
ID	Der eindeutige Bezeichner der Datei.	string
ID der Pfadsammlungseinträge	Die ID jeder Komponente in der Ordnerpfadhierarchie der Datei.	string
Erstellt von ID	Die ID des Benutzers, der die Datei ursprünglich erstellt hat.	string
Übergeordnete ID	Die ID des übergeordneten Ordners, der die Datei enthält.	string
Im Besitz der ID	Die ID des Benutzers, der die Datei besitzt.	string
Geändert von ID	Die ID des Benutzers, der die Datei zuletzt geändert hat.	string
Dateiversions-ID	Die ID der Version der Datei	string

Hinweis:

• In API-Workflows wird als Ausgabe ein einzelnes Antwortobjekt zurückgegeben. Alle Pflichtfelder können direkt aus diesem Objekt extrahiert werden.
• In RPA-Workflows können sich einige Ausgabeparameter unterscheiden, aber die erforderlichen Werte können weiterhin aus dem Antwortobjekt abgerufen werden, auch wenn sie nicht explizit verfügbar gemacht werden.