Mastering SharePoint REST API: A Comprehensive Guide to Endpoints and Usage

 1. Every REST endpoint URL commences with:

        https://{site_url}/_api/

2. To access a specific site collection:

        https://{site_url}/_api/site

3.      To access a specific site:

        https://{site_url}/_api/web

4. Get the SharePoint site title:

        https://{site_url}/_api/web/title

5. Get all lists from a SharePoint site:

        https://{site_url}/_api/web/lists

6. Get all items from a SharePoint list:

        https://{site_url}/_api/web/lists/getbytitle(‘list name’)/items

7. Get a particular column from the SharePoint list:

        https://{site_url}/_api/web/lists/getbytitle(‘list name’)?select={columnName}

8.    Get the lookup field column value from the SharePoint list:

   https://{siteurl}/_api/web/lists/getbytitle(‘Employees’)/items?$select=Department/Name,Department/Branch&$expand=Department

9.    Get all columns from a SharePoint list:

      https://{site_url}/_api/web/lists/getbytitle(‘list name’)/Fields

10.    Get a SharePoint list by using a list GUID:

       https://{site_url}/_api/web/Lists(guid ‘GUID’)

11.    Get SharePoint list item by item id:

       https://{site_url}/_api/web/lists/getbytitle(‘list name’)/items(2)

12.    Get SharePoint logged-in user information:

        https://{site_url}/_api/web/currentUser

13.    Get all SharePoint site users:

       https://{site_url}/_api/web/siteusers

14.    Get all SharePoint groups from the site:

       https://{site_url}/_api/web/sitegroups

15.    Get a particular SharePoint group by group id:

       https://{site_url}/_api/web/sitegroups/GetById(GroupId)

16.    Get all users from a SharePoint group:

       https://{site_url}/_api/web/sitegroups(Id)/users

17.    Get all files from a folder:        https://{siteurl}/_api/web/GetFileByServerRelativeUrl(’/sites/Site Name/Library Name’)/Files

18.    Get metadata for the particular document:

https://{siteurl}/_api/web/GetFileByServerRelativeUrl(’/sites/Site Name/Library Name/filename.docx’)/listItemAllFields


19.    Get the current version of a file:

https://{siteurl}/_api/web/lists(ListID)/items(23)?$select=FileLeafRef,OData__UIVersionString

20.    Get the E tag of a document:

   https://{siteurl}/_api/web/GetFileByServerRelativeUrl(’/sites/Site Name/Library Name/filename.docx’)/etag

21. Retrieve the root folder of your Shared Documents library:

https://{siteurl}/_api/web/GetFolderByServerRelativeUrl(’/Shared Documents’)

22. Create a folder:

    https://{siteurl}/_api/web/folders (POST Method - Needs Parameters)

23. Retrieve all of the files in a folder:

https://{siteurl}/_api/web/GetFolderByServerRelativeUrl(’/Folder Name’)/Files

24. Retrieve a specific file:

https://{siteurl}/_api/web/GetFolderByServerRelativeUrl(’/Folder Name’)/Files(’{file_name}’)

25. Retrieve a file when you know its URL:

https://{siteurl}/_api/web/GetFileByServerRelativeUrl(’/Folder Name/{file_name})/$value’

26. Create a file and add it to a folder:

https://{siteurl}/_api/web/GetFolderByServerRelativeUrl(’/Folder Name’)/Files/add(url=‘a.txt’,overwrite=true)

27. Check out a file:

https://{siteurl}/_api/web/GetFileByServerRelativeUrl(’/Folder Name/{file_name}’)/CheckOut()

28. Check in a file:

https://{siteurl}/_api/web/GetFileByServerRelativeUrl(’/Folder Name/{file_name}’)/CheckIn(comment=‘Comment’,checkintype=0)


29. Retrieve all of the files that are attached to a list item:

https://{siteurl}/_api/web/lists/getbytitle(’{list_title}’)/items({item+id})/AttachmentFiles/

30. Retrieve a file that is attached to a list item:

https://{siteurl}/_api/web/lists/getbytitle(’{list_title}’)/items({item_id})/AttachmentFiles(’{file_name}’)/$value

31. Retrieve the URL of the tenant app catalog:

        https://api/SP_TenantSettings - Current




No comments:

Post a Comment

Thanks!

Pages