SharePoint-referentie (preview)

Note

De functies in dit artikel worden aangedreven door de standaard kabelboom, die gebruikmaakt van de factureringsopties zoals beschreven in Licensing voor agenten die door de standaardkabelboom worden aangestuurd. Leer hoe je standaardfuncties kunt openen in Access standaard agents en agentstromen.

Important

Dit is een preview-functie.

• Microsoft brengt previewfuncties uit vóór een officiële release, zodat klanten vroegtijdig toegang kunnen krijgen en feedback kunnen geven.
• Preview-functies hebben beperkte functionaliteit en zijn niet bedoeld voor productiegebruik.
• Microsoft kan de namen en parameters van het MCP-hulpprogramma preview wijzigen. Vermijd in code vastgelegde afhankelijkheden. Microsoft ondersteuning voor scenario's onderhoudt.
• Preview-functies zijn onderhevig aan Microsoft aanvullende gebruiksvoorwaarden.

Overview

Server-ID	URL op tenantniveau	weergavenaam	Description
mcp_SharePointRemoteServer	https://agent365.svc.cloud.microsoft/ agents/tenants/{tenantId}/servers/ mcp_SharePointRemoteServer	SharePoint	Tools voor SharePoint-operaties. Gebruik deze server voor het beheren van sites, lijsten, lijstitems, kolommen, documentbibliotheken, bestanden, mappen en het delen van bestanden. Bestandsbewerkingen zijn beperkt tot bestanden van 5 MB of minder.

Beschikbare hulpmiddelen

findSite

Hiermee vindt u SharePoint sites waartoe u toegang hebt. Retourneert specifieke sites die overeenkomen met een zoekquery of de top 20 relevante sites als u geen query opgeeft.

Optionele parameters:

• searchQuery: Zoekquery (volledige of gedeeltelijke sitenaam). Laat dit weg om de top 20 toegankelijke websites weer te geven.

getSiteByPath

Hiermee wordt een SharePoint-site geïdentificeerd met behulp van de exacte hostnaam en het serverrelatieve pad. Gebruik deze methode alleen als u de volledige site-URL-structuur hebt. Gebruik findSite wanneer u alleen de naam van een site kent.

Vereiste parameters:

• Hostname: Exacte hostnaam (bijvoorbeeld 'contoso.sharepoint.com')
• serverRelativePath: Server-relatief pad (bijvoorbeeld 'sites/marketing'). De slash aan het begin is optioneel.

listSubsites

Een lijst met alle subsites (onderliggende sites) van een SharePoint-site.

Vereiste parameters:

• siteId: ID van de bovenliggende SharePoint-site (notatie: 'hostnaam,siteCollectionId,webId')

lijstDocumentBibliothekenInSite

Geeft de documentbibliotheken weer in de opgegeven SharePoint-site.

Optionele parameters:

• siteId:-id van de SharePoint-site (standaard: root)

standaardDocumentbibliotheekInSite ophalen

Haalt de standaarddocumentbibliotheek (schijf) op in een SharePoint-site.

Optionele parameters:

• siteId:-id van de SharePoint-site (standaard: root)

getFolderChildren

Somt de eerste 20 bestanden en mappen (DriveItems) op die zich in een opgegeven bovenliggende map in een documentbibliotheek (drive) bevinden.

Vereiste parameters:

• documentLibraryId: ID van de documentbibliotheek (drive)

Optionele parameters:

• parentFolderId: ID van de oudermap (standaard: 'root').

findFileOrFolder

Hiermee vindt u een bestand of map (DriveItem) dat toegankelijk is voor de gebruiker via een zoekquery. Zoekopdrachten op alle sites en documentbibliotheken waar de gebruiker toegang toe heeft.

Vereiste parameters:

• searchQuery: Zoekquery (volledige of gedeeltelijke bestandsnaam)

getFileOrFolderMetadata

Hiermee haalt u de metagegevens van een bestand of map (DriveItem) op van een opgegeven documentbibliotheek (drive) in SharePoint.

Vereiste parameters:

• fileOrFolderId: Id van het bestand of de map (DriveItem)
• documentLibraryId: ID van de documentbibliotheek (drive)

getFileOrFolderMetadataByUrl

Krijgt metadata voor een bestand of map (DriveItem) van een gedeelde URL. Alleen gebruikers met bestaande expliciete machtigingen voor toegang tot het bestand kunnen de metagegevens ophalen.

Vereiste parameters:

• fileOrFolderUrl: URL van het bestand of de map. De URL wordt niet ingewisseld om deze te delen met de gebruiker; ze moeten al expliciete toegang hebben.

leesKleintekstbestand

Lest (downloadt) een tekstbestand kleiner dan 5 MB uit een specifieke documentbibliotheek (schijf).

Vereiste parameters:

• fileId: Id van het bestand (DriveItem) dat moet worden gelezen of gedownload
• documentLibraryId: ID van de documentbibliotheek (drive)

readSmallBinaryFile

Leest een binair bestand kleiner dan 5 MB vanuit een specifieke documentbibliotheek (drive). De bestandsinhoud wordt geretourneerd als een met base64 gecodeerde tekenreeks.

Vereiste parameters:

• fileId: Id van het bestand (DriveItem) dat moet worden gelezen of gedownload
• documentLibraryId: ID van de documentbibliotheek (drive)

createSmallTextFile

Maakt een tekstbestand kleiner dan 5 MB aan of uploadt het naar een specifieke documentbibliotheek (schijf).

Vereiste parameters:

• Bestandsnaam: Naam van het bestand inclusief extensie.
• inhoudTekst: Tekstinhoud van het bestand.
• documentLibraryId: ID van de documentbibliotheek (drive)

Optionele parameters:

• parentFolderId: ID van de oudermap (standaard: 'root').

createSmallBinaryFile

Hiermee maakt u een binair bestand kleiner dan 5 MB door de inhoud ervan met base64 te coderen in een specifieke documentbibliotheek (drive).

Vereiste parameters:

• Bestandsnaam: Naam van het bestand inclusief extensie.
• base64Content: Binaire bestandsinhoud die is gecodeerd als een base64-tekenreeks.
• documentLibraryId: ID van de documentbibliotheek (drive)

Optionele parameters:

• parentFolderId: ID van de oudermap (standaard: 'root').

createFolder

Maakt een nieuwe map (DriveItem) in een opgegeven documentbibliotheek (drive). Als er een map met dezelfde naam bestaat, voegt het systeem een numeriek achtervoegsel toe (bijvoorbeeld NewFolder (1)).

Vereiste parameters:

• Mapnaam: Naam van de map
• documentLibraryId: ID van de documentbibliotheek (drive)

Optionele parameters:

• parentFolderId: ID van de oudermap (standaard: 'root').

renameFileOrFolder

Wijzigt de naam van een bestand of map (DriveItem) in een gespecificeerde documentbibliotheek (schijf). De nieuwe naam moet voldoen aan naamconventies.

Vereiste parameters:

• documentLibraryId: ID van de documentbibliotheek (drive)
• fileOrFolderId: Id van het bestand of de map waarvan u de naam wilt wijzigen
• newFileOrFolderName: De nieuwe naam

Optionele parameters:

• etag: ETag voor gelijktijdigheidsbeheer

deleteFileOrFolder

Verwijdert een bestand of map (DriveItem) uit een opgegeven documentbibliotheek (schijf).

Vereiste parameters:

• documentLibraryId: ID van de documentbibliotheek (drive)
• fileOrFolderId: Id van het bestand of de map die u wilt verwijderen

Optionele parameters:

• etag: ETag voor gelijktijdigheidsbeheer

moveFileOrFolder

Hiermee verplaatst u een bestand of map (DriveItem) naar een doelmap. Ondersteunt het verplaatsen tussen verschillende documentbibliotheken binnen SharePoint. Deze bewerking is asynchroon. Gebruik checkOperationStatus dit om de voortgang te controleren.

Vereiste parameters:

• sourcedoclibid: ID van de brondocumentbibliotheek (drive)
• sourcefileid: Id van het bronbestand of de bronmap die u wilt verplaatsen
• destdoclibid: ID van de bestemmingsdocumentbibliotheek (schijf)
• destfolderid: Id van de doelmap (moet bestaan)

Optionele parameters:

• newfilename: Nieuwe naam voor het verplaatste item

copyFileOrFolder

Hiermee kopieert u een bestand of map (DriveItem) naar een doelmap. Ondersteunt het kopiëren van verschillende documentbibliotheken binnen SharePoint. Deze bewerking is asynchroon. Gebruik checkOperationStatus dit om de voortgang te controleren.

Vereiste parameters:

• sourcedoclibid: ID van de brondocumentbibliotheek (drive)
• sourcefileid: Id van het bronbestand of de bronmap die moet worden gekopieerd
• destdoclibid: ID van de bestemmingsdocumentbibliotheek (schijf)
• destfolderid: Id van de doelmap (moet bestaan)

Optionele parameters:

• newfilename: Nieuwe naam voor het gekopieerde item

checkOperationStatus

Controleert de status van een asynchrone bewerking, zoals een kopie of verplaatsing, met behulp van het bewerkingstoken dat is geretourneerd door de oorspronkelijke bewerking.

Vereiste parameters:

• operationToken: Het bewerkingstoken dat wordt geretourneerd door een asynchrone bewerking, zoals copyFileOrFolder of moveFileOrFolder

uploadFileFromUrl

Uploadt een bestand vanaf een SharePoint- of OneDrive-URL naar een doelmap in een documentbibliotheek (drive). Het bestand wordt gekopieerd uit de bron-URL, dus het oorspronkelijke bestand wordt niet gewijzigd.

Vereiste parameters:

• sourceUrl: bron-URL (moet een geldige SharePoint- of OneDrive-URL zijn)
• destinationDocumentLibraryId: Id van de doeldocumentbibliotheek. Gebruik me voor de OneDrive van de gebruiker

Optionele parameters:

• destinationFolderId: Id van de doelmap (standaard: root)
• Bestandsnaam: Nieuwe bestandsnaam; standaard ingesteld op de oorspronkelijke bestandsnaam

shareFileOrFolder

Verzendt een deeluitnodiging om lees- of schrijfrechten te verlenen voor een bestand of map (DriveItem) binnen een opgegeven documentbibliotheek (schijf).

Vereiste parameters:

• documentLibraryId: ID van de documentbibliotheek (drive)
• fileOrFolderId: Id van het bestand of de map die moet worden gedeeld
• recipientEmails: Matrix van e-mailadressen van geadresseerden
• Rollen: Matrix met rollen: 'lezen', 'schrijven' (schrijven verleent zowel lezen als schrijven)

Optionele parameters:

• Bericht: Aangepast bericht voor de uitnodigings-e-mail (standaard: dit is het bestand waarmee we samenwerken.)
• sendInvitation: Of een uitnodiging voor delen moet worden verzonden (standaard: true)

gevoeligheidslabelOpBestandInstellen

Stelt het vertrouwelijkheidslabel in van een bestand vanuit de opgegeven documentbibliotheek (drive).

Vereiste parameters:

• documentLibraryId: ID van de documentbibliotheek (drive)
• fileId: Id van het bestand (DriveItem)
• sensitivityLabelId: Id van het vertrouwelijkheidslabel of een lege tekenreeks om het te verwijderen

Optionele parameters:

• assignmentMethod: Toewijzingsmethode: 'standard', 'privileged', 'auto' of 'unknownFutureValue' (standaardwaarde: 'privileged')
• justificationText: Redentekst voor controledoeleinden; vereist bij het downgraden of verwijderen van een label (standaard: 'Gewijzigd door MCPServer')

listLists

Hiermee haalt u alle SharePoint lijsten op die beschikbaar zijn op een specifieke site. Gebruik deze lijst om te ontdekken welke lijsten er bestaan binnen een site.

Vereiste parameters:

• siteId:-id van de SharePoint-site (indeling: hostnaam, siteCollectionId,webId')

createList

Hiermee maakt u een nieuwe SharePoint list binnen een site.

Vereiste parameters:

• siteId:-id van de SharePoint-site
• Displayname: Weergavenaam van de nieuwe lijst

Optionele parameters:

• Kolommen: Een verzameling kolommen als sleutel-waardeparen: [{ Key: 'JobTitle', Value: 'text' }]. Geldige typen: tekst, multilineTekst, getal, Booleaanse waarde, datum/tijd, keuze, opzoeken, personOrGroup, hyperlink, valuta, berekend
• Sjabloon: Type van de lijstsjabloon (standaard: 'genericList'). Opties: algemene lijst, documentbibliotheek, gebeurtenissen, taken, aankondigingen, contactpersonen, koppelingen, enquête, probleemregistratie, discussieforum

deleteList

Hiermee verwijdert u een SharePoint list van een site. Hiermee verwijdert u de hele lijstcontainer en alle items erin. Deze actie kan niet ongedaan worden gemaakt.

Vereiste parameters:

• siteId:-id van de SharePoint-site
• listId: Id van de lijst die u wilt verwijderen

Optionele parameters:

• etag: ETag voor gelijktijdigheidsbeheer

Uitnodiging voor lijst verzenden

Hiermee wordt een deeluitnodiging verzonden om machtigingen te verlenen voor een SharePoint-lijst.

Vereiste parameters:

• listId:-id van de SharePoint list die u wilt delen
• recipientEmails: Matrix van e-mailadressen van geadresseerden
• Role: Rol: 'lezen' (alleen weergeven), 'bijdragen' (weergave, toevoegen, bijwerken, verwijderen van items), 'bewerken' (volledige bewerking inclusief lijststructuur)

Optionele parameters:

• siteUrl: Site-URL van de SharePoint-site met de lijst
• Sendemail: Of een e-mailmelding moet worden verzonden (standaard: waar)

listListItems

Hiermee worden items (rijen/records) opgehaald uit een specifieke SharePoint list.

Vereiste parameters:

• siteId:-id van de SharePoint-site
• listId: ID van de SharePoint-lijst

getListItem

Krijgt een enkel item (rij of record) uit een SharePoint list via zijn ID.

Vereiste parameters:

• siteId:-id van de SharePoint-site
• listId: ID van de SharePoint-lijst
• itemId: Id van het specifieke lijstitem

createListItem

Hiermee maakt u een nieuw item (rij of record) in een SharePoint list.

Vereiste parameters:

• siteId:-id van de SharePoint-site
• listId: ID van de SharePoint-lijst
• VELDEN: Sleutelwaardeparen voor veldwaarden, zoals [{ Key: 'Title', Value: 'Software Engineer' }, { Key: 'Department', Value: 'Engineering' }]. Het veld 'Titel' is meestal vereist.

updateListItem

Hiermee werkt u een bestaand item (rij of record) bij in een SharePoint list. Alleen opgegeven velden worden bijgewerkt; weggelaten velden behouden hun waarden.

Vereiste parameters:

• siteId:-id van de SharePoint-site
• listId: ID van de SharePoint-lijst
• itemId: Id van het item dat moet worden bijgewerkt
• Velden: Sleutel-waardeparen van velden die moeten worden bijgewerkt

Optionele parameters:

• etag: ETag voor gelijktijdigheidsbeheer

Lijstitem verwijderen

Hiermee verwijdert u een item (rij of record) uit een SharePoint list.

Vereiste parameters:

• siteId:-id van de SharePoint-site
• listId: ID van de SharePoint-lijst
• itemId: Id van het item dat moet worden verwijderd

Optionele parameters:

• etag: ETag voor gelijktijdigheidsbeheer

Lijstkolommen

Hiermee haalt u alle kolommen op uit een SharePoint list.

Vereiste parameters:

• siteId:-id van de SharePoint-site
• listId: ID van de SharePoint-lijst

createColumn

Hiermee maakt u een nieuwe kolom in een SharePoint list. Ondersteunt veel kolomtypen, waaronder tekst, getal, keuze, datum/tijd, booleaanse waarde, gebruiker, opzoekactie, berekend en meer.

Vereiste parameters:

• siteId:-id van de SharePoint-site
• listId: ID van de SharePoint-lijst
• naam: Interne kolomnaam (programmatische identificatie)
• columnType: Kolomtype: tekst, opmerking, getal, geheel getal, booleaanse waarde, datum/tijd, keuze, multichoice, valuta, zoekactie, gebruiker, URL, berekend, term, multiterm, locatie, geolocatie, miniatuur, teller, berekend, contentTypeId, bestand, bijlage, guid, outcomeChoice, approvalStatus

Optionele parameters:

• columnProperties: Typespecifieke instellingen (bijvoorbeeld { "maxLength": 255 } voor tekst, { "choices": ["A","B","C"] } voor keuze)
• Beschrijving: Beschrijving van de kolom
• Displayname: Weergavenaam die wordt weergegeven in de gebruikersinterface (standaard ingesteld op 'name')
• vereist: Maak de kolom verplicht (standaard: false)
• Verborgen: Kolom verbergen in overzichten (standaard: false)

updateColumn

Hiermee werkt u een bestaande kolom in een SharePoint list bij.

Vereiste parameters:

• siteId:-id van de SharePoint-site
• listId: ID van de SharePoint-lijst
• columnId: Id van de kolom die moet worden bijgewerkt

Optionele parameters:

• columnType: Kolomtype (vereist bij het instellen van 'columnProperties')
• columnProperties: Typespecifieke eigenschappen die moeten worden bijgewerkt
• Beschrijving: Nieuwe beschrijving
• Displayname: Nieuwe weergavenaam
• Verborgen: Kolom verbergen of weergeven
• Vereist: Kolom verplicht of optioneel maken

kolom verwijderen

Hiermee verwijdert u een kolom uit een SharePoint list. Waarschuwing: Met deze actie worden alle gegevens verwijderd die zijn opgeslagen in die kolom voor alle items.

Vereiste parameters:

• siteId:-id van de SharePoint-site
• listId: ID van de SharePoint-lijst
• columnId: Id van de kolom die moet worden verwijderd

Belangrijkste kenmerken

Sitebeheer

• Zoek sites op naam of blader door toegankelijke sites.
• Haal een site op via het exacte URL-pad.
• Geef onderliggende sites en subsites weer.
• Uitgebreide navigatie in de sitestructuur.

Documentbibliotheekbeheer

• Alle documentbibliotheken op een site weergeven.
• Haal de standaarddocumentbibliotheek op.
• Blader door de inhoud van de map (tot 20 items).
• Mapstructuren maken en beheren.

Bestandsbewerkingen

• Maak tekst- en binaire bestanden aan (5 MB of minder).
• Lees tekst en binaire bestanden (5 MB of minder).
• Bestanden en mappen verwijderen, de naam ervan wijzigen en verplaatsen.
• Kopieer bestanden en mappen tussen documentbibliotheken.
• Bestanden uploaden vanuit SharePoint of OneDrive URL's.
• Zoek naar bestanden en mappen op alle toegankelijke sites.
• Bestands- en mapmetagegevens ophalen.

Asynchrone bewerkingen

• Bestanden en mappen asynchroon kopiëren en verplaatsen in documentbibliotheken.
• Controleer de status van asynchrone bewerkingen met behulp van bewerkingstokens.

Lijstbewerkingen

• Lijsten maken, lezen en verwijderen.
• Ondersteuning voor meerdere lijstsjablonen, waaronder algemene, documentbibliotheek, gebeurtenissen en taken.
• Lijsten delen met machtigingen op basis van rollen.
• Lijstitems beheren door ze te maken, te lezen, bij te werken en te verwijderen.

Kolombeheer

• Kolommen maken met een breed scala aan typen, zoals tekst, opmerking, getal, booleaanse waarde, datum/tijd, keuze, opzoekactie, gebruiker, URL, berekend en meer.
• Kolomeigenschappen en metagegevens bijwerken.
• Configureer de kolomvereisten en zichtbaarheid.
• Typespecifieke kolomeigenschappen instellen.

Delen en machtigingen

• Bestanden, mappen en lijsten delen met gebruikers.
• Op rollen gebaseerd toegangsbeheer gebruiken met lees-, schrijf-, bijdragen- en bewerkingsrollen.
• E-mailmeldingen voor het delen.
• Aangepaste berichten in uitnodigingen.

Beveiliging en naleving

• Vertrouwelijkheidslabels toepassen en verwijderen.
• Gebruik meerdere toewijzingsmethoden, waaronder standaard, bevoegd en automatisch.
• Ondersteuning voor auditverantwoording.
• Gelijktijdigheidsbeheer gebruiken met eTags.

Aantekeningen

• Bestandsbewerkingen zijn beperkt tot bestanden van 5 MB of minder voor uploaden en downloaden.
• Kopieer- en verplaatsingsbewerkingen zijn asynchroon. Gebruik checkOperationStatus dit om de voortgang te controleren.
• Kopieer- en verplaatsingsbewerkingen ondersteunen bewerkingen tussen bibliotheken binnen SharePoint.
• uploadFileFromUrl vereist een geldige SharePoint of OneDrive bron-URL.
• eTags bieden gelijktijdigheidsbeheer voor updates en verwijderingen.
• Automatische numerieke achtervoegsel voor dubbele mapnamen.
• Lijstverwijdering kan niet ongedaan worden gemaakt.
• Door kolomverwijdering worden alle gegevens verwijderd die in die kolom zijn opgeslagen.
• Zoekbewerkingen retourneren standaard de bovenste 20 resultaten.