MsAPI
Clients
- venvog :
0
- venvon :
1
MsAPI( 'clientId' ).info(); // Microsoft client informations
SharepointClient
MsAPI( 'clientId' ).Sp();
Sites
-
Sp.QuerySitesFilter
-
Sp.SiteTemplate
-
Sp.CreateCommSiteProps
-
Sp.CreateTeamSiteProps
-
Sp.SiteUpdateProps
MsAPI( 'clientId' ).Sp()
.Sites().get<[]>( { ...Sp.QuerySitesFilter... } );
MsAPI( 'clientId' ).Sp()
.Sites( 'siteId' ).get();
MsAPI( 'clientId' ).Sp()
.Sites().create( Sp.SiteTemplate , Sp.CreateCommSiteProps | Sp.CreateTeamSiteProps );
MsAPI( 'clientId' ).Sp()
.Sites( 'siteId' ).update({ ...Sp.SiteUpdateProps... });
MsAPI( 'clientId' ).Sp()
.Sites( 'siteId' ).delete();
Files
This controller is responsible for handling files across an entire site. It’s the most resource-intensive controller but offers complete control.
MsAPI( 'clientId' ).Sp()
.Sites( 'siteId' ).Files().get<[]>();
MsAPI( 'clientId' ).Sp()
.Sites( 'siteId' ).Files( 'path/to/file' ).get();
MsAPI( 'clientId' ).Sp()
.Sites( 'siteId' ).Files( 'path/to/file' ).create( fileContent );
MsAPI( 'clientId' ).Sp()
.Sites( 'siteId' ).Files( 'path/to/file' ).update( fileContent );
MsAPI( 'clientId' ).Sp()
.Sites( 'siteId' ).Files( 'path/to/file' ).delete();
Lists
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists().get<[]>( { ...Sp.QueryListsFilter... } );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists().create({ ...Sp.CreateListOption... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).update({ ...<any>... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).delete();
List-items
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Items().get<[]>( { ...Sp.QueryItemsFilter... } );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Items( 'itemId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Items().create({ ...Sp.Item... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Items( 'itemId' ).update({ ...Sp.Item... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Items( 'itemId' ).delete();
List-fields
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Fields().get<[]>( { ...Sp.QueryItemsFilter... } );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Fields( 'fieldId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Fields().create({ ...Sp.FieldCreationProperties... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Fields( 'fieldId' ).update({ ...Sp.FieldInfo... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Fields( 'fieldId' ).delete();
List-views
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Views().get<[]>();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Views( 'viewId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Views().create({ ...Sp.ViewCreateProps... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Views( 'viewId' ).update({ ...Sp.ViewInfo... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Views( 'viewId' ).delete();
List-view-fields
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Views( 'viewId' ).Fields().get<[]>( { ...Sp.QueryItemsFilter... } );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Views( 'viewId' ).Fields( 'fieldId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Views( 'viewId' ).Fields().create({ ...Sp.FieldCreationProperties... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Views( 'viewId' ).Fields( 'fieldId' ).update({ ...Sp.FieldInfo... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Views( 'viewId' ).Fields( 'fieldId' ).delete();
Document List
Document List - Files
This controller is responsible for manipulating files within a list. It is less resource-intensive but suitable for flat document lists.
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Files().get<[]>();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Files( 'fileId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Files().create({ ... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Files( 'fileId' ).update({ ... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Files( 'fileId' ).delete();
Document List - Folders
This controller is responsible for manipulating files within a list, folder, or subfolder of the list. It offers the best compromise between flexibility and performance.
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Folders().get<[]>();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Folders( 'path/to/folder' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Folders( 'path/to/folder' ).createOneFolder();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Folders( 'path/to/folder' ).deleteOneFolder();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Folders( 'path/to/folder' ).getFileByFolder();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Folders( 'path/to/folder' ).getFileByFolder( 'fileName' );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Folders( 'path/to/folder' ).createOneFileByFolder( 'fileName' , fileContent );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Folders( 'path/to/folder' ).updateOneFileByFolder( 'fileName' , fileContent );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Folders( 'path/to/folder' ).deleteOneFileByFolder( 'fileName' );
Subscriptions
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Subscriptions().get<[]>();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Subscriptions( 'subscriptionId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Subscriptions().create();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Subscriptions( 'subscriptionId' ).update();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Lists( 'listId' ).Subscriptions( 'subscriptionId' ).delete();
Parts
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Parts().get<[]>( { ...Sp.QueryPartsFilter... } );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Parts( 'partId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Parts().create({ ...Sp.Field... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Parts( 'partId' ).update({ ...Sp.WebPartDefinition... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Parts( 'partId' ).delete();
Navigations
-
Sp.QueryNavigationsFilter
-
Sp.CreateNaviagationProps
-
Sp.CreateNaviagationOptions
-
Sp.WebPartDefinition
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Navigations().get<[]>( { ...Sp.QueryNavigationsFilter... } );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Navigations( 'navNodeId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Navigations().create( Sp.CreateNaviagationProps , Sp.CreateNaviagationOptions );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Navigations( 'navNodeId' ).update({ ...Sp.WebPartDefinition... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Navigations( 'navNodeId' ).delete();
Navigation-childrens
-
Sp.QueryNavigationsFilter
-
Sp.CreateNaviagationProps
-
Sp.CreateNaviagationOptions
-
Sp.WebPartDefinition
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Navigations( 'navNodeId' )
.Childrens().get<[]>( { ...Sp.QueryNavigationsFilter... } );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Navigations( 'navNodeId' )
.Childrens( 'navNodeChildrenId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Navigations( 'navNodeId' )
.Childrens().create( Sp.CreateNaviagationProps , Sp.CreateNaviagationOptions );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Navigations( 'navNodeId' )
.Childrens( 'navNodeChildrenId' ).update({ ...Sp.WebPartDefinition... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Navigations( 'navNodeId' )
.Childrens( 'navNodeChildrenId' ).delete();
Pages
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages().get<[]>( { ...Sp.QueryPagesFilter... } );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages( 'pageId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages().create( {...Sp.CreatePageProps...} );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages( 'pageId' ).update({ ...<any>... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages( 'pageId' ).delete();
Sections
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages( 'pageId' ).Sections().get<[]>( { ...Sp.QuerySectionsFilter... } );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages( 'pageId' ).Sections( 'sectionId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages( 'pageId' ).Sections().create( {...Sp.ClientsideWebPartData...} );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages( 'pageId' ).Sections( 'sectionId' ).update({ ...<any>... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages( 'pageId' ).Sections( 'sectionId' ).delete();
Columns
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages( 'pageId' ).Sections( 'sectionId' )
.Columns().get<[]>( { ...Sp.QuerySectionsFilter... } );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages( 'pageId' ).Sections( 'sectionId' )
.Columns( 'columnId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages( 'pageId' ).Sections( 'sectionId' )
.Columns().create( {...Sp.CreateColumnProps...} );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages( 'pageId' ).Sections( 'sectionId' )
.Columns( 'columnId' ).update({ ...<any>... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages( 'pageId' ).Sections( 'sectionId' )
.Columns( 'columnId' ).delete();
Controls
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages( 'pageId' ).Sections( 'sectionId' )
.Columns( 'columnId' ).Controls().get<[]>( { ...Sp.QueryControlsFilter... } );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages( 'pageId' ).Sections( 'sectionId' )
.Columns( 'columnId' ).Controls( 'controlId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages( 'pageId' ).Sections( 'sectionId' )
.Columns( 'columnId' ).Controls().create( {...Sp.CreateControlProps...} );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages( 'pageId' ).Sections( 'sectionId' )
.Columns( 'columnId' ).Controls( 'controlId' ).update({ ...<any>... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Pages( 'pageId' ).Sections( 'sectionId' )
.Columns( 'columnId' ).Controls( 'controlId' ).delete();
Webs
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Webs().get<[]>( { ...Sp.QueryItemsFilter... } );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Webs( 'webId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Webs().create({ ...Sp.CreateWebsProps... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Webs( 'webId' ).update({ ...Sp.WebInfo... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Webs( 'webId' ).delete();
Web-files
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
Webs( 'webId' ).Files().get<[]>();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
Webs( 'webId' ).Files( 'path/to/file' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
Webs( 'webId' ).Files( 'path/to/file' ).create( fileContent );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
Webs( 'webId' ).Files( 'path/to/file' ).update( fileContent );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
Webs( 'webId' ).Files( 'path/to/file' ).delete();
Web-lists
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Webs( 'webId' ).Lists().get<[]>( { ...Sp.QueryListsFilter... } );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Webs( 'webId' ).Lists( 'listId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Webs( 'webId' ).Lists().create({ ...Sp.CreateListOption... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Webs( 'webId' ).Lists( 'listId' ).update({ ...<any>... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Webs( 'webId' ).Lists( 'listId' ).delete();
Web-list-items
MsAPI( 'clientId' ).Sp().Sites( 'siteId' ).Webs( 'webId' )
.Lists( 'listId' ).Items().get<[]>( { ...Sp.QueryItemsFilter... } );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' ).Webs( 'webId' )
.Lists( 'listId' ).Items( 'itemId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' ).Webs( 'webId' )
.Lists( 'listId' ).Items().create({ ...Sp.Item... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' ).Webs( 'webId' )
.Lists( 'listId' ).Items( 'itemId' ).update({ ...Sp.Item... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' ).Webs( 'webId' )
.Lists( 'listId' ).Items( 'itemId' ).delete();
Web-list-fields
MsAPI( 'clientId' ).Sp().Sites( 'siteId' ).Webs( 'webId' )
.Lists( 'listId' ).Fields().get<[]>( { ...Sp.QueryItemsFilter... } );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' ).Webs( 'webId' )
.Lists( 'listId' ).Fields( 'fieldId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' ).Webs( 'webId' )
.Lists( 'listId' ).Fields().create({ ...Sp.FieldCreationProperties... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' ).Webs( 'webId' )
.Lists( 'listId' ).Fields( 'fieldId' ).update({ ...Sp.FieldInfo... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' ).Webs( 'webId' )
.Lists( 'listId' ).Fields( 'fieldId' ).delete();
Web-document-list - Files
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Webs( 'webId' ).Lists( 'listId' ).Files().get<[]>();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Webs( 'webId' ).Lists( 'listId' ).Files( 'fileId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Webs( 'webId' ).Lists( 'listId' ).Files().create({ ... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Webs( 'webId' ).Lists( 'listId' ).Files( 'fileId' ).update({ ... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
.Webs( 'webId' ).Lists( 'listId' ).Files( 'fileId' ).delete();
Web-document-list - Folders
MsAPI( 'clientId' ).Sp().Sites( 'siteId' ).Webs( 'webId' )
.Lists( 'listId' ).Folders().get<[]>();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' ).Webs( 'webId' )
.Lists( 'listId' ).Folders( 'path/to/folder' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' ).Webs( 'webId' )
.Lists( 'listId' ).Folders( 'path/to/folder' ).createOneFolder();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' ).Webs( 'webId' )
.Lists( 'listId' ).Folders( 'path/to/folder' ).deleteOneFolder();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' ).Webs( 'webId' )
.Lists( 'listId' ).Folders( 'path/to/folder' ).getFileByFolder();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' ).Webs( 'webId' )
.Lists( 'listId' ).Folders( 'path/to/folder' ).getFileByFolder( 'fileName' );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' ).Webs( 'webId' )
.Lists( 'listId' ).Folders( 'path/to/folder' ).createOneFileByFolder( 'fileName' , fileContent );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' ).Webs( 'webId' )
.Lists( 'listId' ).Folders( 'path/to/folder' ).updateOneFileByFolder( 'fileName' , fileContent );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' ).Webs( 'webId' )
.Lists( 'listId' ).Folders( 'path/to/folder' ).deleteOneFileByFolder( 'fileName' );
Web-pages
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
Webs( 'webId' ).Pages().get<[]>( { ...Sp.QueryPagesFilter... } );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
Webs( 'webId' ).Pages( 'pageId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
Webs( 'webId' ).Pages().create( {...Sp.CreatePageProps...} );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
Webs( 'webId' ).Pages( 'pageId' ).update({ ...<any>... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
Webs( 'webId' ).Pages( 'pageId' ).delete();
Web-navigations
-
Sp.QueryNavigationsFilter
-
Sp.CreateNaviagationProps
-
Sp.CreateNaviagationOptions
-
Sp.WebPartDefinition
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
Webs( 'webId' ).Navigations().get<[]>( { ...Sp.QueryNavigationsFilter... } );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
Webs( 'webId' ).Navigations( 'navNodeId' ).get();
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
Webs( 'webId' ).Navigations().create( Sp.CreateNaviagationProps , Sp.CreateNaviagationOptions );
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
Webs( 'webId' ).Navigations( 'navNodeId' ).update({ ...Sp.WebPartDefinition... });
MsAPI( 'clientId' ).Sp().Sites( 'siteId' )
Webs( 'webId' ).Navigations( 'navNodeId' ).delete();
Graph365Client
MsAPI( 'clientId' ).Graph();
Users
MsAPI( 'clientId' ).Graph().Users().get<[]>( { ...<any>... } );
MsAPI( 'clientId' ).Graph().Users( 'userId' ).get();
MsAPI( 'clientId' ).Graph().Users().create( { ...<any>... } );
MsAPI( 'clientId' ).Graph().Users( 'userId' ).update( { ...<any>... } );
MsAPI( 'clientId' ).Graph().Users( 'userId' ).delete();