Microsoft Fabric REST API

https://learn.microsoft.com/en-us/rest/api/fabric
Admin
Microsoft Fabric REST API enables developers to automate Fabric processes and manage items,...
Tokens:2,299,693
Snippets:13,985
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Start mirroring - sample request

Source: https://learn.microsoft.com/en-us/rest/api/fabric/mirroreddatabase/mirroring/start-mirroring

Example request to start mirroring using sample workspace and mirrored database IDs. The response is a 200 OK status code.

```http
POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/mirroredDatabases/b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2/startMirroring
```

--------------------------------

### List workspaces with continuation example - HTTP request and JSON response

Source: https://learn.microsoft.com/en-us/rest/api/fabric/core/workspaces/list-workspaces

Shows the same GET request as the basic example, but the response includes a continuationToken and continuationUri for paginating through additional results.

```http
GET https://api.fabric.microsoft.com/v1/workspaces

```

```json
{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace"
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd",
      "capacityRegion": "East US"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces?continuationToken=LDEsMTAwMDAwLDA%3D"
}
```

--------------------------------

### Get a list of workspaces example

Source: https://learn.microsoft.com/en-us/rest/api/fabric/admin/workspaces/list-workspaces

Sends a GET request to retrieve all workspaces. The response includes workspace details, continuation URI, and continuation token for pagination.

```HTTP
GET https://api.fabric.microsoft.com/v1/admin/workspaces

```

--------------------------------

### Sample Request - Get Mirrored Azure Databricks Catalog

Source: https://learn.microsoft.com/en-us/rest/api/fabric/mirroredazuredatabrickscatalog/items/get-mirrored-azure-databricks-catalog

Example request to get a specific mirrored Azure Databricks catalog using sample workspace and catalog IDs. This is the sample request for the 'Get a mirroredAzureDatabricksCatalog example'.

```HTTP
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/mirroredAzureDatabricksCatalogs/5b218778-e7a5-4d73-8187-f10824047715
```

--------------------------------

### GET /v1/workspaces/{workspaceId}/kqlDashboards

Source: https://learn.microsoft.com/en-us/rest/api/fabric/kqldashboard/items/list-kql-dashboards

This snippet documents the GET endpoint for listing KQL dashboards in a workspace, including parameters, request example, response example, and error handling.

```APIDOC
## [GET] /v1/workspaces/{workspaceId}/kqlDashboards

### Description
Lists KQL dashboards in a workspace. This endpoint retrieves a list of KQL dashboards, optionally filtering by root folder and including nested folders.

### Method
GET

### Endpoint
`https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlDashboards`

### Parameters
#### Path Parameters
- **workspaceId** (string uuid) - Required - The workspace ID.

#### Query Parameters
- **continuationToken** (string) - Optional - A token for retrieving the next page of results.
- **recursive** (boolean) - Optional - Lists items in a folder and its nested folders, or just a folder only. True - All items in the folder and its nested folders are listed, False - Only items in the folder are listed. The default value is true.
- **rootFolderId** (string uuid) - Optional - This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder.

### Request Example
```
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/kqlDashboards
```

### Response
#### Success Response (200)
- **value** (array of KQLDashboard) - The list of KQL dashboards.
  - **id** (string uuid) - The KQL dashboard ID.
  - **displayName** (string) - The display name of the KQL dashboard.
  - **description** (string) - The description of the KQL dashboard.
  - **type** (string) - The item type, e.g., "KQLDashboard".
  - **workspaceId** (string uuid) - The workspace ID.
  - **sensitivityLabel** (object) - The sensitivity label.
    - **id** (string uuid) - The sensitivity label ID.

#### Response Example
```
{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "KQLDashboard_1",
      "description": "A KQL dashboard description.",
      "type": "KQLDashboard",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "sensitivityLabel": {
        "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
      }
    },
    {
      "id": "340d91b9-5a39-409c-b9c0-05ba832c476e",
      "displayName": "KQLDashboard_2",
      "description": "A KQL dashboard description.",
      "type": "KQLDashboard",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "sensitivityLabel": {
        "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
      }
    }
  ]
}
```

### Error Handling
- **429 Too Many Requests** - The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
- **Other Status Codes** - Common error codes: `InvalidItemType` - Invalid item type.
```

--------------------------------

### List deployment pipelines example - HTTP request

Source: https://learn.microsoft.com/en-us/rest/api/fabric/core/deployment-pipelines/list-deployment-pipelines

Sample HTTP GET request to list deployment pipelines.

```HTTP
GET https://api.fabric.microsoft.com/v1/deploymentPipelines

```

--------------------------------

### Get item example - JSON response

Source: https://learn.microsoft.com/en-us/rest/api/fabric/core/items/get-item

Sample JSON response for the Get item example. Returns the item details including displayName, description, type, workspaceId, id, logicalId, and sensitivityLabel.

```JSON
{
  "displayName": "Item 1",
  "description": "Item 1 description",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "logicalId": "1423f3b4-dba5-44c1-a94f-6ae4d776369a",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

```

--------------------------------

### POST /v1/workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/startMirroring

Source: https://learn.microsoft.com/en-us/rest/api/fabric/sqldatabase/mirroring/start-mirroring

Starts the mirroring of a specified SQL database. Requires read and write permissions and the SQLDatabase.ReadWrite.All or Item.ReadWrite.All delegated scope.

```APIDOC
## [POST] /v1/workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/startMirroring

### Description
Starts the mirroring of the specified SQL database.

### Method
POST

### Endpoint
https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/startMirroring

### Parameters
#### Path Parameters
- **sqlDatabaseId** (string uuid) - Required - The SQL database ID.
- **workspaceId** (string uuid) - Required - The workspace identifier.

### Request Example
```
POST https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/sqlDatabases/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/startMirroring
```

### Response
#### Success Response (200)
Request completed successfully.

#### Response Example
Status code: 200

### Error Responses
#### 429 Too Many Requests
The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.

Headers: Retry-After: integer

#### Other Status Codes
Common error codes:
- ItemNotFound - The requested item was not found.

```

--------------------------------

### Start Mirroring

Source: https://learn.microsoft.com/en-us/rest/api/fabric/sqldatabase/mirroring

Starts the mirroring of a specified SQL database.

```APIDOC
## [POST] /v1/databases/{databaseId}/mirroring/start

### Description
Starts the mirroring of the specified SQL database.

### Method
POST

### Endpoint
/v1/databases/{databaseId}/mirroring/start

### Parameters
#### Path Parameters
- **databaseId** (string) - Required - The identifier of the SQL database to start mirroring.

### Response
#### Success Response (200)
No response body is specified.

```

--------------------------------

### Get a capacity example - sample request

Source: https://learn.microsoft.com/en-us/rest/api/fabric/core/capacities/get-capacity

Example request that retrieves the capacity with ID 96f3f0ff-4fe2-4712-b61b-05a456ba9357.

```HTTP
GET https://api.fabric.microsoft.com/v1/capacities/96f3f0ff-4fe2-4712-b61b-05a456ba9357
```

--------------------------------

### List deployment pipelines with continuation example - JSON response

Source: https://learn.microsoft.com/en-us/rest/api/fabric/core/deployment-pipelines/list-deployment-pipelines

Sample JSON response with a continuation token and URI for pagination.

```JSON
{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Fabric deployment pipeline to manage marketing reports."
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance Deployment Pipeline",
      "description": "Fabric deployment pipeline to manage finance reports."
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/deploymentPipelines?continuationToken=LDEsMTAwMDAwLDA%3D"
}
```

--------------------------------

### Get a capacity example - sample response (200 OK)

Source: https://learn.microsoft.com/en-us/rest/api/fabric/core/capacities/get-capacity

Example 200 OK response body for the Get Capacity request. Shows the capacity ID, display name, SKU, region, and state.

```JSON
{
  "id": "96f3f0ff-4fe2-4712-b61b-05a456ba9357",
  "displayName": "F4 Capacity",
  "sku": "F4",
  "region": "West Central US",
  "state": "Active"
}
```

--------------------------------

### Get shortcut transform with One Lake target example

Source: https://learn.microsoft.com/en-us/rest/api/fabric/core/onelake-shortcuts/get-shortcut

This snippet documents the GET operation to retrieve a shortcut with a transform, using a OneLake target example. It includes the request URL, response structure, and relevant definitions.

```APIDOC
## GET /v1/workspaces/{workspaceId}/items/{itemId}/shortcuts/{shortcutPath}

### Description
Retrieves a shortcut with a transform applied, using a OneLake target as an example. The response includes the shortcut's path, name, target details, and transform configuration.

### Method
GET

### Endpoint
`https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/shortcuts/{shortcutPath}`

### Parameters
#### Path Parameters
- **workspaceId** (string, uuid) - Required - The unique identifier of the workspace containing the item.
- **itemId** (string, uuid) - Required - The unique identifier of the item (e.g., a lakehouse) that contains the shortcut.
- **shortcutPath** (string) - Required - The path to the shortcut, including the folder structure and the shortcut name. For example: `Files/blafolder/folder3/MyOneLakeShortcutTransform`.

### Request Example
No request body is required for this GET request.

### Response
#### Success Response (200)
- **path** (string) - The path where the shortcut is created.
- **name** (string) - The name of the shortcut.
- **target** (object) - The target data source object. Must specify exactly one supported destination type.
  - **type** (string) - The type of the target (e.g., `OneLake`).
  - **oneLake** (object) - Properties for a OneLake target.
    - **workspaceId** (string, uuid) - The workspace ID of the target OneLake item.
    - **itemId** (string, uuid) - The item ID of the target OneLake item.
    - **path** (string) - The path within the target item.
- **transform** (object) - The transform applied to the shortcut.
  - **type** (string) - The transform type (e.g., `csvToDelta`).
  - **includeSubfolders** (boolean) - Whether subfolders are included.
  - **properties** (object) - Transform-specific properties.
    - **useFirstRowAsHeader** (boolean) - Whether the first row is used as a header.
    - **delimiter** (string) - The delimiter used in the CSV files.
    - **skipFilesWithErrors** (boolean) - Whether to skip files with errors.

#### Response Example
```json
{
  "path": "Files/blafolder/folder3",
  "name": "MyOneLakeShortcutTransform",
  "target": {
    "type": "OneLake",
    "oneLake": {
      "workspaceId": "acafbeb1-8037-4d0c-896e-a46fb27ff256",
      "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
      "path": "Tables/myTablesFolder/someTableSubFolder"
    }
  },
  "transform": {
    "type": "csvToDelta",
    "includeSubfolders": true,
    "properties": {
      "useFirstRowAsHeader": false,
      "delimiter": ",",
      "skipFilesWithErrors": true
    }
  }
}
```
```

--------------------------------

### POST /v1/workspaces/{workspaceId}/mirroredDatabases/{mirroredDatabaseId}/startMirroring

Source: https://learn.microsoft.com/en-us/rest/api/fabric/mirroreddatabase/mirroring/start-mirroring

Starts the mirroring for the specified mirrored database. Requires read and write permissions on the mirrored database and the appropriate delegated scopes.

```APIDOC
## POST /v1/workspaces/{workspaceId}/mirroredDatabases/{mirroredDatabaseId}/startMirroring

### Description
Starts the mirroring for the specified mirrored database. The caller must have read and write permissions on the mirrored database.

### Method
POST

### Endpoint
https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/mirroredDatabases/{mirroredDatabaseId}/startMirroring

### Parameters
#### Path Parameters
- **mirroredDatabaseId** (string uuid) - Required - The mirrored database ID.
- **workspaceId** (string uuid) - Required - The workspace ID.

### Request Example
```
POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/mirroredDatabases/b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2/startMirroring
```

### Response
#### Success Response (200)
Request completed successfully.

#### Response Example
Status code: 200

### Error Handling
- **429 Too Many Requests** - The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
- **Other Status Codes** - Common error codes include `UnknownError`.
```

--------------------------------

### List deployment pipelines example - JSON response

Source: https://learn.microsoft.com/en-us/rest/api/fabric/core/deployment-pipelines/list-deployment-pipelines

Sample JSON response with a list of deployment pipelines.

```JSON
{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Fabric deployment pipeline to manage marketing reports."
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance Deployment Pipeline",
      "description": "Fabric deployment pipeline to manage finance reports."
    }
  ]
}
```

--------------------------------

### Get info for all domains example

Source: https://learn.microsoft.com/en-us/rest/api/fabric/admin/domains/list-domains(preview)

This example demonstrates how to retrieve information for all domains using the Fabric admin API.

```APIDOC
## [GET] /v1/admin/domains

### Description
Gets information for all domains in the tenant. This endpoint is used to retrieve a list of all domains, including empty ones.

### Method
GET

### Endpoint
https://api.fabric.microsoft.com/v1/admin/domains

### Parameters
#### Query Parameters
- **preview** (boolean) - Optional - When set to `True`, enables the preview version of the API.

### Request Example
```
GET https://api.fabric.microsoft.com/v1/admin/domains?preview=True
```

### Response
#### Success Response (200)
- **domains** (array) - List of domain objects.
  - **id** (string) - The unique identifier of the domain.
  - **displayName** (string) - The display name of the domain.
  - **description** (string) - The description of the domain.
  - **parentDomainId** (string or null) - The identifier of the parent domain, if any.
  - **contributorsScope** (string) - The scope of contributors for the domain.

#### Response Example
```json
{
  "domains": [
    {
      "id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
      "displayName": "Finance",
      "description": "This domain is used for identifying financial data and reports.",
      "parentDomainId": null,
      "contributorsScope": "AdminsOnly"
    },
    {
      "id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
      "displayName": "Human resources",
      "description": "",
      "parentDomainId": null,
      "contributorsScope": "AllTenant"
    },
    {
      "id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
      "displayName": "HR Sales",
      "description": "",
      "parentDomainId": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
      "contributorsScope": "AllTenant"
    },
    {
      "id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
      "displayName": "Marketing",
      "parentDomainId": null,
      "contributorsScope": "SpecificUsersAndGroups"
    },
    {
      "id": "17df435d-9efd-48c1-a937-7d6fd70ab26a",
      "displayName": "AdminsOnly",
      "description": "Admins only",
      "parentDomainId": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
      "contributorsScope": "AllTenant"
    },
    {
      "id": "fb765fe3-d404-4f24-9d67-5916449c4c50",
      "displayName": "Root",
      "description": "",
      "parentDomainId": null,
      "contributorsScope": "AllTenant"
    },
    {
      "id": "bda31be4-7efe-4272-8b85-e1b2ff0f0592",
      "displayName": "Legal",
      "description": "This domain is used for identifying legal data and reports.",
      "parentDomainId": null,
      "contributorsScope": "AllTenant"
    }
  ]
}
```
```

--------------------------------

### Get all non-empty domains example

Source: https://learn.microsoft.com/en-us/rest/api/fabric/admin/domains/list-domains(preview)

This example demonstrates how to retrieve all non-empty domains using the Fabric admin API.

```APIDOC
## [GET] /v1/admin/domains

### Description
Gets all non-empty domains in the tenant. This endpoint is used to retrieve a list of domains that have at least one item assigned to them.

### Method
GET

### Endpoint
https://api.fabric.microsoft.com/v1/admin/domains

### Parameters
#### Query Parameters
- **nonEmptyOnly** (boolean) - Optional - When set to `True`, only returns domains that have at least one item assigned.
- **preview** (boolean) - Optional - When set to `True`, enables the preview version of the API.

### Request Example
```
GET https://api.fabric.microsoft.com/v1/admin/domains?nonEmptyOnly=True&preview=True
```

### Response
#### Success Response (200)
- **domains** (array) - List of domain objects.
  - **id** (string) - The unique identifier of the domain.
  - **displayName** (string) - The display name of the domain.
  - **description** (string) - The description of the domain.
  - **parentDomainId** (string or null) - The identifier of the parent domain, if any.
  - **contributorsScope** (string) - The scope of contributors for the domain.

#### Response Example
```json
{
  "domains": [
    {
      "id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
      "displayName": "Finance",
      "description": "This domain is used for identifying financial data and reports.",
      "parentDomainId": null,
      "contributorsScope": "AdminsOnly"
    },
    {
      "id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
      "displayName": "Human resources",
      "description": "",
      "parentDomainId": null,
      "contributorsScope": "AllTenant"
    },
    {
      "id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
      "displayName": "HR Sales",
      "description": "",
      "parentDomainId": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
      "contributorsScope": "AllTenant"
    },
    {
      "id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
      "displayName": "Marketing",
      "parentDomainId": null,
      "contributorsScope": "SpecificUsersAndGroups"
    }
  ]
}
```
```

--------------------------------

### Create an item example - Sample request (HTTP)

Source: https://learn.microsoft.com/en-us/rest/api/fabric/core/items/create-item

Sends a POST request to create an item in a workspace. The request body includes the display name and type of the item.

```http
POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items

{
  "displayName": "Item 1",
  "type": "Lakehouse"
}

```

--------------------------------

### GET /v1/workspaces/{workspaceId}/dashboards

Source: https://learn.microsoft.com/en-us/rest/api/fabric/dashboard/items/list-dashboards

Documentation for the List Dashboards API endpoint, including parameters, request example, and response example.

```APIDOC
## [GET] /v1/workspaces/{workspaceId}/dashboards

### Description
Lists dashboards in a workspace. This endpoint allows you to retrieve a list of dashboards, optionally filtering by a specific root folder and including nested folders.

### Method
GET

### Endpoint
`https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dashboards`

### Parameters
#### Path Parameters
- **workspaceId** (string uuid) - Required - The workspace ID.

#### Query Parameters
- **continuationToken** (string) - Optional - A token for retrieving the next page of results.
- **recursive** (boolean) - Optional - Lists items in a folder and its nested folders, or just a folder only. True - All items in the folder and its nested folders are listed, False - Only items in the folder are listed. The default value is true.
- **rootFolderId** (string uuid) - Optional - This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder.

### Request Example
```http
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/dashboards
```

### Response
#### Success Response (200)
- **value** (array of Dashboards) - The list of dashboards.

#### Response Example
```json
{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Dashboard Name 1",
      "description": "A dashboard description.",
      "type": "Dashboard",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "sensitivityLabel": {
        "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
      }
    }
  ]
}
```

### Error Responses
- **429 Too Many Requests** - The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests. Headers: `Retry-After: integer`
- **Other Status Codes** - Common error codes: `InvalidItemType` - Invalid item type
```

--------------------------------

### Sample Request: Get Environment Published Libraries

Source: https://learn.microsoft.com/en-us/rest/api/fabric/environment/published/list-libraries

Example request to list published libraries for a specific workspace and environment. Uses `beta=false` for the release version.

```HTTP
GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/libraries?beta=false
```

--------------------------------

### Get environment staging libraries - sample request

Source: https://learn.microsoft.com/en-us/rest/api/fabric/environment/staging/list-libraries

Sample request for getting environment staging libraries, using specific workspace and environment IDs with beta=false.

```HTTP
GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/staging/libraries?beta=false
```

--------------------------------

### Get OneLake Settings with all settings example - HTTP request

Source: https://learn.microsoft.com/en-us/rest/api/fabric/core/onelake-settings/get-settings

Sample HTTP GET request to retrieve all OneLake settings for a workspace.

```http
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227/onelake/settings

```

--------------------------------

### List all workloads example

Source: https://learn.microsoft.com/en-us/rest/api/fabric/admin/workloads/list-workloads

Sample request and response for listing all workloads. The response includes workload details and pagination information.

```http
GET https://api.fabric.microsoft.com/v1/admin/workloads

```

```json
{
  "value": [
    {
      "id": "Fabric.TestWorkload",
      "name": "Test Workload",
      "publisher": "Contoso",
      "isAssignable": true,
      "isAssignedToTenant": true,
      "assignedCapacitiesCount": 2,
      "assignedWorkspacesCount": 0
    },
    {
      "id": "Fabric.TestWorkloadV2",
      "name": "Awesome Workload",
      "publisher": "Contoso",
      "isAssignable": true,
      "isAssignedToTenant": false,
      "assignedCapacitiesCount": 0,
      "assignedWorkspacesCount": 0
    },
    {
      "id": "Fabric.SampleWorkload",
      "name": "Sample Workload",
      "publisher": "SampleOrganization",
      "isAssignable": true,
      "isAssignedToTenant": false,
      "assignedCapacitiesCount": 0,
      "assignedWorkspacesCount": 0
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workloads?continuationToken=MSwxMDAwMCww",
  "continuationToken": "MSwxMDAwMCww"
}
```

--------------------------------

### GET /v1/workspaces/{workspaceId}/reports

Source: https://learn.microsoft.com/en-us/rest/api/fabric/report/items/list-reports

This snippet documents the GET /v1/workspaces/{workspaceId}/reports endpoint, including its parameters, request example, and response structure.

```APIDOC
## [GET] /v1/workspaces/{workspaceId}/reports

### Description
Lists reports in a workspace. This endpoint retrieves a list of reports, optionally filtered by folder and with pagination support.

### Method
GET

### Endpoint
`/v1/workspaces/{workspaceId}/reports`

### Parameters
#### Path Parameters
- **workspaceId** (string uuid) - Required - The workspace ID.

#### Query Parameters
- **continuationToken** (string) - Optional - A token for retrieving the next page of results.
- **recursive** (boolean) - Optional - Lists items in a folder and its nested folders, or just a folder only. True - All items in the folder and its nested folders are listed, False - Only items in the folder are listed. The default value is true.
- **rootFolderId** (string uuid) - Optional - This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder.

### Request Example
```
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/reports
```

### Response
#### Success Response (200)
- **value** (array of Reports) - The list of reports.

#### Response Example
```
{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Report Name 1",
      "description": "A report description.",
      "type": "Report",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "sensitivityLabel": {
        "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
      }
    }
  ]
}
```

### Error Responses
- **429 Too Many Requests** - The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
- **Other Status Codes** - Common error codes: InvalidItemType - Invalid item type.
```

--------------------------------

### GET /v1/workspaces/{workspaceId}/reflexes

Source: https://learn.microsoft.com/en-us/rest/api/fabric/reflex/items/list-reflexes

This snippet documents the GET endpoint for listing Reflexes in a workspace, including its parameters, request example, and response structure.

```APIDOC
## [GET] /v1/workspaces/{workspaceId}/reflexes

### Description
Lists Reflexes in a workspace. This endpoint retrieves a list of Reflex items, optionally filtered by a root folder and including nested folders.

### Method
GET

### Endpoint
https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/reflexes

### Parameters
#### Path Parameters
- **workspaceId** (string uuid) - Required - The workspace ID.

#### Query Parameters
- **continuationToken** (string) - Optional - A token for retrieving the next page of results.
- **recursive** (boolean) - Optional - Lists items in a folder and its nested folders, or just a folder only. True - All items in the folder and its nested folders are listed, False - Only items in the folder are listed. The default value is true.
- **rootFolderId** (string uuid) - Optional - This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder.

### Request Example
```
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/reflexes
```

### Response
#### Success Response (200)
- **value** (array of Reflex) - The list of Reflex items.

#### Response Example
```json
{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Reflex Name 1",
      "description": "A Reflex description.",
      "type": "Reflex",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "sensitivityLabel": {
        "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
      }
    }
  ]
}
```

### Error Responses
- **429 Too Many Requests** - The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
- **Other Status Codes** - Common error codes: InvalidItemType - Invalid item type.
```

--------------------------------

### GET /v1/workspaces/{workspaceId}/dataBuildToolJobs

Source: https://learn.microsoft.com/en-us/rest/api/fabric/databuildtooljob/items/list-data-build-tool-jobs

This snippet documents the GET endpoint for listing DataBuildToolJobs in a workspace, including parameters, request example, and response structure.

```APIDOC
## GET /v1/workspaces/{workspaceId}/dataBuildToolJobs

### Description
Lists DataBuildToolJobs in a workspace. This endpoint retrieves a list of DataBuildToolJobs, optionally filtered by a root folder and with pagination support.

### Method
GET

### Endpoint
`https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataBuildToolJobs`

### Parameters
#### Path Parameters
- **workspaceId** (string uuid) - Required - The workspace ID.

#### Query Parameters
- **continuationToken** (string) - Optional - A token for retrieving the next page of results.
- **recursive** (boolean) - Optional - Lists items in a folder and its nested folders, or just a folder only. True - All items in the folder and its nested folders are listed, False - Only items in the folder are listed. The default value is true.
- **rootFolderId** (string uuid) - Optional - This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder.

### Request Example
```http
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/dataBuildToolJobs
```

### Response
#### Success Response (200)
- **value** (array) - List of DataBuildToolJob items.
  - **id** (string uuid) - The DataBuildToolJob ID.
  - **displayName** (string) - The display name of the DataBuildToolJob.
  - **description** (string) - The description of the DataBuildToolJob.
  - **type** (string) - The type of the item, e.g., "DataBuildToolJob".
  - **workspaceId** (string uuid) - The workspace ID.
  - **properties** (object) - Properties of the DataBuildToolJob.
    - **oneLakeRootPath** (string) - The OneLake root path for the DataBuildToolJob.

#### Response Example
```json
{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "DataBuildToolJob Name 1",
      "description": "A DataBuildToolJob description.",
      "type": "DataBuildToolJob",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
      }
    },
    {
      "id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
      "displayName": "DataBuildToolJob Name 2",
      "description": "A DataBuildToolJob description.",
      "type": "DataBuildToolJob",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/d8f6cf16-3aac-4440-9d76-a03d86b7ae3e"
      }
    }
  ]
}
```

### Error Handling
- **429 Too Many Requests** - The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
- **Other Status Codes** - Common error codes include `InvalidItemType` - Invalid item type.
```

--------------------------------

### Sample request - list datasource elements

Source: https://learn.microsoft.com/en-us/rest/api/fabric/dataagent/published/list-datasource-elements

Example GET request using a specific workspace, data agent, and datasource ID to list elements.

```HTTP
GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataAgents/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/datasources/c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30/elements
```

--------------------------------

### Sample Response: Get Environment Published Libraries

Source: https://learn.microsoft.com/en-us/rest/api/fabric/environment/published/list-libraries

Example JSON response showing a list of published libraries with their types and versions. The response includes a continuation token and URI for pagination.

```JSON
{
  "libraries": [
    {
      "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
      "libraryType": "Custom"
    },
    {
      "name": "samplepython.py",
      "libraryType": "Custom"
    },
    {
      "name": "samplejar.jar",
      "libraryType": "Custom"
    },
    {
      "name": "sampleR.tar.gz",
      "libraryType": "Custom"
    },
    {
      "name": "fuzzywuzzy",
      "libraryType": "External",
      "version": "0.0.1"
    },
    {
      "name": "matplotlib",
      "libraryType": "External",
      "version": "0.0.1"
    }
  ],
  "continuationToken": "null",
  "continuationUri": "null"
}
```

--------------------------------

### Sample request - Get staging DataAgent settings

Source: https://learn.microsoft.com/en-us/rest/api/fabric/dataagent/staging/get-settings

Sample request for getting staging DataAgent settings using example workspace and DataAgent IDs.

```http
GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataAgents/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/staging/settings
```

--------------------------------

### Get CopyJob sample response (JSON)

Source: https://learn.microsoft.com/en-us/rest/api/fabric/copyjob/items/get-copy-job

Example JSON response body for a successful Get CopyJob request, showing the CopyJob object fields.

```json
{
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "displayName": "CopyJob 1",
  "description": "A Copy job description.",
  "type": "CopyJob",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}
```
Tokens:
Raw