Referenční informace k SharePointu (náhled)

Note

Tento článek popisuje funkce používané v agentech nebo tocích agentů využívajících standardní harness.

Important

Toto je funkce Preview.

• Microsoft uvolňuje funkce ve verzi Preview před oficiálním vydáním, aby k nim zákazníci mohli získat předběžný přístup a poskytnout zpětnou vazbu.
• Funkce ve verzi Preview mají omezené funkce a nejsou určené pro produkční použití.
• Microsoft můžou změnit názvy a parametry nástrojů MCP ve verzi Preview. Vyhněte se pevně zakódovaným závislostem. Microsoft udržuje podporu scénářů.
• Funkce ve verzi Preview podléhají Microsoft dodatečným podmínkám použití.

Přehled

ID serveru	Adresa URL na úrovni tenanta	Zobrazované jméno	Description
mcp_SharePointRemoteServer	https://agent365.svc.cloud.microsoft/ agents/tenants/{tenantId}/servers/ mcp_SharePointRemoteServer	Služba SharePoint	Nástroje pro provoz SharePoint. Tento server slouží ke správě webů, seznamů, položek seznamů, sloupců, knihoven dokumentů, souborů, složek a sdílení souborů. Operace se soubory jsou omezené na soubory, které jsou 5 MB nebo méně.

Dostupné nástroje

findSite

Najde SharePoint weby, ke kterým máte přístup. Vrátí konkrétní weby, které odpovídají vyhledávacímu dotazu, nebo prvních 20 relevantních webů, pokud dotaz nezadáte.

Volitelné parametry:

• searchQuery: Vyhledávací dotaz (celý nebo částečný název webu). Vynechání vrácení nejlepších 20 přístupných webů.

getSiteByPath

Rozpozná web SharePoint pomocí jeho přesného názvu hostitele a cesty relativní k serveru. Tuto metodu použijte pouze v případě, že máte úplnou strukturu adresy URL webu. Použijte findSite , když znáte jenom název webu.

Požadované parametry:

• Hostname: Přesný název hostitele (například contoso.sharepoint.com)
• serverRelativePath: Cesta relativní k serveru (například „sites/Marketing“). Počáteční lomítko je volitelné.

listSubsites

Vypíše všechny podřízené weby webu SharePoint.

Požadované parametry:

• siteId: ID nadřazeného webu SharePoint (formát: název hostitele, siteCollectionId,webId)

seznamKnihovenDokumentůNaWebu

Vypíše knihovny dokumentů (drives) v zadaném webu SharePointu.

Volitelné parametry:

• siteId: ID webu SharePoint (výchozí hodnota: root)

getDefaultDocumentLibraryInSite

Získá výchozí knihovnu dokumentů (drive) na webu SharePointu.

Volitelné parametry:

• siteId: ID webu SharePoint (výchozí hodnota: root)

getFolderChildren

Vrátí seznam prvních 20 souborů a složek (DriveItems) obsažených v zadané nadřazené složce v knihovně dokumentů (drive).

Požadované parametry:

• documentLibraryId: ID knihovny dokumentů (drive)

Volitelné parametry:

• parentFolderId: ID nadřazené složky (výchozí: 'root').

findFileOrFolder

Vyhledá soubor nebo složku (DriveItem) přístupný uživateli pomocí vyhledávacího dotazu. Vyhledá na všech webech a knihovnách dokumentů, ke které má uživatel přístup.

Požadované parametry:

• searchQuery: Vyhledávací dotaz (celý nebo částečný název souboru)

getFileOrFolderMetadata

Získá metadata souboru nebo složky (DriveItem) v zadané knihovně dokumentů (disk) v SharePointu.

Požadované parametry:

• fileOrFolderId: ID souboru nebo složky (DriveItem)
• documentLibraryId: ID knihovny dokumentů (drive)

getFileOrFolderMetadataByUrl

Získává metadata souboru nebo složky (DriveItem) ze sdílené URL. Metadata můžou získat jenom uživatelé s existujícími explicitními oprávněními pro přístup k souboru.

Požadované parametry:

• fileOrFolderUrl: Adresa URL souboru nebo složky Adresa URL není využita ke sdílení s uživatelem; uživatel již musí mít výslovný přístup.

readSmallTextFile

Čte (stáhne) textový soubor menší než 5 MB z konkrétní dokumentové knihovny (disku).

Požadované parametry:

• fileId: ID souboru (DriveItem) ke čtení nebo stažení
• documentLibraryId: ID knihovny dokumentů (drive)

readSmallBinaryFile

Načte binární soubor o velikosti menší než 5 MB z konkrétní knihovny dokumentů (drive). Obsah souboru se vrátí jako řetězec s kódováním base64.

Požadované parametry:

• fileId: ID souboru (DriveItem) ke čtení nebo stažení
• documentLibraryId: ID knihovny dokumentů (drive)

createSmallTextFile

Vytvoří nebo nahraje textový soubor menší než 5 MB do konkrétní knihovny dokumentů (disku).

Požadované parametry:

• Název souboru: Název souboru včetně přípony.
• obsahText: Textový obsah souboru.
• documentLibraryId: ID knihovny dokumentů (drive)

Volitelné parametry:

• parentFolderId: ID nadřazené složky (výchozí: 'root').

createSmallBinaryFile

Vytvoří binární soubor menší než 5 MB v konkrétní knihovně dokumentů (úložišti) zakódováním jeho obsahu ve formátu Base64.

Požadované parametry:

• Název souboru: Název souboru včetně přípony.
• base64Content: Obsah binárního souboru zakódovaný jako řetězec base64.
• documentLibraryId: ID knihovny dokumentů (drive)

Volitelné parametry:

• parentFolderId: ID nadřazené složky (výchozí: 'root').

vytvořitSložku

Vytvoří novou složku (DriveItem) v zadané knihovně dokumentů (drive). Pokud existuje složka se stejným názvem, systém přidá číselnou příponu (například NewFolder (1)).

Požadované parametry:

• Název_složky: Název složky
• documentLibraryId: ID knihovny dokumentů (drive)

Volitelné parametry:

• parentFolderId: ID nadřazené složky (výchozí: 'root').

přejmenovatSouborNeboSložku

Přejmenuje soubor nebo složku (DriveItem) v zadané knihovně dokumentů (drive). Nový název musí splňovat zásady vytváření názvů.

Požadované parametry:

• documentLibraryId: ID knihovny dokumentů (drive)
• fileOrFolderId: ID souboru nebo složky k přejmenování
• newFileOrFolderName: Nový název

Volitelné parametry:

• etag: ETag pro řízení souběžnosti

deleteFileOrFolder

Odstraní soubor nebo složku (DriveItem) v zadané knihovně dokumentů (disk).

Požadované parametry:

• documentLibraryId: ID knihovny dokumentů (drive)
• fileOrFolderId: ID souboru nebo složky k odstranění

Volitelné parametry:

• etag: ETag pro řízení souběžnosti

přesunoutSouborNeboSložku

Přesune soubor nebo složku (DriveItem) do cílové složky. Podporuje přesouvání mezi různými knihovnami dokumentů (úložišti) v SharePointu. Tato operace je asynchronní. Slouží checkOperationStatus k monitorování průběhu.

Požadované parametry:

• sourcedoclibid: ID zdrojové knihovny dokumentů (jednotka)
• sourcefileid: ID zdrojového souboru nebo složky, které chcete přesunout
• destdoclibid: ID cílové knihovny dokumentů (úložiště)
• destfolderid: ID cílové složky (musí existovat)

Volitelné parametry:

• newfilename: Nový název přesunuté položky

kopírovatSouborNeboSložku

Zkopíruje soubor nebo složku (DriveItem) do cílové složky. Podporuje kopírování mezi různými knihovnami dokumentů v rámci SharePoint. Tato operace je asynchronní. Slouží checkOperationStatus k monitorování průběhu.

Požadované parametry:

• sourcedoclibid: ID zdrojové knihovny dokumentů (jednotka)
• sourcefileid: ID zdrojového souboru nebo složky ke zkopírování
• destdoclibid: ID cílové knihovny dokumentů (úložiště)
• destfolderid: ID cílové složky (musí existovat)

Volitelné parametry:

• newfilename: Nový název zkopírované položky

checkOperationStatus

Zkontroluje stav asynchronní operace, například kopírování nebo přesunutí, pomocí tokenu operace vráceného z původní operace.

Požadované parametry:

• operationToken: Token operace vrácený z asynchronní operace, jako je copyFileOrFolder nebo moveFileOrFolder

uploadFileFromUrl

Nahraje soubor z adresy URL služby SharePoint nebo OneDrive do cílové složky knihovny dokumentů (jednotky). Soubor se zkopíruje ze zdrojové adresy URL, takže původní soubor se nezmění.

Požadované parametry:

• sourceUrl: Zdrojová adresa URL (musí být platná SharePoint nebo adresa URL OneDrive)
• destinationDocumentLibraryId: ID cílové knihovny dokumentů. Použijte me pro uživatelův OneDrive

Volitelné parametry:

• destinationFolderId: ID cílové složky (výchozí: root)
• Název_souboru: Nový název souboru; výchozí hodnota původního názvu souboru

sdílejSouborNeboSložku

Odešle pozvánku ke sdílení k udělení oprávnění ke čtení nebo zápisu pro soubor nebo složku (DriveItem) v zadané knihovně dokumentů (drive).

Požadované parametry:

• documentLibraryId: ID knihovny dokumentů (drive)
• fileOrFolderId: ID souboru nebo složky ke sdílení
• recipientEmails: Pole e-mailových adres příjemců
• roles: Pole rolí: 'read', 'write' ('write' zahrnuje oprávnění ke čtení i zápisu)

Volitelné parametry:

• zpráva: Vlastní zpráva pro e-mail s pozvánkou (výchozí: Toto je soubor, na kterém spolupracujeme.)
• sendInvitation: Jestli chcete poslat pozvánku ke sdílení (výchozí hodnota: true)

setSensitivityLabelOnFile

Nastaví štítek citlivosti u souboru ze zadané knihovny dokumentů (disku).

Požadované parametry:

• documentLibraryId: ID knihovny dokumentů (drive)
• fileId: ID souboru (DriveItem)
• sensitivityLabelId: ID popisku citlivosti nebo prázdný řetězec, který chcete odebrat

Volitelné parametry:

• assignmentMethod: Metoda přiřazení: "standard", "privileged", "auto" nebo "unknownFutureValue" (výchozí hodnota: privilegovaná)
• justificationText: Text odůvodnění pro účely auditu; vyžadováno při snížení úrovně nebo odebrání štítku (výchozí hodnota: 'Změnil MCPServer')

listLists

Získá všechny SharePoint seznamy dostupné na konkrétním webu. Umožňuje zjistit, jaké seznamy existují v rámci webu.

Požadované parametry:

• siteId: ID webu SharePoint (formát: název hostitele, siteCollectionId,webId)

createList

Vytvoří nový SharePoint list v rámci webu.

Požadované parametry:

• siteId: ID webu SharePoint
• Displayname: Zobrazovaný název nového seznamu

Volitelné parametry:

• Sloupce: Kolekce sloupců ve formě dvojic klíč–hodnota: [{ Key: 'JobTitle', Value: 'text' }]. Platné typy: text, multilineText, number, boolean, dateTime, choice, lookup, personOrGroup, hyperlink, currency, calculated
• Šablony: Typ šablony seznamu (výchozí hodnota: genericList) Možnosti: obecný seznam, knihovna dokumentů, události, úkoly, oznámení, kontakty, odkazy, průzkum, sledování problémů, diskusní fórum

Odstranit seznam

Odstraní SharePoint list z webu. Odstraní celý kontejner seznamu a všechny položky v něm. Tuto akci nelze vrátit zpět.

Požadované parametry:

• siteId: ID webu SharePoint
• listId: ID seznamu k odstranění

Volitelné parametry:

• etag: ETag pro řízení souběžnosti

sendInviteForList

Odešle pozvánku ke sdílení za účelem udělení oprávnění k seznamu SharePointu.

Požadované parametry:

• listId: ID seznamu SharePointu ke sdílení
• recipientEmails: Pole e-mailových adres příjemců
• role: Role: 'read' (pouze zobrazení), 'contribute' (zobrazení, přidávání, aktualizace a odstraňování položek), 'edit' (úplné úpravy včetně struktury seznamu)

Volitelné parametry:

• siteUrl: Adresa URL webu SharePoint obsahujícího seznam
• sendEmail: Zda se má odeslat e-mailové oznámení (výchozí hodnota: true)

listListItems

Získá položky (řádky/záznamy) z konkrétního seznamu SharePointu.

Požadované parametry:

• siteId: ID webu SharePoint
• listId: ID seznamu SharePoint

getListItem

Získá jednu položku (řádek nebo záznam) ze seznamu SharePointu na základě jejího ID.

Požadované parametry:

• siteId: ID webu SharePoint
• listId: ID seznamu SharePoint
• Itemid: ID konkrétní položky seznamu

createListItem

Vytvoří novou položku (řádek nebo záznam) v SharePoint list.

Požadované parametry:

• siteId: ID webu SharePoint
• listId: ID seznamu SharePoint
• Pole: Dvojice klíč–hodnota představující hodnoty polí, například [{ Key: 'Title', Value: 'Software Engineer' }, { Key: 'Department', Value: 'Engineering' }]. Obvykle je vyžadováno pole 'Název'.

updateListItem

Aktualizuje existující položku (řádek nebo záznam) v SharePoint list. Aktualizují se pouze zadaná pole; Vynechaná pole zachovávají jejich hodnoty.

Požadované parametry:

• siteId: ID webu SharePoint
• listId: ID seznamu SharePoint
• Itemid: ID položky, která se má aktualizovat
• pole: Páry klíč–hodnota polí, která se mají aktualizovat

Volitelné parametry:

• etag: ETag pro řízení souběžnosti

deleteListItem

Odstraní položku (řádek nebo záznam) z SharePoint list.

Požadované parametry:

• siteId: ID webu SharePoint
• listId: ID seznamu SharePoint
• Itemid: ID položky k odstranění

Volitelné parametry:

• etag: ETag pro řízení souběžnosti

listColumns

Získá všechny sloupce ze seznamu služby SharePoint.

Požadované parametry:

• siteId: ID webu SharePoint
• listId: ID seznamu SharePoint

createColumn

Vytvoří nový sloupec v seznamu SharePointu. Podporuje mnoho typů sloupců včetně typů text, number, choice, dateTime, boolean, user, lookup, calculated a dalších

Požadované parametry:

• siteId: ID webu SharePoint
• listId: ID seznamu SharePoint
• Jméno: Název interního sloupce (programový identifikátor)
• columnType: Typ sloupce: text, note, number, integer, boolean, dateTime, choice, multichoice, currency, lookup, user, url, calculated, term, multiterm, location, geolocation, thumbnail, counter, computed, contentTypeId, file, attachment, guid, outcomeChoice, approvalStatus

Volitelné parametry:

• columnProperties: Nastavení specifická pro typ (například { "maxLength": 255 } pro text, { "choices": ["A","B","C"] } pro volbu)
• Popis: Popis sloupce
• Displayname: Zobrazovaný název zobrazený v uživatelském rozhraní (výchozí hodnota je název)
• Požadované: Nastavení požadovaného sloupce (výchozí hodnota: false)
• Skryté: Skrytí sloupce ze zobrazení (výchozí hodnota: false)

aktualizovat sloupec

Aktualizuje existující sloupec v SharePoint list.

Požadované parametry:

• siteId: ID webu SharePoint
• listId: ID seznamu SharePoint
• columnId: ID sloupce, který se má aktualizovat

Volitelné parametry:

• columnType: Typ sloupce (povinný při zadání parametru 'columnProperties')
• columnProperties: Vlastnosti specifické pro typ, které se mají aktualizovat
• Popis: Nový popis
• Displayname: Nový zobrazovaný název
• Skryté: Skrytí nebo zobrazení sloupce
• Požadované: Nastavení sloupce jako povinného nebo volitelného

Odstranit sloupec

Odstraní sloupec ze seznamu SharePointu. Upozornění: Tato akce odebere všechna data uložená v tomto sloupci pro všechny položky.

Požadované parametry:

• siteId: ID webu SharePoint
• listId: ID seznamu SharePoint
• columnId: ID sloupce, který chcete odstranit

Klíčové funkce

Správa lokality

• Vyhledejte weby podle názvu nebo procházejte přístupné weby.
• Získejte web podle přesné cesty URL.
• Vypište podřízené weby a podweby.
• Komplexní navigace v hierarchii webu

Správa knihoven dokumentů

• Zobrazí seznam všech knihoven dokumentů na webu.
• Získejte výchozí knihovnu dokumentů.
• Prohledejte obsah složek (až 20 položek).
• Vytvářejte a spravujte struktury složek.

Operace se soubory

• Vytvářejte textové a binární soubory (5 MB nebo méně).
• Čtěte textové a binární soubory (5 MB nebo méně).
• Odstraňte, přejmenujte a přesuňte soubory a složky.
• Kopírování souborů a složek napříč knihovnami dokumentů
• Nahrajte soubory z adres URL SharePoint nebo OneDrive.
• Vyhledejte soubory a složky na všech přístupných webech.
• Získejte metadata souborů a složek.

Asynchronní operace

• Kopírování a přesouvání souborů a složek asynchronně napříč knihovnami dokumentů
• Zkontrolujte stav asynchronních operací pomocí tokenů operací.

Operace seznamu

• Vytváření, čtení a odstraňování seznamů
• Podpora více šablon seznamů, včetně obecných, knihoven dokumentů, událostí a úkolů
• Sdílejte seznamy s oprávněními založenými na rolích.
• Spravovat položky seznamu vytvořením, čtením, aktualizací a odstraněním položek seznamu.

Správa sloupců

• Vytvářejte sloupce s širokou škálou typů, jako je text, poznámka, číslo, logická hodnota, datum a čas, volba, vyhledávání, uživatel, adresa URL, počítané a další.
• Aktualizujte vlastnosti a metadata sloupců.
• Nakonfigurujte požadavky na sloupce a viditelnost.
• Nastavte vlastnosti sloupce specifické pro typ.

Sdílení a oprávnění

• Sdílejte soubory, složky a seznamy s uživateli.
• Pomocí řízení přístupu na základě role můžete používat role pro čtení, zápis, přispívání a úpravy.
• E-mailová upozornění ke sdílení.
• Vlastní zprávy v pozvánkách.

Zabezpečení a dodržování předpisů

• Použití a odebrání popisků citlivosti
• Použijte více metod přiřazení, včetně standardních, privilegovaných a automatických.
• Podpora odůvodnění auditu
• Používejte řízení souběhu pomocí značek eTag.

Poznámky

• Operace se soubory jsou omezené na soubory, které jsou 5 MB nebo méně pro nahrávání a stahování.
• Operace kopírování a přesouvání jsou asynchronní. Slouží checkOperationStatus k monitorování průběhu.
• Operace kopírování a přesouvání podporují operace mezi knihovnami v SharePointu.
• uploadFileFromUrl vyžaduje platnou adresu URL zdroje SharePoint nebo OneDrive.
• Značky eTag zajišťují řízení souběžného přístupu při aktualizacích a odstraňování.
• Automatická číselná přípona pro duplicitní názvy složek.
• Odstranění seznamu nejde vrátit zpět.
• Odstranění sloupce odebere všechna data uložená v daném sloupci.
• Vyhledávací operace ve výchozím nastavení vrací prvních 20 výsledků.