Edit

Share via

Fabric REST API documentation structure

  • Article

Microsoft Fabric REST APIs are designed to help developers automate Fabric. The Fabric REST API reference pages (documentation) are structured to help developers find the information they need.

The reference pages are divided into two main sections:

  • Core APIs - Core APIs provide information and functionality for all items within Microsoft Fabric. Core APIs aren't specific to one workload, and can be used across all workloads. Core APIs are Create, Read, Update, and Delete (CRUD) APIs. You can use them to create or update Fabric items alongside their common properties. The core APIs can be used while executing batch operations that don't force manipulation of any property specific to a particular item type.

  • Workload APIs - Workload APIs target a specific item type in Fabric.

The core and workload reference page sections list all APIs alphabetically. Each section contains an overview that includes a list of all the APIs in the section, and an alphabetical list of the APIs in the section.

Item Specific Entry

The item-specific section details the specifics of each item type in Fabric. Each item type entry contains:

  • Overview: A brief description of the item type.

  • Endpoints: Lists available endpoints for the item type, along with details on parameters, request and response formats, and examples.

  • Models: Defines the data model for the item type, specifying properties and types.

  • Actions: Lists available actions for the item type, including details on parameters, request and response formats, and examples.

Use the item-specific entry to understand the unique aspects of the API related to a specific item type and for guidance on performing operations related to that item type.

Reference page structure

Each reference page has the following sections:

  • Overview - A short paragraph at the top of the article that describes the API.

  • Permissions - A list of user permissions needed for calling the API.

  • Required scope - A list of permissions (also known as scopes) the API requires.

  • Limitations - (Optional) A list of limitations for the API.

  • Interface - Displays the HTTP form of the API.

  • URI Parameters - A list of parameters used to identify a specific resource or resources.

  • Request Body - A list of properties that can be passed to the API.

  • Responses - A list of possible responses from the API.

  • Examples - A list of examples that show how to use the API.

  • Definitions - Parameters that that define the structure and properties of an object that can be passed to the API.

The new API documentation reference structure is intended to provide a clear and consistent way of accessing and using the API information. By separating the CORE section and the item specific entry, we hope to make it easier for developers to find and use the information they need to integrate with Microsoft Fabric service.

We welcome your feedback and suggestions on how to improve the documentation and the API.

Related content