SharePoint-referens (förhandsvisning)

Overview

Tillgängliga verktyg

hittaSida

Hittar SharePoint webbplatser som du kan komma åt. Returnerar specifika webbplatser som matchar en sökfråga eller de 20 viktigaste relevanta webbplatserna om du inte anger en fråga.

Valfria parametrar:

• searchQuery: Sökfråga (helt eller delvis webbplatsnamn). Utelämna för att returnera de 20 åtkomliga webbplatserna.

getSiteByPath

Identifierar en SharePoint-webbplats genom att använda dess exakta värdnamn och serverrelativa sökväg. Använd endast den här metoden när du har den fullständiga webbplats-URL-strukturen. Använd findSite när du bara känner till ett webbplatsnamn.

Obligatoriska parametrar:

• Värdnamn: Exakt värdnamn (till exempel "contoso.sharepoint.com")
• serverRelativePath: Serverrelativ sökväg (till exempel "webbplatser/marknadsföring"). Det inledande snedstrecket är valfritt.

listSubsites

Visar en lista över alla underwebbplatser (underordnade platser) för en SharePoint webbplats.

Obligatoriska parametrar:

• siteId: ID för den överordnade SharePoint webbplatsen (format: 'hostname,siteCollectionId,webId')

listaDokumentbibliotekPåPlats

Visar en lista över dokumentbibliotek (drives) på den angivna SharePoint-webbplatsen.

Valfria parametrar:

• siteId: ID för SharePoint webbplats (standard: "root")

getDefaultDocumentLibraryInSite

Hämtar standarddokumentbiblioteket (drive) i en SharePoint-webbplats.

Valfria parametrar:

• siteId: ID för SharePoint webbplats (standard: "root")

getFolderChildren

Räknar upp de 20 främsta filerna och mapparna (DriveItems) som finns i en angiven överordnad mapp i ett dokumentbibliotek (enhet).

Obligatoriska parametrar:

• documentLibraryId: ID för dokumentbiblioteket (enhet)

Valfria parametrar:

• parentFolderId: ID för föräldramappen (standard: 'root').

findFileOrFolder

Söker efter en fil eller mapp (DriveItem) som användaren kan komma åt via sökfråga. Sökningar på alla webbplatser och dokumentbibliotek som användaren har åtkomst till.

Obligatoriska parametrar:

• searchQuery: Sökfråga (helt eller delvis filnamn)

getFileOrFolderMetadata

Hämtar metadata för en fil eller mapp (DriveItem) från ett angivet dokumentbibliotek (enhet) i SharePoint.

Obligatoriska parametrar:

• fileOrFolderId: ID för filen eller mappen (DriveItem)
• documentLibraryId: ID för dokumentbiblioteket (enhet)

getFileOrFolderMetadataByUrl

Hämtar metadata för en fil eller mapp (DriveItem) från en delnings-URL. Endast användare med befintliga explicita behörigheter för att få åtkomst till filen kan hämta metadata.

Obligatoriska parametrar:

• fileOrFolderUrl: URL för filen eller mappen. URL:en löses inte in för att dela den med användaren. de måste redan ha uttrycklig åtkomst.

readSmallTextFile

Läser (laddar ner) en textfil mindre än 5 MB från ett specifikt dokumentbibliotek (enhet).

Obligatoriska parametrar:

• Fileid: ID för filen (DriveItem) som ska läsas eller laddas ned
• documentLibraryId: ID för dokumentbiblioteket (enhet)

readSmallBinaryFile

Läser en binär fil som är mindre än 5 MB från ett specifikt dokumentbibliotek (enhet). Filinnehållet returneras som en base64-kodad sträng.

Obligatoriska parametrar:

• Fileid: ID för filen (DriveItem) som ska läsas eller laddas ned
• documentLibraryId: ID för dokumentbiblioteket (enhet)

skapaLitenTextfil

Skapar eller laddar upp en textfil mindre än 5 MB till ett specifikt dokumentbibliotek (enhet).

Obligatoriska parametrar:

• Filnamn: Filens namn inklusive filändelse.
• innehållText: Textinnehållet i filen.
• documentLibraryId: ID för dokumentbiblioteket (enhet)

Valfria parametrar:

• parentFolderId: ID för föräldramappen (standard: 'root').

createSmallBinaryFile

Skapar en binär fil som är mindre än 5 MB genom att base64-koda innehållet till ett specifikt dokumentbibliotek (enhet).

Obligatoriska parametrar:

• Filnamn: Filens namn inklusive filändelse.
• base64Content: Binärt filinnehåll kodat som en base64-sträng.
• documentLibraryId: ID för dokumentbiblioteket (enhet)

Valfria parametrar:

• parentFolderId: ID för föräldramappen (standard: 'root').

skapaMapp

Skapar en ny mapp (DriveItem) i ett angivet dokumentbibliotek (enhet). Om det finns en mapp med samma namn lägger systemet till ett numeriskt suffix (till exempel NewFolder (1)).

Obligatoriska parametrar:

• Mappnamn: Namnet på mappen
• documentLibraryId: ID för dokumentbiblioteket (enhet)

Valfria parametrar:

• parentFolderId: ID för föräldramappen (standard: 'root').

renameFileOrFolder

Byter namn på en fil eller mapp (DriveItem) i ett angivet dokumentbibliotek (enhet). Det nya namnet måste följa namngivningskonventionerna.

Obligatoriska parametrar:

• documentLibraryId: ID för dokumentbiblioteket (enhet)
• fileOrFolderId: ID för filen eller mappen som ska byta namn
• newFileOrFolderName: Det nya namnet

Valfria parametrar:

• Etag: ETag för samtidighetskontroll

deleteFileOrFolder

Tar bort en fil eller mapp (DriveItem) från ett angivet dokumentbibliotek (enhet).

Obligatoriska parametrar:

• documentLibraryId: ID för dokumentbiblioteket (enhet)
• fileOrFolderId: ID för filen eller mappen som ska tas bort

Valfria parametrar:

• Etag: ETag för samtidighetskontroll

Flytta fil eller mapp

Flyttar en fil eller mapp (DriveItem) till en målmapp. Har stöd för att flytta mellan olika dokumentbibliotek i SharePoint. Den här åtgärden är asynkron. Använd checkOperationStatus för att övervaka förloppet.

Obligatoriska parametrar:

• sourcedoclibid: ID för källdokumentbiblioteket (enhet)
• sourcefileid: ID för källfilen eller mappen som ska flyttas
• destdoclibid: ID för måldokumentbiblioteket (drive)
• destfolderid: ID för målmappen (måste finnas)

Valfria parametrar:

• newfilename: Nytt namn på det flyttade objektet

kopiera fil eller mapp

Kopierar en fil eller mapp (DriveItem) till en målmapp. Stöder kopiering mellan olika dokumentbibliotek i SharePoint. Den här åtgärden är asynkron. Använd checkOperationStatus för att övervaka förloppet.

Obligatoriska parametrar:

• sourcedoclibid: ID för källdokumentbiblioteket (enhet)
• sourcefileid: ID för källfilen eller mappen som ska kopieras
• destdoclibid: ID för måldokumentbiblioteket (drive)
• destfolderid: ID för målmappen (måste finnas)

Valfria parametrar:

• newfilename: Nytt namn på det kopierade objektet

checkOperationStatus

Kontrollerar statusen för en asynkron åtgärd, till exempel en kopia eller flytt, med hjälp av åtgärdstoken som returnerades från den ursprungliga åtgärden.

Obligatoriska parametrar:

• operationToken: Åtgärdstoken som returneras från en asynkron åtgärd som copyFileOrFolder eller moveFileOrFolder

uploadFileFromUrl

Laddar upp en fil från en SharePoint eller OneDrive URL till en målmapp i ett dokumentbibliotek (enhet). Filen kopieras från käll-URL:en, så den ursprungliga filen ändras inte.

Obligatoriska parametrar:

• sourceUrl: Käll-URL (måste vara en giltig SharePoint eller OneDrive URL)
• destinationDocumentLibraryId: ID för måldokumentbiblioteket. Använd me för användarens OneDrive

Valfria parametrar:

• destinationFolderId: ID för målmappen (standard: root)
• Filnamn: Nytt filnamn; standardvärdet för det ursprungliga filnamnet

shareFileOrFolder

Skickar en delningsinbjudan för att bevilja läs- eller skrivbehörighet för en fil eller mapp (DriveItem) i ett angivet dokumentbibliotek (enhet).

Obligatoriska parametrar:

• documentLibraryId: ID för dokumentbiblioteket (enhet)
• fileOrFolderId: ID för den fil eller mapp som ska delas
• recipientEmails: Matris med mottagares e-postadresser
• Roller: Matris med roller: "read", "write" (skriv ger både läs- och skrivbehörighet)

Valfria parametrar:

• Meddelande: Anpassat meddelande för e-postmeddelandet för inbjudan (standard: Här är filen som vi samarbetar med.)
• sendInvitation: Om en delningsinbjudan ska skickas (standard: true)

**angeKänslighetsetikettPåFil**

Anger känslighetsetiketten för en fil från det angivna dokumentbiblioteket (enhet).

Obligatoriska parametrar:

• documentLibraryId: ID för dokumentbiblioteket (enhet)
• Fileid: ID för filen (DriveItem)
• sensitivityLabelId: ID för känslighetsetiketten eller tom sträng för att ta bort den

Valfria parametrar:

• assignmentMethod: Tilldelningsmetod: "standard", "privileged", "auto" eller "unknownFutureValue" (standardvärde: "privileged")
• justificationText: Motiveringstext för granskningsändamål. krävs vid nedgradering eller borttagning av en etikett (standard: "Ändrat av MCPServer")

listLists

Hämtar alla SharePoint listor som är tillgängliga på en specifik webbplats. Använd för att identifiera vilka listor som finns på en webbplats.

Obligatoriska parametrar:

• siteId: ID för den SharePoint webbplatsen (format: 'hostname,siteCollectionId,webId')

skapaLista

Skapar en ny SharePoint list på en webbplats.

Obligatoriska parametrar:

• siteId: ID för SharePoint webbplats
• Displayname: Visningsnamn för den nya listan

Valfria parametrar:

• Kolumner: Samling av kolumner som nyckel-värde-par: [{ Key: 'JobTitle', Value: 'text' }]. Giltiga typer: text, flerradig text, tal, boolesk, datum och tid, val, uppslagning, person eller grupp, hyperlänk, valuta, beräknat
• Mall: Typ av listmall (standardvärde: 'genericList'). Alternativ: generell lista, dokumentbibliotek, händelser, uppgifter, meddelanden, kontakter, länkar, enkät, ärendehantering, diskussionsforum

Ta bort lista

Tar bort en SharePoint list från en webbplats. Tar bort hela listcontainern och alla objekt i den. Det går inte att ångra den här åtgärden.

Obligatoriska parametrar:

• siteId: ID för SharePoint webbplats
• listId: ID för listan som ska tas bort

Valfria parametrar:

• Etag: ETag för samtidighetskontroll

skickaInbjudanFörLista

Skickar en delningsinbjudan för att bevilja behörigheter för en SharePoint list.

Obligatoriska parametrar:

• listId: ID för den SharePoint-lista som ska delas
• recipientEmails: Matris med mottagares e-postadresser
• Roll: Roll: "läs" (endast vy), "bidra" (visa, lägga till, uppdatera, ta bort objekt), "redigera" (fullständig redigering inklusive liststruktur)

Valfria parametrar:

• siteUrl: webbplats-URL för den SharePoint webbplats som innehåller listan
• Sendemail: Om du vill skicka ett e-postmeddelande (standard: true)

listListItems

Hämtar objekt (rader/poster) från en specifik SharePoint-lista.

Obligatoriska parametrar:

• siteId: ID för SharePoint webbplats
• listId: ID för SharePoint-listan

getListItem

Hämtar ett enda objekt (rad eller post) från en SharePoint list via dess ID.

Obligatoriska parametrar:

• siteId: ID för SharePoint webbplats
• listId: ID för SharePoint-listan
• Itemid: ID för det specifika listobjektet

createListItem

Skapar ett nytt objekt (rad eller post) i en SharePoint list.

Obligatoriska parametrar:

• siteId: ID för SharePoint webbplats
• listId: ID för SharePoint-listan
• OMRÅDEN: Nyckelvärdespar för fältvärden, såsom [{ Key: 'Title', Value: 'Software Engineer' }, { Key: 'Department', Value: 'Engineering' }]. Fältet 'Titel' är vanligtvis obligatoriskt.

updateListItem

Uppdaterar ett befintligt objekt (rad eller post) i en SharePoint list. Endast angivna fält uppdateras. utelämnade fält behåller sina värden.

Obligatoriska parametrar:

• siteId: ID för SharePoint webbplats
• listId: ID för SharePoint-listan
• Itemid: ID för objektet som ska uppdateras
• Fält: Nyckel/värde-par med fält som ska uppdateras

Valfria parametrar:

• Etag: ETag för samtidighetskontroll

deleteListItem

Tar bort ett objekt (rad eller post) från en SharePoint list.

Obligatoriska parametrar:

• siteId: ID för SharePoint webbplats
• listId: ID för SharePoint-listan
• Itemid: ID för objektet som ska tas bort

Valfria parametrar:

• Etag: ETag för samtidighetskontroll

listaKolumner

Hämtar alla kolumner från en SharePoint list.

Obligatoriska parametrar:

• siteId: ID för SharePoint webbplats
• listId: ID för SharePoint-listan

createColumn

Skapar en ny kolumn i en SharePoint list. Stöder många kolumntyper, inklusive text, tal, val, dateTime, boolesk, användare, sökning, beräknad med mera.

Obligatoriska parametrar:

• siteId: ID för SharePoint webbplats
• listId: ID för SharePoint-listan
• Namn: Internt kolumnnamn (programmatisk identifierare)
• columnType: Kolumntyp: text, anteckning, tal, heltal, boolesk, datum/tid, val, flera val, valuta, uppslag, användare, URL, beräknad, term, flera termer, plats, geoplats, miniatyrbild, räknare, beräknat, innehållstyp-ID, fil, bifogad fil, GUID, resultatval, godkännandestatus

Valfria parametrar:

• columnProperties: Typspecifika inställningar (till exempel { "maxLength": 255 } för text, { "choices": ["A","B","C"] } för val)
• Beskrivning: Beskrivning av kolumnen
• Displayname: Visningsnamn som visas i användargränssnittet (standardvärdet är "namn")
• Krävs: Gör kolumnen obligatorisk (standard: false)
• Dolda: Dölj kolumnen från vyer (standard: false)

updateColumn

Uppdaterar en befintlig kolumn i en SharePoint list.

Obligatoriska parametrar:

• siteId: ID för SharePoint webbplats
• listId: ID för SharePoint-listan
• columnId: ID för kolumnen som ska uppdateras

Valfria parametrar:

• columnType: Kolumntyp (krävs när du anger "columnProperties")
• columnProperties: Typspecifika egenskaper som ska uppdateras
• Beskrivning: Ny beskrivning
• Displayname: Nytt visningsnamn
• Dolda: Dölj eller visa kolumn
• Krävs: Gör kolumnen obligatorisk eller valfri

taBortKolumn

Tar bort en kolumn från en SharePoint list. Varning: Den här åtgärden tar bort alla data som lagras i kolumnen för alla objekt.

Obligatoriska parametrar:

• siteId: ID för SharePoint webbplats
• listId: ID för SharePoint-listan
• columnId: ID för kolumnen som ska tas bort

Centrala egenskaper

Webbplatshantering

• Hitta webbplatser efter namn eller bläddra bland tillgängliga webbplatser.
• Hämta en webbplats med en exakt URL-sökväg.
• Visa en lista över underordnade webbplatser och underwebbplatser.
• Omfattande navigering i webbplatshierarkin.

Hantering av dokumentbibliotek

• Visa en lista över alla dokumentbibliotek på en webbplats.
• Hämta standarddokumentbiblioteket.
• Bläddra bland mappens innehåll (upp till 20 objekt).
• Skapa och hantera mappstrukturer.

Filåtgärder

• Skapa text- och binärfiler (5 MB eller mindre).
• Läs text och binärfiler (5 MB eller mindre).
• Ta bort, byt namn på och flytta filer och mappar.
• Kopiera filer och mappar mellan dokumentbibliotek.
• Ladda upp filer från SharePoint eller OneDrive URL:er.
• Sök efter filer och mappar på alla tillgängliga webbplatser.
• Hämta fil- och mappmetadata.

Asynkrona åtgärder

• Kopiera och flytta filer och mappar asynkront mellan dokumentbibliotek.
• Kontrollera statusen för asynkrona åtgärder med hjälp av åtgärdstoken.

Liståtgärder

• Skapa, läsa och ta bort listor.
• Stöd för flera listmallar, inklusive allmänna dokumentbibliotek, händelser och uppgifter.
• Dela listor med rollbaserade behörigheter.
• Hantera listobjekt genom att skapa, läsa, uppdatera och ta bort dem.

Kolumnhantering

• Skapa kolumner med en mängd olika typer, till exempel text, anteckning, tal, boolesk, dateTime, val, sökning, användare, URL, beräknad med mera.
• Uppdatera kolumnegenskaper och metadata.
• Konfigurera kolumnkrav och synlighet.
• Ange typspecifika kolumnegenskaper.

Delning och behörigheter

• Dela filer, mappar och listor med användare.
• Använd rollbaserad åtkomstkontroll med läs-, skriv-, bidra- och redigeringsroller.
• E-postnotiser för delning.
• Anpassade meddelanden i inbjudningar.

Säkerhet och efterlevnad

• Använd och ta bort känslighetsetiketter.
• Använd flera tilldelningsmetoder, inklusive standard, privilegierad och automatisk.
• Stöd för granskningsmotivering.
• Använd samtidighetskontroll med eTags.

Notes

• Filåtgärder är begränsade till filer som är 5 MB eller mindre för uppladdning och nedladdning.
• Kopierings- och flyttåtgärder är asynkrona. Använd checkOperationStatus för att övervaka förloppet.
• Kopierings- och flyttåtgärder stöder åtgärder mellan bibliotek inom SharePoint.
• uploadFileFromUrl kräver en giltig SharePoint eller OneDrive käll-URL.
• eTags ger samtidighetskontroll för uppdateringar och borttagningar.
• Automatiskt numeriskt suffix för duplicerade mappnamn.
• Det går inte att ångra listborttagningen.
• Kolumnborttagning tar bort alla data som lagras i den kolumnen.
• Sökåtgärder returnerar de 20 främsta resultaten som standard.