Referencja do SharePoint (podgląd)

Note

Funkcje opisane w tym artykule są zasilane standardową wiązką, która wykorzystuje opcje rozliczeniowe opisane w sekcji Licencjonowanie dla agentów zasilanych standardową wiązką. Dowiedz się, jak korzystać ze standardowych funkcji w Access, agentów standardowych i przepływach agentów.

Important

Jest to funkcja w wersji zapoznawczej.

  • Microsoft udostępnia funkcje w wersji zapoznawczej przed ich oficjalnym wydaniem, aby klienci mogli uzyskać wcześniejszy dostęp i przekazać opinie.
  • Funkcje w wersji zapoznawczej mają ograniczone funkcje i nie są przeznaczone do użytku produkcyjnego.
  • Microsoft może zmienić nazwy i parametry narzędzia MCP w wersji zapoznawczej. Unikaj zakodowanych na sztywno zależności. Microsoft obsługuje scenariusze.
  • Funkcje w wersji zapoznawczej podlegają dodatkowym warunkom użytkowania firmy Microsoft.

Overview

Identyfikator serwera Adres URL na poziomie dzierżawcy Wyświetlana nazwa Description
mcp_SharePointRemoteServer https://agent365.svc.cloud.microsoft/
agents/tenants/{tenantId}/servers/
mcp_SharePointRemoteServer
SharePoint Narzędzia do operacji SharePoint. Ten serwer służy do zarządzania witrynami, listami, elementami listy, kolumnami, bibliotekami dokumentów, plikami, folderami i udostępnianiem plików. Operacje na plikach są ograniczone do plików o rozmiarze co najmniej 5 MB.

Dostępne narzędzia

findSite

Znajduje witryny programu SharePoint, do których masz dostęp. Zwraca określone witryny pasujące do zapytania wyszukiwania lub 20 najważniejszych odpowiednich witryn, jeśli nie podasz zapytania.

Parametry opcjonalne:

  • searchQuery: Kwerenda wyszukiwania (nazwa całej lub częściowej witryny). Pomiń zwracanie 20 najważniejszych witryn z ułatwieniami dostępu.

getSiteByPath

Rozpoznaje lokację SharePoint przy użyciu dokładnej nazwy hosta i ścieżki względnej serwera. Użyj tej metody tylko wtedy, gdy masz pełną strukturę adresów URL witryny. Użyj findSite, jeśli znasz tylko nazwę witryny.

Wymagane parametry:

  • Nazwa hosta: Dokładna nazwa hosta (na przykład "contoso.sharepoint.com")
  • serverRelativePath: Ścieżka względna serwera (na przykład "sites/Marketing"). Ukośnik wiodący jest opcjonalny.

listSubsites

Wyświetla listę wszystkich podwitryn (witryn podrzędnych) witryny SharePoint.

Wymagane parametry:

  • siteId: identyfikator witryny SharePoint nadrzędnej (format: "nazwa hosta,siteCollectionId,webId")

wymieńBibliotekiDokumentówNaWitrynie

Wyświetla listę bibliotek dokumentów (dysków) w określonej witrynie SharePoint.

Parametry opcjonalne:

  • siteId: identyfikator witryny SharePoint (wartość domyślna: "root")

PobierzDomyślnąBibliotekęDokumentówWSerwisie

Pobiera domyślną bibliotekę dokumentów (dysk) w witrynie SharePoint.

Parametry opcjonalne:

  • siteId: identyfikator witryny SharePoint (wartość domyślna: "root")

getFolderChildren

Wylicza 20 pierwszych plików i folderów (DriveItems) zawartych w określonym folderze nadrzędnym w bibliotece dokumentów (dysku).

Wymagane parametry:

  • documentLibraryId: Identyfikator biblioteki dokumentów (dysk)

Parametry opcjonalne:

  • parentFolderId: ID folderu nadrzędnego (domyślnie: 'root').

findFileOrFolder

Znajduje plik lub folder (DriveItem) dostępny dla użytkownika przez zapytanie wyszukiwania. Wyszukuje we wszystkich witrynach i bibliotekach dokumentów, do których użytkownik ma dostęp.

Wymagane parametry:

  • searchQuery: Kwerenda wyszukiwania (cała lub częściowa nazwa pliku)

getFileOrFolderMetadata

Pobiera metadane pliku lub folderu (DriveItem) z określonej biblioteki dokumentów (dysku) w SharePoint.

Wymagane parametry:

  • fileOrFolderId: Identyfikator pliku lub folderu (DriveItem)
  • documentLibraryId: Identyfikator biblioteki dokumentów (dysk)

getFileOrFolderMetadataByUrl

Pobiera metadane pliku lub folderu (DriveItem) z udostępniającego URL. Metadane mogą uzyskać tylko użytkownicy z istniejącymi jawnymi uprawnieniami dostępu do pliku.

Wymagane parametry:

  • fileOrFolderUrl: Adres URL pliku lub folderu. Adres URL nie służy do udostępniania zasobu użytkownikowi; użytkownik musi już mieć wyraźnie przyznany dostęp.

readSmallTextFile

Odczytuje (pobiera) plik tekstowy mniejszy niż 5 MB z konkretnej biblioteki dokumentów (dysku).

Wymagane parametry:

  • fileId: Identyfikator pliku (DriveItem) do odczytu lub pobrania
  • documentLibraryId: Identyfikator biblioteki dokumentów (dysk)

readSmallBinaryFile

Odczytuje plik binarny mniejszy niż 5 MB z określonej biblioteki dokumentów (dysku). Zawartość pliku jest zwracana jako ciąg zakodowany w formacie base64.

Wymagane parametry:

  • fileId: Identyfikator pliku (DriveItem) do odczytu lub pobrania
  • documentLibraryId: Identyfikator biblioteki dokumentów (dysk)

createSmallTextFile

Tworzy lub przesyła plik tekstowy mniejszy niż 5 MB do konkretnej biblioteki dokumentów (dysku).

Wymagane parametry:

  • Nazwa pliku: Nazwa pliku wraz z rozszerzeniem.
  • contentTekst: Zawartość tekstu pliku.
  • documentLibraryId: Identyfikator biblioteki dokumentów (dysk)

Parametry opcjonalne:

  • parentFolderId: ID folderu nadrzędnego (domyślnie: 'root').

createSmallBinaryFile

Tworzy plik binarny mniejszy niż 5 MB przez kodowanie zawartości base64 do określonej biblioteki dokumentów (dysku).

Wymagane parametry:

  • Nazwa pliku: Nazwa pliku wraz z rozszerzeniem.
  • base64Content: Zawartość pliku binarnego zakodowana jako ciąg base64.
  • documentLibraryId: Identyfikator biblioteki dokumentów (dysk)

Parametry opcjonalne:

  • parentFolderId: ID folderu nadrzędnego (domyślnie: 'root').

utwórzFolder

Tworzy nowy folder (DriveItem) w określonej bibliotece dokumentów (dysku). Jeśli istnieje folder o tej samej nazwie, system dodaje sufiks liczbowy (na przykład NewFolder (1)).

Wymagane parametry:

  • Nazwa_folderu: Nazwa folderu
  • documentLibraryId: Identyfikator biblioteki dokumentów (dysk)

Parametry opcjonalne:

  • parentFolderId: ID folderu nadrzędnego (domyślnie: 'root').

zmieńNazwęPlikuLubFolderu

Zmienia nazwę pliku lub folderu (DriveItem) w określonej bibliotece dokumentów (dysku). Nowa nazwa musi być zgodna z konwencjami nazewnictwa.

Wymagane parametry:

  • documentLibraryId: Identyfikator biblioteki dokumentów (dysk)
  • fileOrFolderId: Identyfikator pliku lub folderu do zmiany nazwy
  • newFileOrFolderName: Nowa nazwa

Parametry opcjonalne:

  • etag: ETag do kontroli współbieżności

deleteFileOrFolder

Usuwa plik lub folder (DriveItem) z określonej biblioteki dokumentów (dysku).

Wymagane parametry:

  • documentLibraryId: Identyfikator biblioteki dokumentów (dysk)
  • fileOrFolderId: Identyfikator pliku lub folderu do usunięcia

Parametry opcjonalne:

  • etag: ETag do kontroli współbieżności

moveFileOrFolder

Przenosi plik lub folder (DriveItem) do folderu docelowego. Obsługuje przenoszenie między różnymi bibliotekami dokumentów (dyskami) w SharePoint. Ta operacja jest asynchroniczna. Użyj checkOperationStatus, aby monitorować postęp.

Wymagane parametry:

  • sourcedoclibid: Identyfikator źródłowej biblioteki dokumentów (dysku)
  • sourcefileid: Identyfikator pliku źródłowego lub folderu do przeniesienia
  • destdoclibid: Identyfikator docelowej biblioteki dokumentów (dysku)
  • destfolderid: Identyfikator folderu docelowego (musi istnieć)

Parametry opcjonalne:

  • newfilename: Nowa nazwa przeniesionego elementu

kopiujPlikLubFolder

Kopiuje plik lub folder (DriveItem) do folderu docelowego. Obsługuje kopiowanie między różnymi bibliotekami dokumentów w SharePoint. Ta operacja jest asynchroniczna. Użyj checkOperationStatus, aby monitorować postęp.

Wymagane parametry:

  • sourcedoclibid: Identyfikator źródłowej biblioteki dokumentów (dysku)
  • sourcefileid: Identyfikator pliku lub folderu źródłowego do skopiowania
  • destdoclibid: Identyfikator docelowej biblioteki dokumentów (dysku)
  • destfolderid: Identyfikator folderu docelowego (musi istnieć)

Parametry opcjonalne:

  • newfilename: Nowa nazwa skopiowanego elementu

checkOperationStatus

Sprawdza stan operacji asynchronicznej, takiej jak kopiowanie lub przenoszenie, przy użyciu tokenu operacji zwróconego z oryginalnej operacji.

Wymagane parametry:

  • operationToken: Token operacji zwrócony przez operację asynchroniczną, taką jak copyFileOrFolder lub moveFileOrFolder

uploadFileFromUrl

Przekazuje plik z adresu URL SharePoint lub OneDrive do folderu docelowego w bibliotece dokumentów (dysku). Plik jest kopiowany ze źródłowego adresu URL, więc oryginalny plik nie jest zmieniany.

Wymagane parametry:

  • sourceUrl: Źródłowy adres URL (musi być prawidłowym adresem URL SharePoint lub OneDrive)
  • destinationDocumentLibraryId: Identyfikator docelowej biblioteki dokumentów. Użyj me dla OneDrive użytkownika

Parametry opcjonalne:

  • destinationFolderId: Identyfikator folderu docelowego (wartość domyślna: root)
  • Nazwa pliku: Nowa nazwa pliku; domyślnie używana jest oryginalna nazwa pliku

udostępnijPlikLubFolder

Wysyła zaproszenie do udostępniania, aby udzielić uprawnień do odczytu lub zapisu w pliku lub folderze (DriveItem) w określonej bibliotece dokumentów (dysku).

Wymagane parametry:

  • documentLibraryId: Identyfikator biblioteki dokumentów (dysk)
  • fileOrFolderId: Identyfikator pliku lub folderu do udostępnienia
  • recipientEmails: Tablica adresów e-mail adresatów
  • role: Tablica ról: 'read', 'write' ('write' przyznaje uprawnienia do odczytu i zapisu)

Parametry opcjonalne:

  • Komunikat: Niestandardowa wiadomość e-mail z zaproszeniem (domyślnie: oto plik, nad który współpracujemy).
  • sendInvitation: Czy wysłać zaproszenie do udostępniania (ustawienie domyślne: true)

ustawEtykietęCzułościNaPliku

Ustawia etykietę poufności pliku z określonej biblioteki dokumentów (dysku).

Wymagane parametry:

  • documentLibraryId: Identyfikator biblioteki dokumentów (dysk)
  • fileId: Identyfikator pliku (DriveItem)
  • sensitivityLabelId: Identyfikator etykiety poufności, lub pusty ciąg, aby ją usunąć

Parametry opcjonalne:

  • assignmentMethod: Metoda przypisania: "standard", "privileged", "auto" lub "unknownFutureValue" (Domyślnie: "privileged")
  • uzasadnienieTekst: Tekst uzasadnienia do celów audytu; wymagany przy obniżaniu poziomu lub usuwaniu etykiety (ustawienie domyślne: "Zmieniono przez MCPServer")

listLists

Pobiera wszystkie listy SharePoint dostępne w określonej witrynie. Użyj, aby dowiedzieć się, jakie listy istnieją w witrynie.

Wymagane parametry:

  • siteId: Identyfikator witryny programu SharePoint (w formacie: "nazwa hosta,siteCollectionId,webId")

createList

Tworzy nową listę programu SharePoint w witrynie.

Wymagane parametry:

  • siteId: identyfikator witryny SharePoint
  • Displayname: Nazwa wyświetlana nowej listy

Parametry opcjonalne:

  • Kolumny: Kolekcja kolumn jako par klucz-wartość: [{ Key: 'JobTitle', Value: 'text' }]. Prawidłowe typy: text, multilineText, number, boolean, dateTime, choice, lookup, personOrGroup, hyperlink, currency, calculated
  • template: Typ szablonu dla listy (wartość domyślna: „genericList”). Opcje: lista ogólna, biblioteka dokumentów, wydarzenia, zadania, ogłoszenia, kontakty, linki, ankieta, śledzenie problemów, forum dyskusyjne

deleteList

Usuwa SharePoint list z witryny. Usuwa cały kontener listy i wszystkie elementy w nim. Tej akcji nie można cofnąć.

Wymagane parametry:

  • siteId: identyfikator witryny SharePoint
  • listId: Identyfikator listy do usunięcia

Parametry opcjonalne:

  • etag: ETag do kontroli współbieżności

sendInviteForList

Wysyła zaproszenie do udostępniania, aby nadać uprawnienia do listy SharePoint.

Wymagane parametry:

  • listId: identyfikator listy programu SharePoint do udostępnienia
  • recipientEmails: Tablica adresów e-mail adresatów
  • rola: Rola: „odczyt” (tylko wyświetlanie), „współtworzenie” (wyświetlanie, dodawanie, aktualizowanie i usuwanie elementów), „edycja” (pełna edycja, w tym struktury listy)

Parametry opcjonalne:

  • siteUrl: adres URL witryny SharePoint zawierającej listę
  • sendEmail: Czy wysłać powiadomienie e-mail (ustawienie domyślne: true)

listListItems

Pobiera elementy (wiersze/rekordy) z określonej listy SharePoint.

Wymagane parametry:

  • siteId: identyfikator witryny SharePoint
  • listId: identyfikator listy programu SharePoint

getListItem

Otrzymuje pojedynczy element (wiersz lub rekord) z SharePoint list na podstawie jego ID.

Wymagane parametry:

  • siteId: identyfikator witryny SharePoint
  • listId: identyfikator listy programu SharePoint
  • Itemid: Identyfikator określonego elementu listy

createListItem

Tworzy nowy element (wiersz lub rekord) na liście SharePoint.

Wymagane parametry:

  • siteId: identyfikator witryny SharePoint
  • listId: identyfikator listy programu SharePoint
  • Pola: Pary klucz-wartość dla wartości pól, takie jak [{ Key: 'Title', Value: 'Software Engineer' }, { Key: 'Department', Value: 'Engineering' }]. Zazwyczaj wymagane jest pole 'Tytuł'.

updateListItem

Aktualizuje istniejący element (wiersz lub rekord) na liście SharePoint. Tylko określone pola są aktualizowane; pominięte pola zachowują swoje wartości.

Wymagane parametry:

  • siteId: identyfikator witryny SharePoint
  • listId: identyfikator listy programu SharePoint
  • Itemid: Identyfikator elementu do zaktualizowania
  • Pola: Pary klucz-wartość pól do zaktualizowania

Parametry opcjonalne:

  • etag: ETag do kontroli współbieżności

deleteListItem

Usuwa element (wiersz lub rekord) z listy programu SharePoint.

Wymagane parametry:

  • siteId: identyfikator witryny SharePoint
  • listId: identyfikator listy programu SharePoint
  • Itemid: Identyfikator elementu do usunięcia

Parametry opcjonalne:

  • etag: ETag do kontroli współbieżności

listColumns (wylistujKolumny)

Pobiera wszystkie kolumny z listy SharePoint.

Wymagane parametry:

  • siteId: identyfikator witryny SharePoint
  • listId: identyfikator listy programu SharePoint

createColumn

Tworzy nową kolumnę na liście programu SharePoint. Obsługuje wiele typów kolumn, takich jak tekst, liczba, wybór, data/godzina, wartość logiczna, użytkownik, wyszukiwanie, obliczanie i inne.

Wymagane parametry:

  • siteId: identyfikator witryny SharePoint
  • listId: identyfikator listy programu SharePoint
  • Nazwa: Nazwa kolumny wewnętrznej (identyfikator programowy)
  • Columntype: Typ kolumny: text, note, number, integer, boolean, dateTime, choice, multichoice, currency, lookup, user, url, calculated, term, multiterm, location, geolocation, thumbnail, counter, computed, contentTypeId, file, attachment, guid, resultChoice, approvalStatus

Parametry opcjonalne:

  • columnProperties: Ustawienia specyficzne dla typu (na przykład { "maxLength": 255 } dla tekstu, { "choices": ["A","B","C"] } do wyboru)
  • Opis: Opis kolumny
  • displayName: Nazwa wyświetlana w interfejsie użytkownika (domyślnie: „name”)
  • Wymagane: Ustaw wymaganą kolumnę (wartość domyślna: false)
  • Ukryte: Ukryj kolumnę z widoków (wartość domyślna: false)

Zaktualizuj kolumnę

Aktualizuje istniejącą kolumnę na liście SharePoint.

Wymagane parametry:

  • siteId: identyfikator witryny SharePoint
  • listId: identyfikator listy programu SharePoint
  • Columnid: Identyfikator kolumny do zaktualizowania

Parametry opcjonalne:

  • Columntype: Typ kolumny (wymagany podczas podawania właściwości "columnProperties")
  • columnProperties: Właściwości specyficzne dla typu do zaktualizowania
  • Opis: Nowy opis
  • Displayname: Nowa nazwa wyświetlana
  • Ukryte: Ukrywanie lub pokazywanie kolumny
  • Wymagane: Ustaw kolumnę jako wymaganą lub opcjonalną

Usuń kolumnę

Usuwa kolumnę z SharePoint list. Ostrzeżenie: Ta akcja usuwa wszystkie dane przechowywane w tej kolumnie dla wszystkich elementów.

Wymagane parametry:

  • siteId: identyfikator witryny SharePoint
  • listId: identyfikator listy programu SharePoint
  • Columnid: Identyfikator kolumny do usunięcia

Kluczowe funkcje

Zarządzanie lokacjami

  • Znajdź witryny według nazwy lub przeglądaj dostępne witryny.
  • Pobieranie witryny na podstawie dokładnej ścieżki URL.
  • Wyświetlanie listy witryn podrzędnych i podwitryn.
  • Kompleksowa nawigacja w hierarchii lokacji.

Zarządzanie biblioteką dokumentów

  • Wyświetl listę wszystkich bibliotek dokumentów w witrynie.
  • Pobierz domyślną bibliotekę dokumentów.
  • Przeglądaj zawartość folderów (do 20 pozycji).
  • Tworzenie struktur folderów i zarządzanie nimi.

Operacje na plikach

  • Twórz pliki tekstowe i binarne (5 MB lub mniej).
  • Czytaj tekst i pliki binarne (5 MB lub mniej).
  • Usuwanie, zmienianie nazwy i przenoszenie plików i folderów.
  • Kopiowanie plików i folderów między bibliotekami dokumentów.
  • Przekazywanie plików z adresów URL SharePoint lub OneDrive.
  • Wyszukaj pliki i foldery we wszystkich dostępnych witrynach.
  • Pobieranie metadanych plików i folderów.

Operacje asynchroniczne

  • Kopiowanie i przenoszenie plików i folderów asynchronicznie między bibliotekami dokumentów.
  • Sprawdź stan operacji asynchronicznych przy użyciu tokenów operacji.

Lista operacji

  • Tworzyć, odczytywać i usuwać listy.
  • Obsługa wielu szablonów list, w tym ogólnych, bibliotek dokumentów, zdarzeń i zadań.
  • Udostępniaj listy z uprawnieniami opartymi na rolach.
  • Zarządzaj elementami listy, tworząc, odczytując, aktualizując i usuwając je.

Zarządzanie kolumnami

  • Utwórz kolumny z szeroką gamą typów, takich jak tekst, uwaga, liczba, wartość logiczna, data/godzina, wybór, wyszukiwanie, użytkownik, adres URL, obliczane i inne.
  • Aktualizowanie właściwości i metadanych kolumn.
  • Konfigurowanie wymagań i widoczności kolumn.
  • Ustaw właściwości kolumny specyficzne dla typu.

Udostępnianie i uprawnienia

  • Udostępnianie plików, folderów i list użytkownikom.
  • Użyj kontroli dostępu opartej na rolach z rolami odczytu, zapisu, współtworzenia i edycji.
  • Powiadomienia e-mail do udostępnienia.
  • Niestandardowe wiadomości w zaproszeniach.

Zabezpieczenia i zgodność

  • Stosuj i usuwaj etykiety poufności.
  • Użyj wielu metod przypisywania, w tym standardowych, uprzywilejowanych i automatycznych.
  • Obsługa uzasadnienia audytu.
  • Użyj kontroli współbieżności za pomocą znaczników ETag.

Notatki

  • Operacje na plikach są ograniczone do plików o rozmiarze 5 MB lub mniejszym podczas przesyłania i pobierania.
  • Operacje kopiowania i przenoszenia są asynchroniczne. Użyj checkOperationStatus, aby monitorować postęp.
  • Operacje kopiowania i przenoszenia obsługują operacje między bibliotekami w SharePoint.
  • uploadFileFromUrl wymaga prawidłowego adresu URL źródłowego SharePoint lub OneDrive.
  • eTagi zapewniają kontrolę współbieżności dla aktualizacji i usuwania.
  • Automatyczny przyrostek numeryczny dla zduplikowanych nazw folderów.
  • Nie można cofnąć usuwania listy.
  • Usunięcie kolumny usuwa wszystkie dane przechowywane w tej kolumnie.
  • Operacje wyszukiwania domyślnie zwracają 20 pierwszych wyników.