Work IQ SharePoint-Referenz (Vorschau)

Übersicht

Verfügbare Tools

findSite

Sucht SharePoint Websites, auf die Sie zugreifen können. Gibt bestimmte Websites zurück, die einer Suchabfrage entsprechen, oder die 20 wichtigsten relevanten Websites, wenn Sie keine Abfrage bereitstellen.

Optionale Parameter:

• searchQuery: Suchabfrage (vollständiger oder teilweiser Websitename). Lassen Sie die 20 besten barrierefreien Websites weg.

getSiteByPath

Löst eine SharePoint-Website anhand ihres exakten Hostnamens und serverrelativen Pfads auf. Verwenden Sie diese Methode nur, wenn Sie über die vollständige Website-URL-Struktur verfügen. Verwenden Sie findSite, wenn Sie nur den Namen einer Website kennen.

Erforderliche Parameter:

• hostname: Exakter Hostname (z. B. 'contoso.sharepoint.com').
• serverRelativePath: Serverrelativer Pfad (z. B. "sites/Marketing"). Der führende Schrägstrich ist optional.

Unterwebseiten auflisten

Listet alle Unterwebsites (untergeordnete Websites) einer SharePoint-Website auf.

Erforderliche Parameter:

• Siteid: ID der übergeordneten SharePoint-Website (Format: 'hostname,siteCollectionId,webId')

listDocumentLibrariesInSite

Listet Dokumentbibliotheken (Laufwerke) auf der angegebenen SharePoint Website auf.

Optionale Parameter:

• Siteid: ID der SharePoint-Website (Standard: 'root')

getDefaultDocumentLibraryInSite

Ruft die Standarddokumentbibliothek (Laufwerk) einer SharePoint-Website ab.

Optionale Parameter:

• Siteid: ID der SharePoint-Website (Standard: 'root')

getFolderChildren

Listet die obersten 20 Dateien und Ordner (DriveItems) auf, die in einem angegebenen übergeordneten Ordner in einer Dokumentbibliothek (Laufwerk) enthalten sind.

Erforderliche Parameter:

• documentLibraryId: ID der Dokumentbibliothek (Laufwerk)

Optionale Parameter:

• parentFolderId: ID des übergeordneten Ordners (Standard: 'root')

findFileOrFolder

Sucht nach einer Datei oder einem Ordner (DriveItem), auf die der Benutzer durch Suchabfrage zugreifen kann. Sucht auf allen Websites und Dokumentbibliotheken, auf die der Benutzer Zugriff hat.

Erforderliche Parameter:

• searchQuery: Suchabfrage (vollständiger oder teilweiser Dateiname)

getFileOrFolderMetadata

Ruft Metadaten einer Datei oder eines Ordners (DriveItem) aus einer angegebenen Dokumentbibliothek (Laufwerk) in SharePoint ab.

Erforderliche Parameter:

• fileOrFolderId: ID der Datei oder des Ordners (DriveItem)
• documentLibraryId: ID der Dokumentbibliothek (Laufwerk)

getFileOrFolderMetadataByUrl

Ruft Metadaten einer Datei oder eines Ordners (DriveItem) aus einer Freigabe-URL ab. Nur Benutzer mit vorhandenen expliziten Berechtigungen für den Zugriff auf die Datei dürfen die Metadaten abrufen.

Erforderliche Parameter:

• fileOrFolderUrl: DIE URL der Datei oder des Ordners. Die URL dient nicht dazu, sie mit dem Benutzer zu teilen; der Benutzer muss bereits ausdrücklich Zugriff haben.

readSmallTextFile

Liest (herunterladen) eine Textdatei, die kleiner als 5 MB ist, aus einer bestimmten Dokumentbibliothek (Laufwerk).

Erforderliche Parameter:

• fileId: ID der Datei (DriveItem) zum Lesen oder Herunterladen
• documentLibraryId: ID der Dokumentbibliothek (Laufwerk)

readSmallBinaryFile

Liest eine Binärdatei, die kleiner als 5 MB ist, aus einer bestimmten Dokumentbibliothek (Laufwerk). Der Dateiinhalt wird als base64-codierte Zeichenfolge zurückgegeben.

Erforderliche Parameter:

• fileId: ID der Datei (DriveItem) zum Lesen oder Herunterladen
• documentLibraryId: ID der Dokumentbibliothek (Laufwerk)

createSmallTextFile

Erstellt oder lädt eine Textdatei, die kleiner als 5 MB ist, in eine bestimmte Dokumentbibliothek (Laufwerk) hoch.

Erforderliche Parameter:

• Dateiname: Name der Datei einschließlich Erweiterung
• contentText: Textinhalt der Datei
• documentLibraryId: ID der Dokumentbibliothek (Laufwerk)

Optionale Parameter:

• parentFolderId: ID des übergeordneten Ordners (Standard: 'root')

ErstelleKleineBinärdatei

Erstellt eine Binärdatei mit einer Größe von weniger als 5 MB, indem ihr Inhalt in einer bestimmten Dokumentbibliothek (Laufwerk) Base64-kodiert wird.

Erforderliche Parameter:

• Dateiname: Name der Datei einschließlich Erweiterung
• Base64content: Binäre Dateiinhalte, die als base64-Zeichenfolge codiert sind.
• documentLibraryId: ID der Dokumentbibliothek (Laufwerk)

Optionale Parameter:

• parentFolderId: ID des übergeordneten Ordners (Standard: 'root')

OrdnerErstellen

Erstellt einen neuen Ordner (DriveItem) in einer angegebenen Dokumentbibliothek (Laufwerk). Wenn ein Ordner mit demselben Namen vorhanden ist, fügt das System ein numerisches Suffix hinzu (z. B. NewFolder (1)).

Erforderliche Parameter:

• Foldername: Name des Ordners
• documentLibraryId: ID der Dokumentbibliothek (Laufwerk)

Optionale Parameter:

• parentFolderId: ID des übergeordneten Ordners (Standard: 'root')

umbenennenDateiOderOrdner

Benennt eine Datei oder einen Ordner (DriveItem) in einer angegebenen Dokumentbibliothek (Laufwerk) um. Der neue Name muss den Benennungskonventionen entsprechen.

Erforderliche Parameter:

• documentLibraryId: ID der Dokumentbibliothek (Laufwerk)
• fileOrFolderId: ID der umzubenennende Datei oder des Ordners
• newFileOrFolderName: Der neue Name

Optionale Parameter:

• Etag: ETag für Konkurrenzkontrolle

deleteFileOrFolder

Löscht eine Datei oder einen Ordner (DriveItem) aus einer angegebenen Dokumentbibliothek (Laufwerk).

Erforderliche Parameter:

• documentLibraryId: ID der Dokumentbibliothek (Laufwerk)
• fileOrFolderId: ID der zu löschenden Datei oder des Zu löschenden Ordners

Optionale Parameter:

• Etag: ETag für Konkurrenzkontrolle

DateiOderOrdnerVerschieben

Verschiebt eine Datei oder einen Ordner (DriveItem) in einen Zielordner. Unterstützt das Verschieben verschiedener Dokumentbibliotheken (Laufwerke) innerhalb SharePoint. Dieser Vorgang ist asynchron. Verwenden Sie checkOperationStatus, um den Fortschritt zu überwachen.

Erforderliche Parameter:

• sourcedoclibid: ID der Quelldokumentbibliothek (Laufwerk)
• sourcefileid: ID der zu verschiebenden Quelldatei oder des Zu verschiebenden Ordners
• destdoclibid: ID der Zieldokumentbibliothek (Laufwerk)
• destfolderid: ID des Zielordners (muss vorhanden sein)

Optionale Parameter:

• newfilename: Neuer Name für das verschobene Element

KopiereDateiOderOrdner

Kopiert eine Datei oder einen Ordner (DriveItem) in einen Zielordner. Unterstützt das Kopieren in verschiedenen Dokumentbibliotheken in SharePoint. Dieser Vorgang ist asynchron. Verwenden Sie checkOperationStatus, um den Fortschritt zu überwachen.

Erforderliche Parameter:

• sourcedoclibid: ID der Quelldokumentbibliothek (Laufwerk)
• sourcefileid: ID der zu kopierenden Quelldatei oder des Zu kopierenden Ordners
• destdoclibid: ID der Zieldokumentbibliothek (Laufwerk)
• destfolderid: ID des Zielordners (muss vorhanden sein)

Optionale Parameter:

• newfilename: Neuer Name für das kopierte Element

ÜberprüfeBetriebsstatus

Überprüft den Status eines asynchronen Vorgangs, z. B. eine Kopie oder Verschiebung, mithilfe des vom ursprünglichen Vorgang zurückgegebenen Vorgangstokens.

Erforderliche Parameter:

• operationToken: Das von einem asynchronen Vorgang wie copyFileOrFolder oder moveFileOrFolder zurückgegebene Vorgangstoken

uploadFileFromUrl

Lädt eine Datei aus einer SharePoint- oder OneDrive-URL in einen Zielordner in einer Dokumentbibliothek (Laufwerk) hoch. Die Datei wird aus der Quell-URL kopiert, sodass die ursprüngliche Datei nicht geändert wird.

Erforderliche Parameter:

• sourceUrl: Quell-URL (muss eine gültige SharePoint- oder OneDrive-URL sein)
• destinationDocumentLibraryId: ID der Zieldokumentbibliothek. Verwenden Sie me für OneDrive des Benutzers

Optionale Parameter:

• destinationFolderId: ID des Zielordners (Standard: root)
• Dateiname: Neuer Dateiname; Standardmäßig wird der ursprüngliche Dateiname verwendet.

shareFileOrFolder

Sendet eine Freigabeaufladung, um Lese- oder Schreibberechtigungen für eine Datei oder einen Ordner (DriveItem) innerhalb einer angegebenen Dokumentbibliothek (Laufwerk) zu erteilen.

Erforderliche Parameter:

• documentLibraryId: ID der Dokumentbibliothek (Laufwerk)
• fileOrFolderId: ID der zu teilenden Datei oder des Ordners
• recipientEmails: Array von E-Mail-Adressen von Empfängern
• Rollen: Array von Rollen: "lesen", "schreiben" ("schreiben" gewährt sowohl Lese- als auch Schreibzugriff)

Optionale Parameter:

• Nachricht: Benutzerdefinierte Nachricht für die Einladungs-E-Mail (Standard: Hier ist die Datei, an der wir zusammenarbeiten.)
• sendInvitation: Gibt an, ob eine Freigabeaufladung gesendet werden soll (Standard: true)

setzeEmpfindlichkeitskennzeichnungAufDatei

Legt die Vertraulichkeitsbezeichnung einer Datei aus der angegebenen Dokumentbibliothek (Laufwerk) fest.

Erforderliche Parameter:

• documentLibraryId: ID der Dokumentbibliothek (Laufwerk)
• fileId: ID der Datei (DriveItem)
• sensitivityLabelId: ID des Vertraulichkeitskennzeichens oder eine leere Zeichenfolge, um es zu entfernen

Optionale Parameter:

• assignmentMethod: Zuordnungsmethode: 'standard', 'privileged', 'auto' oder 'unknownFutureValue' (Standard: 'privileged')
• justificationText: Begründungstext für Auditzwecke; erforderlich beim Herabstufen oder Entfernen einer Bezeichnung (Standard: 'Geändert von MCPServer')

listLists

Ruft alle auf einer bestimmten Website verfügbaren SharePoint Listen ab. Verwenden Sie dies, um zu entdecken, welche Listen innerhalb einer Website vorhanden sind.

Erforderliche Parameter:

• Siteid: ID der SharePoint-Website (Format: 'hostname,siteCollectionId,webId')

createList

Erstellt eine neue SharePoint-Liste innerhalb einer Website.

Erforderliche Parameter:

• Siteid: ID der SharePoint-Website
• Displayname: Anzeigename der neuen Liste

Optionale Parameter:

• Spalten: Sammlung von Spalten als Schlüsselwertpaare: [{ Key: 'JobTitle', Value: 'text' }]. Gültige Typen: Text, Mehrzeiliger Text, Zahl, Boolean, DatumUhrzeit, Auswahl, Nachschlagen, PersonOderGruppe, Hyperlink, Währung, Berechnet
• Vorlage: Listenvorlagentyp (Standard: 'genericList'). Optionen: generische Liste, Dokumentbibliothek, Ereignisse, Aufgaben, Ankündigungen, Kontakte, Links, Umfrage, Problemverfolgung, Diskussionsforum

Löschliste

Löscht eine SharePoint-Liste von einer Website. Löscht den gesamten Listencontainer und alle darin enthaltenen Elemente. Kann nicht rückgängig gemacht werden.

Erforderliche Parameter:

• Siteid: ID der SharePoint-Website
• listId: ID der zu löschenden Liste

Optionale Parameter:

• Etag: ETag für Konkurrenzkontrolle

EinladungFürListeSenden

Sendet eine Freigabeeinladung, um Berechtigungen für eine SharePoint-Liste zu gewähren.

Erforderliche Parameter:

• listId: ID der zu teilenden SharePoint-Liste
• recipientEmails: Array von E-Mail-Adressen von Empfängern
• Rolle: Rolle: "lesen" (nur anzeigen), "mitwirken" (Ansicht, Hinzufügen, Aktualisieren, Löschen von Elementen), "Bearbeiten" (vollständige Bearbeitung einschließlich Listenstruktur)

Optionale Parameter:

• Siteurl: Website-URL der SharePoint-Website, die die Liste enthält
• Sendemail: Gibt an, ob eine E-Mail-Benachrichtigung gesendet werden soll (Standard: true)

listListItems

Ruft Elemente (Zeilen/Datensätze) aus einer bestimmten SharePoint-Liste ab.

Erforderliche Parameter:

• Siteid: ID der SharePoint-Website
• listId: ID der SharePoint-Liste

getListItem

Ruft ein einzelnes Element (Zeile/Datensatz) aus einer SharePoint-Liste anhand seiner ID ab.

Erforderliche Parameter:

• Siteid: ID der SharePoint-Website
• listId: ID der SharePoint-Liste
• Itemid: ID des spezifischen Listenelements

createListItem

Erstellt ein neues Element (Zeile oder Datensatz) in einem SharePoint-Liste.

Erforderliche Parameter:

• Siteid: ID der SharePoint-Website
• listId: ID der SharePoint-Liste
• Felder: Schlüssel-Wert-Paare für Feldwerte: [{ Key: 'Title', Value: 'Software Engineer' }, { Key: 'Department', Value: 'Engineering' }]. Das Feld "Titel" ist in der Regel erforderlich.

aktualisiereListenelement

Aktualisiert ein vorhandenes Element (Zeile oder Datensatz) in einer SharePoint-Liste. Nur angegebene Felder werden aktualisiert; Ausgelassene Felder behalten ihre Werte bei.

Erforderliche Parameter:

• Siteid: ID der SharePoint-Website
• listId: ID der SharePoint-Liste
• Itemid: ID des zu aktualisierenden Elements
• Felder: Schlüsselwertpaare von zu aktualisierenden Feldern

Optionale Parameter:

• Etag: ETag für Konkurrenzkontrolle

LöscheListenElement

Löscht ein Element (Zeile oder Datensatz) aus einer SharePoint-Liste.

Erforderliche Parameter:

• Siteid: ID der SharePoint-Website
• listId: ID der SharePoint-Liste
• Itemid: ID des zu löschenden Elements

Optionale Parameter:

• Etag: ETag für Konkurrenzkontrolle

listColumns

Ruft alle Spalten aus einer SharePoint-Liste ab.

Erforderliche Parameter:

• Siteid: ID der SharePoint-Website
• listId: ID der SharePoint-Liste

SpalteErstellen

Erstellt eine neue Spalte in einem SharePoint-Liste. Unterstützt viele Spaltentypen, einschließlich Text, Zahl, Auswahl, Datum/Uhrzeit, Boolescher Wert, Benutzer, Nachschlagen, berechneter Wert und mehr.

Erforderliche Parameter:

• Siteid: ID der SharePoint-Website
• listId: ID der SharePoint-Liste
• Namen: Interner Spaltenname (programmgesteuerter Bezeichner)
• Columntyp: Spaltentyp: Text, Notiz, Zahl, Ganzzahl, Boolesch, DatumZeit, Auswahl, Mehrfachauswahl, Währung, Nachschlagen, Benutzer, URL, Berechnet, Begriff, Mehrfachbegriff, Ort, Geolokation, Miniaturansicht, Zähler, Berechnet, Inhaltstyp-ID, Datei, Anhang, GUID, Ergebnisauswahl, Genehmigungsstatus

Optionale Parameter:

• columnProperties: Typspezifische Einstellungen (z. B. { "maxLength": 255 } für Text, { "choices": ["A","B","C"] } für Auswahl)
• Beschreibung: Beschreibung der Spalte
• Displayname: Anzeigename, der in der Benutzeroberfläche angezeigt wird (Standardeinstellung : 'Name')
• Erforderlich: Festlegen der erforderlichen Spalte (Standard: false)
• Versteckte: Spalte aus Ansichten ausblenden (Standard: false)

aktualisiereSpalte

Aktualisiert eine vorhandene Spalte in einer SharePoint-Liste.

Erforderliche Parameter:

• Siteid: ID der SharePoint-Website
• listId: ID der SharePoint-Liste
• Columnid: ID der zu aktualisierenden Spalte

Optionale Parameter:

• Columntype: Spaltentyp (erforderlich beim Bereitstellen von 'columnProperties')
• columnProperties: Typspezifische Eigenschaften, die aktualisiert werden sollen
• Beschreibung: Neue Beschreibung
• Displayname: Neuer Anzeigename
• Versteckt: Spalte ausblenden oder anzeigen
• Erforderlich: Spalte als erforderlich oder optional einstellen

SpalteLöschen

Löscht eine Spalte aus einer SharePoint-Liste. Warnung: Mit dieser Aktion werden alle in dieser Spalte gespeicherten Daten für alle Elemente entfernt.

Erforderliche Parameter:

• Siteid: ID der SharePoint-Website
• listId: ID der SharePoint-Liste
• Columnid: ID der zu löschenden Spalte

Wichtigste Funktionen

Websiteverwaltung

• Suchen Sie Websites anhand des Namens, oder durchsuchen Sie barrierefreie Websites.
• Rufen Sie eine Website anhand des genauen URL-Pfads ab.
• Auflisten untergeordneter Websites und Unterwebsites.
• Umfassende Navigation in der Website-Hierarchie.

Dokumentbibliotheksverwaltung

• Auflisten aller Dokumentbibliotheken auf einer Website.
• Rufen Sie die Standarddokumentbibliothek ab.
• Durchsuchen von Ordnerinhalten (bis zu 20 Elemente)
• Erstellen und Verwalten von Ordnerstrukturen.

Dateivorgänge

• Erstellen von Text- und Binärdateien (≤5 MB).
• Lesen von Text- und Binärdateien (≤5 MB).
• Löschen, Umbenennen und Verschieben von Dateien und Ordnern
• Kopieren Sie Dateien und Ordner zwischen Dokumentbibliotheken.
• Laden Sie Dateien aus SharePoint- oder OneDrive-URLs hoch.
• Suchen Sie auf allen barrierefreien Websites nach Dateien und Ordnern.
• Abrufen von Datei- und Ordnermetadaten.

Asynchrone Vorgänge

• Kopieren und Verschieben von Dateien und Ordnern asynchron in Dokumentbibliotheken.
• Überprüfen Sie den Status asynchroner Vorgänge mithilfe von Vorgangstoken.

Vorgänge auflisten

• Listen erstellen, lesen und löschen.
• Unterstützung für mehrere Listenvorlagen, einschließlich allgemeiner Listen, Dokumentbibliotheken, Ereignissen und Aufgaben.
• Freigeben von Listen mit rollenbasierten Berechtigungen.
• Verwalten Sie Listenelemente, indem Sie sie erstellen, lesen, aktualisieren und löschen.

Spaltenverwaltung

• Erstellen Sie Spalten mit einer Vielzahl von Typen, z. B. Text, Notiz, Zahl, boolescher Wert, DateTime, Auswahl, Nachschlagevorgang, Benutzer, URL, berechnet und vieles mehr.
• Aktualisieren von Spalteneigenschaften und Metadaten.
• Konfigurieren Sie Spaltenanforderungen und Sichtbarkeit.
• Festlegen typspezifischer Spalteneigenschaften.

Freigabe und Berechtigungen

• Freigeben von Dateien, Ordnern und Listen für Benutzer.
• Verwenden Sie die rollenbasierte Zugriffssteuerung mit Lese-, Schreib-, Beitrags- und Bearbeitungsrollen.
• E-Mail-Benachrichtigungen für das Teilen
• Benutzerdefinierte Nachrichten in Einladungen

Sicherheit und Konformität

• Anwenden und Entfernen von Vertraulichkeitsbezeichnungen.
• Verwenden Sie mehrere Zuweisungsmethoden, darunter Standard-, privilegierte und automatische Methoden.
• Unterstützen Sie die Begründung der Überwachung.
• Verwenden Sie die Parallelitätssteuerung mit eTags.

Hinweise

• Dateivorgänge sind auf Dateien beschränkt, die 5 MB oder weniger zum Hochladen und Herunterladen sind.
• Kopier- und Verschiebungsvorgänge sind asynchron. Verwenden Sie checkOperationStatus, um den Fortschritt zu überwachen.
• Kopier- und Verschiebungsvorgänge unterstützen bibliothekübergreifende Vorgänge innerhalb SharePoint.
• uploadFileFromUrl erfordert eine gültige SharePoint- oder OneDrive Quell-URL.
• eTags bieten parallele Steuerung für Updates und Löschungen.
• Automatisches numerisches Suffix für doppelte Ordnernamen
• Das Löschen von Listen kann nicht rückgängig gemacht werden.
• Beim Löschen von Spalten werden alle in dieser Spalte gespeicherten Daten entfernt.
• Suchvorgänge geben standardmäßig die obersten 20 Ergebnisse zurück.