Informazioni di riferimento su SharePoint per L'IQ aziendale (anteprima)

Overview

Strumenti disponibili

findSite

Trova SharePoint siti a cui è possibile accedere. Restituisce siti specifici che corrispondono a una query di ricerca o ai primi 20 siti pertinenti se non si specifica una query.

Parametri facoltativi:

• searchQuery: Query di ricerca (nome intero o parziale del sito). Omettere di restituire i primi 20 siti accessibili.

getSiteByPath

Risolve un sito SharePoint usando il nome host esatto e il percorso relativo al server. Usare questo metodo solo quando si dispone della struttura completa dell'URL del sito. Usare findSite quando si conosce solo un nome di sito.

Parametri obbligatori:

• Hostname: Nome host esatto (ad esempio, 'contoso.sharepoint.com')
• serverRelativePath: Percorso relativo al server ,ad esempio 'sites/Marketing'. La barra iniziale è facoltativa.

elencaSottoSiti

Elenca tutti i siti secondari (siti figlio) di un sito SharePoint.

Parametri obbligatori:

• Siteid: ID del sito di SharePoint padre (formato: 'nome host,siteCollectionId,webId')

elencaLibrerieDocumentiNelSito

Elenca le raccolte documentali (unità) nel sito SharePoint specificato.

Parametri facoltativi:

• Siteid: ID del sito di SharePoint (impostazione predefinita: 'root')

getDefaultDocumentLibraryInSite

Recupera la libreria documenti predefinita (unità) di un sito SharePoint.

Parametri facoltativi:

• Siteid: ID del sito di SharePoint (impostazione predefinita: 'root')

getFolderChildren

Elenca i primi 20 file e cartelle (DriveItems) presenti in una cartella padre specificata in una raccolta documenti (drive).

Parametri obbligatori:

• documentLibraryId: ID della raccolta documenti (drive)

Parametri facoltativi:

• parentFolderId: ID della cartella padre (impostazione predefinita: 'root')

findFileOrFolder

Trova un file o una cartella (DriveItem) accessibile all'utente tramite query di ricerca. Ricerche tramite tutti i siti e le raccolte di documenti a cui l'utente ha accesso.

Parametri obbligatori:

• searchQuery: Query di ricerca (nome intero o parziale del file)

getFileOrFolderMetadata

Recupera i metadati di un file o di una cartella (DriveItem) da una libreria documenti specificata (drive) in SharePoint.

Parametri obbligatori:

• fileOrFolderId: ID del file o della cartella (DriveItem)
• documentLibraryId: ID della raccolta documenti (drive)

getFileOrFolderMetadataByUrl

Ottiene i metadati di un file o di una cartella (DriveItem) da un URL di condivisione. Solo gli utenti con autorizzazioni esplicite esistenti per accedere al file potranno ottenere i metadati.

Parametri obbligatori:

• fileOrFolderUrl: URL del file o della cartella. L'URL non viene utilizzato per condividerlo con l'utente; l'utente deve già disporre di un accesso esplicito.

readSmallTextFile

Legge (scarica) un file di testo di dimensioni inferiori a 5 MB da una specifica raccolta documenti (drive).

Parametri obbligatori:

• fileId: ID del file (DriveItem) da leggere o scaricare
• documentLibraryId: ID della raccolta documenti (drive)

readSmallBinaryFile

Legge un file binario di dimensioni inferiori a 5 MB da una specifica libreria documenti (drive). Il contenuto del file viene restituito come stringa con codifica Base64.

Parametri obbligatori:

• fileId: ID del file (DriveItem) da leggere o scaricare
• documentLibraryId: ID della raccolta documenti (drive)

createSmallTextFile

Crea o carica un file di testo di dimensioni inferiori a 5 MB in una specifica raccolta documenti (drive).

Parametri obbligatori:

• Filename: Nome del file incluso l'estensione
• contentText: Contenuto di testo del file
• documentLibraryId: ID della raccolta documenti (drive)

Parametri facoltativi:

• parentFolderId: ID della cartella padre (impostazione predefinita: 'root')

createSmallBinaryFile

Crea un file binario di dimensioni inferiori a 5 MB codificandone il contenuto in base64 in una specifica raccolta documenti (drive).

Parametri obbligatori:

• Filename: Nome del file incluso l'estensione
• base64Content: Contenuto di file binari codificato come stringa base64.
• documentLibraryId: ID della raccolta documenti (drive)

Parametri facoltativi:

• parentFolderId: ID della cartella padre (impostazione predefinita: 'root')

createFolder

Crea una nuova cartella (DriveItem) all'interno di una libreria documenti specificata (drive). Se esiste una cartella con lo stesso nome, il sistema aggiunge un suffisso numerico(ad esempio, NewFolder (1)).

Parametri obbligatori:

• Foldername: Nome della cartella
• documentLibraryId: ID della raccolta documenti (drive)

Parametri facoltativi:

• parentFolderId: ID della cartella padre (impostazione predefinita: 'root')

renameFileOrFolder

Rinomina un file o una cartella (DriveItem) all'interno di una libreria documenti specificata (drive). Il nuovo nome deve essere conforme alle convenzioni di denominazione.

Parametri obbligatori:

• documentLibraryId: ID della raccolta documenti (drive)
• fileOrFolderId: ID del file o della cartella da rinominare
• newFileOrFolderName: Nuovo nome

Parametri facoltativi:

• Etag: ETag per il controllo della concorrenza

deleteFileOrFolder

Elimina un file o una cartella (DriveItem) da una libreria documenti specificata (drive).

Parametri obbligatori:

• documentLibraryId: ID della raccolta documenti (drive)
• fileOrFolderId: ID del file o della cartella da eliminare

Parametri facoltativi:

• Etag: ETag per il controllo della concorrenza

moveFileOrFolder

Sposta un file o una cartella (DriveItem) in una cartella di destinazione. Supporta lo spostamento tra le raccolte di documenti all'interno di SharePoint. Questa operazione è asincrona. Usare checkOperationStatus per monitorare lo stato di avanzamento.

Parametri obbligatori:

• sourcedoclibid: ID della raccolta documenti di origine (drive)
• sourcefileid: ID del file o della cartella di origine da spostare
• destdoclibid: ID della raccolta documenti di destinazione (disco)
• destfolderid: ID della cartella di destinazione (deve esistere)

Parametri facoltativi:

• newfilename: Nuovo nome per l'elemento spostato

copyFileOrFolder

Copia un file o una cartella (DriveItem) in una cartella di destinazione. Supporta la copia tra raccolte documenti diverse all'interno di SharePoint. Questa operazione è asincrona. Usare checkOperationStatus per monitorare lo stato di avanzamento.

Parametri obbligatori:

• sourcedoclibid: ID della raccolta documenti di origine (drive)
• sourcefileid: ID del file o della cartella di origine da copiare
• destdoclibid: ID della raccolta documenti di destinazione (disco)
• destfolderid: ID della cartella di destinazione (deve esistere)

Parametri facoltativi:

• newfilename: Nuovo nome per l'elemento copiato

checkOperationStatus

Controlla lo stato di un'operazione asincrona, ad esempio una copia o uno spostamento, usando il token dell'operazione restituito dall'operazione originale.

Parametri obbligatori:

• operationToken: Token dell'operazione restituito da un'operazione asincrona come copyFileOrFolder o moveFileOrFolder

uploadFileFromUrl

Carica un file da un URL di SharePoint o OneDrive a una cartella di destinazione in una raccolta documenti (drive). Il file viene copiato dall'URL di origine, quindi il file originale non viene modificato.

Parametri obbligatori:

• sourceUrl: URL di origine (deve essere un URL di SharePoint o OneDrive valido)
• destinationDocumentLibraryId: ID della raccolta documenti di destinazione. Usare me per l'OneDrive dell'utente

Parametri facoltativi:

• destinationFolderId: ID della cartella di destinazione (impostazione predefinita: root)
• Filename: Nuovo nome del file; per impostazione predefinita il nome del file originale

condividiFileOCartella

Invia un invito di condivisione per concedere autorizzazioni di lettura o scrittura per un file o una cartella (DriveItem) all'interno di una libreria di documenti specificata (drive).

Parametri obbligatori:

• documentLibraryId: ID della raccolta documenti (drive)
• fileOrFolderId: ID del file o della cartella da condividere
• recipientEmails: Matrice di indirizzi di posta elettronica dei destinatari
• Ruoli: Matrice di ruoli: 'read', 'write' (write concede sia lettura che scrittura)

Parametri facoltativi:

• Messaggio: Messaggio personalizzato per il messaggio di posta elettronica di invito (impostazione predefinita: ecco il file su cui stiamo collaborando).
• sendInvitation: Indica se inviare un invito alla condivisione (impostazione predefinita: true)

impostaEtichettaSensibilitàSulFile

Imposta l'etichetta di riservatezza di un file dalla raccolta documenti specificata (drive).

Parametri obbligatori:

• documentLibraryId: ID della raccolta documenti (drive)
• fileId: ID del file (DriveItem)
• sensitivityLabelId: ID dell'etichetta di riservatezza o stringa vuota per rimuoverla

Parametri facoltativi:

• assignmentMethod: Metodo di assegnazione: 'standard', 'privileged', 'auto' o 'unknownFutureValue' (impostazione predefinita: 'privileged')
• justificationText: Testo della giustificazione a scopo di controllo; obbligatorio durante il downgrade o la rimozione di un'etichetta (impostazione predefinita: 'Modificato da MCPServer')

listLists

Ottiene tutti gli elenchi di SharePoint disponibili in un sito specifico. Usare per individuare gli elenchi presenti all'interno di un sito.

Parametri obbligatori:

• Siteid: ID del sito di SharePoint (formato: 'nome host,siteCollectionId,webId')

creaLista

Crea un nuovo SharePoint list all'interno di un sito.

Parametri obbligatori:

• Siteid: ID del sito di SharePoint
• Displayname: Nome visualizzato del nuovo elenco

Parametri facoltativi:

• Colonne: Raccolta di colonne come coppie chiave-valore: [{ Key: 'JobTitle', Value: 'text' }]. Tipi validi: 'text', 'multilineText', 'number', 'boolean', 'dateTime', 'choice', 'lookup', 'personOrGroup', 'hyperlink', 'currency', 'calculated'
• Modello: Tipo di modello elenco (impostazione predefinita: 'genericList'). Opzioni: genericList, documentLibrary, eventi, attività, annunci, contatti, collegamenti, sondaggio, issueTracking, discussionBoard

deleteList

Elimina un SharePoint list da un sito. Elimina l'intero contenitore elenco e tutti gli elementi al suo interno. Non è possibile annullare l'operazione.

Parametri obbligatori:

• Siteid: ID del sito di SharePoint
• listId: ID dell'elenco da eliminare

Parametri facoltativi:

• Etag: ETag per il controllo della concorrenza

sendInviteForList

Invia un invito alla condivisione per concedere le autorizzazioni per un elenco di SharePoint.

Parametri obbligatori:

• listId: ID dell'elenco di SharePoint da condividere
• recipientEmails: Matrice di indirizzi di posta elettronica dei destinatari
• Ruolo: Ruolo: 'leggi' (solo visualizzazione), 'contribuisci' (visualizza, aggiungi, aggiorna, elimina elementi), 'modifica' (modifica completa inclusa la struttura dell'elenco)

Parametri facoltativi:

• siteUrl: URL del sito di SharePoint contenente l'elenco
• sendEmail: Indica se inviare una notifica tramite posta elettronica (impostazione predefinita: true)

listListItems

Recupera elementi (righe/record) da un elenco specifico di SharePoint.

Parametri obbligatori:

• Siteid: ID del sito di SharePoint
• listId: ID dell'elenco di SharePoint

getListItem

Ottiene un singolo elemento (riga/record) da un SharePoint list in base al relativo ID.

Parametri obbligatori:

• Siteid: ID del sito di SharePoint
• listId: ID dell'elenco di SharePoint
• Itemid: ID della voce di elenco specifica

createListItem

Crea un nuovo elemento (riga o record) in un elenco di SharePoint.

Parametri obbligatori:

• Siteid: ID del sito di SharePoint
• listId: ID dell'elenco di SharePoint
• Campi: Coppie chiave-valore per i valori di campo: [{ Key: 'Title', Value: 'Software Engineer' }, { Key: 'Department', Value: 'Engineering' }]. Il campo 'Title' è in genere obbligatorio

aggiornaElementoElenco

Aggiorna un elemento esistente (riga o record) in un elenco di SharePoint. Vengono aggiornati solo i campi specificati; i campi omessi mantengono i valori.

Parametri obbligatori:

• Siteid: ID del sito di SharePoint
• listId: ID dell'elenco di SharePoint
• Itemid: ID dell'elemento da aggiornare
• Campi: Coppie chiave-valore di campi da aggiornare

Parametri facoltativi:

• Etag: ETag per il controllo della concorrenza

eliminaElementoLista

Elimina un elemento (riga o record) da un elenco di SharePoint.

Parametri obbligatori:

• Siteid: ID del sito di SharePoint
• listId: ID dell'elenco di SharePoint
• Itemid: ID dell'elemento da eliminare

Parametri facoltativi:

• Etag: ETag per il controllo della concorrenza

listColumns

Recupera tutte le colonne di un elenco di SharePoint.

Parametri obbligatori:

• Siteid: ID del sito di SharePoint
• listId: ID dell'elenco di SharePoint

creaColonna

Crea una nuova colonna in un SharePoint list. Supporta molti tipi di colonna, tra cui testo, numero, scelta, dateTime, booleano, utente, ricerca, calcolata e altro ancora.

Parametri obbligatori:

• Siteid: ID del sito di SharePoint
• listId: ID dell'elenco di SharePoint
• Nome: Nome colonna interno (identificatore programmatico)
• Tipo di colonna: Tipo di colonna: testo, nota, numero, intero, booleano, dataOra, scelta, multiscelta, valuta, ricerca, utente, url, calcolato, termine, multitermine, posizione, geolocalizzazione, miniatura, contatore, calcolato, contentTypeId, file, allegato, guid, risultatoScelta, statoApprovazione

Parametri facoltativi:

• columnProperties: Impostazioni specifiche del tipo (ad esempio, { "maxLength": 255 } per il testo, { "choices": ["A","B","C"] } per la scelta)
• Descrizione: Descrizione della colonna
• displayName: Nome visualizzato nell'interfaccia utente (il valore predefinito è 'name')
• Obbligatorio: Impostare la colonna obbligatoria (impostazione predefinita: false)
• Nascosto: Nascondere la colonna dalle visualizzazioni (impostazione predefinita: false)

updateColumn

Aggiorna una colonna esistente in un SharePoint list.

Parametri obbligatori:

• Siteid: ID del sito di SharePoint
• listId: ID dell'elenco di SharePoint
• columnId: ID della colonna da aggiornare

Parametri facoltativi:

• Columntype: Tipo di colonna (obbligatorio quando si specifica 'columnProperties')
• columnProperties: Proprietà specifiche del tipo da aggiornare
• Descrizione: Nuova descrizione
• Displayname: Nuovo nome visualizzato
• Nascosto: Nascondere o visualizzare la colonna
• Obbligatorio: Rendi obbligatoria o facoltativa la colonna

deleteColumn

Elimina una colonna da un SharePoint list. Avviso: Questa azione rimuove tutti i dati archiviati in tale colonna per tutti gli elementi.

Parametri obbligatori:

• Siteid: ID del sito di SharePoint
• listId: ID dell'elenco di SharePoint
• columnId: ID della colonna da eliminare

Funzionalità principali

Gestione del sito

• Trovare siti in base al nome o esplorare i siti accessibili.
• Ottieni un sito tramite il percorso URL esatto.
• Elenca i siti figli e i siti secondari.
• Esplorazione completa della gerarchia dei siti.

Gestione della raccolta documenti

• Elencare tutte le raccolte di documenti in un sito.
• Ottiene la raccolta documenti predefinita.
• Sfoglia il contenuto della cartella (fino a 20 elementi)
• Creare e gestire strutture di cartelle.

Operazioni con i file

• Creare file di testo e binari (≤5 MB).
• Leggere file di testo e binari (≤5 MB).
• Eliminare, rinominare e spostare file e cartelle.
• Copiare file e cartelle tra librerie di documenti.
• Caricare file da URL di SharePoint o di OneDrive.
• Cercare file e cartelle in tutti i siti accessibili.
• Ottenere i metadati di file e cartelle.

Operazioni asincrone

• Copiare e spostare file e cartelle in modo asincrono nelle raccolte documenti.
• Controllare lo stato delle operazioni asincrone usando i token dell'operazione.

Elencare le operazioni

• Creare, leggere ed eliminare elenchi.
• Supporto per più modelli di elenco, tra cui generico, raccolta documenti, eventi e attività.
• Condividere elenchi con autorizzazioni basate sui ruoli.
• Gestire gli elementi di elenco creando, leggendo, aggiornando ed eliminandoli.

Gestione delle colonne

• Creare colonne con un'ampia gamma di tipi, ad esempio testo, nota, numero, booleano, dateTime, scelta, ricerca, utente, URL, calcolato e altro ancora.
• Aggiornare le proprietà e i metadati della colonna.
• Configurare i requisiti e la visibilità delle colonne.
• Imposta le proprietà specifiche del tipo per le colonne.

Condivisione e autorizzazioni

• Condividere file, cartelle ed elenchi con gli utenti.
• Usare il controllo degli accessi in base al ruolo con ruoli di lettura, scrittura, collaborazione e modifica.
• Notifiche tramite posta elettronica per la condivisione
• Messaggi personalizzati negli inviti

Sicurezza e conformità

• Applicare e rimuovere etichette di riservatezza.
• Usare più metodi di assegnazione, tra cui standard, con privilegi e auto.
• Supporto della giustificazione del controllo.
• Usare il controllo di concorrenza con eTags.

Notes

• Le operazioni sui file sono limitate ai file di dimensioni pari o inferiori a 5 MB per il caricamento e il download.
• Le operazioni di copia e spostamento sono asincrone. Usare checkOperationStatus per monitorare lo stato di avanzamento.
• Le operazioni di copia e spostamento supportano operazioni tra librerie all'interno di SharePoint.
• uploadFileFromUrl richiede un URL di origine SharePoint o di OneDrive valido.
• Gli eTag forniscono il controllo della concorrenza per gli aggiornamenti e le eliminazioni.
• Suffisso numerico automatico per i nomi di cartelle duplicati
• Non è possibile annullare l'eliminazione dell'elenco.
• L'eliminazione della colonna rimuove tutti i dati archiviati in tale colonna.
• Le operazioni di ricerca restituiscono i primi 20 risultati per impostazione predefinita.