Getting Started With Microsoft Graph API Use Cases

Connecting SharePoint to Microsoft Graph API has always required technical knowledge. You needed an understanding of endpoint structures, crafting URLs, navigating the documentation, and diving into Graph Explorer. ShortPoint’s latest update changes all that. The use case feature, which comes with the new Microsoft Graph API Connection, turns what was a complex, code-heavy process into a point-and-click experience that anyone can do, regardless of technical background.

This article explains how to navigate and use the use case feature when setting up ShortPoint Microsoft Graph API connections.

Note: If you're looking for information on how to use the use case feature in other ShortPoint Connections (such as Site News, Hub News, and Org News), please refer to our general use cases article.

TABLE OF CONTENTS

• Prerequisites
• What is the Use Case Feature?
• How to Apply Use Cases in the Microsoft Graph API Connection?
  • Step 1: Add or edit a Design Element
  • Step 2: Select Microsoft Graph API connection type
  • Step 3: Select a use case and get the required parameters
  • Step 4: Configure your connection and hit Connect
  • Step 5: Map items to the Design Element fields
  • Step 6: Hit Update, save your changes, and publish the page

Prerequisites

• You need to have ShortPoint SPFx version 8.6.x.xx or later installed on Microsoft Office 365 (SharePoint Online) or SharePoint 2019 environment.
• You must have the Microsoft Graph API connection enabled. Go to How to Enable Microsoft Graph Integration for MS Graph API Connections to learn how.
• You also need to be a ShortPoint Designer with an active license.

What is the Use Case Feature?

The ShortPoint Microsoft Graph API connection use case feature is a pre-configured system that eliminates manual URL construction when integrating Microsoft Graph API with SharePoint. Instead of writing API endpoints from scratch, you simply select the use case that matches your needs, whether you’re pulling user profiles, calendar events, or team data, and the feature will generate the correct URL for you. If your selected use case requires additional parameters, the interface will walk you through getting them step by step, so you have everything configured correctly without leaving the setup screen. It’s designed for everyone – from complete beginners to experienced users who want to save time.

How to Apply Use Cases in the Microsoft Graph API Connection?

Follow these steps to implement a use case:

Step 1: Add or edit a Design Element

Let us begin by inserting a new Design Element or editing one that you want to use to display data on your page.

In our example, we are using the Simple List Design Element.

Step 2: Select Microsoft Graph API connection type

Go to the Connect tab on the Design Element Settings window and select Microsoft Graph API.

Note: Ensure that Microsoft Graph API connections are enabled before using this feature. Learn more about it in How to Enable Microsoft Graph Integration for MS Graph API Connections.

Step 3: Select a use case and get the required parameters

You'll see a variety of use case tiles available for selection. Each tile clearly shows what type of data you can retrieve, with icons indicating which Microsoft 365 applications they connect to.

Search by entering keywords, browse by category, or simply scroll through to find your desired use case.

In our example, we will search for Members of a Group. This use case will list all members of a specified group in your organization.

The Members of a Group use case requires the Group ID as an additional parameter. To get this

• Click the Get Parameter link above the required parameter.
• Search for the Group you want to display by pressing the arrow buttons.
• Hit the copy icon that appears when you hover over the parameter that you need.
• Go back to the previous window and replace the placeholder parameter content.
• Once done, click the Run Query button. If your query was successful, you will be able to view the results.

Some use cases do not require additional parameters, while others may have two or more. Some are retrieved the same way as our example, while others are entered directly into the field. This depends on the desired output data and the filters that need to be applied.

Step 4: Configure your connection and hit Connect

You can now modify your connection settings, such as Items Limit and caching options for optimized performance. Then hit Connect.

Step 5: Map items to the Design Element fields

• Go to the Items tab and delete the default content.
• Use the link icon to select the properties you want to display on each respective field.
• Use the Preview button to see how the data will be shown on your page.

Step 6: Hit Update, save your changes, and publish the page

• When you are done, press the Update button.
• You can click the eye icon to preview how your connected Design Element appears on your page.
• Then, Save your changes and publish the page.

Once the connection is set up, any updates to the data source will automatically be retrieved and displayed on your page. You no longer have to manually edit and update information.

That’s how easy it is to tap into the power of Microsoft Graph API with the new ShortPoint Connection! We will continue to add new use cases based on your feedback and what we see are most useful to you, our customers.

TIP:
Want to add search or filters to make it easier for your users to look for data they need? The Search & Filter Toolbar is exactly what you need!  With it, users can quickly search, sort, and filter through data you display in seconds. Ready to give it a try? Check out Getting Started: The Basics of the Search & Filter Toolbar.

Related articles:

• Connection Type: Microsoft Graph API
• Microsoft Graph API Resources and Common Use Cases
• Microsoft Graph API: Use Cases
• Microsoft Graph API: Supported and Non-Supported Endpoints