Microsoft Power Platform

https://learn.microsoft.com/en-us/power-apps/developer/
Admin
This documentation provides comprehensive guides and references for developers to build and extend...
Tokens:7,078,301
Snippets:51,533
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Using statements for SDK for .NET quick start sample

Source: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/fetchxml/sample

Add these using statements to the top of the program.cs file to adapt the Quick Start: Execute an SDK for .NET request (C#) sample for testing queries. Requires installing the ConsoleTables NuGet package.

```csharp
using Microsoft.Xrm.Sdk;
using Microsoft.Xrm.Sdk.Query;
using System.Text;
using System.Xml.Linq;
```

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

### Get main form descriptor with Xrm.Utility.getEntityMainFormDescriptor

Source: https://learn.microsoft.com/en-us/power-apps/developer/model-driven-apps/clientapi/reference/xrm-utility/getentitymainformdescriptor

Shows how to call Xrm.Utility.getEntityMainFormDescriptor with an entity name and form ID. The formId parameter is optional; the example uses a specific GUID for the account table.

```JavaScript
  // Define the table and form ID
  var entityName = "account";
  var formId = "8448b78f-8f42-454e-8e2a-f8196b0419af";

  // Get the main form descriptor 
  Xrm.Utility.getEntityMainFormDescriptor(entityName, formId);

```

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

### Get agent response example

Source: https://learn.microsoft.com/en-us/power-apps/developer/code-apps/how-to/connect-to-copilot-studio

Example of calling ExecuteCopilotAsyncV2 and checking the completed flag to get the last response.

```typescript
const response = await CopilotStudioService.ExecuteCopilotAsyncV2({
  message: "Summarize the latest product trends",
  notificationUrl: "https://notificationurlplaceholder",
  agentName: "cr3e1_trendAnalyzer"
});

if (response.data.completed) {
  const agentResponse = response.data.lastResponse;
  console.log("Agent response:", agentResponse);
}

```

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

### Example output for first page

Source: https://learn.microsoft.com/en-us/power-apps/developer/model-driven-apps/clientapi/reference/xrm-webapi/retrievemultiplerecords

Shows the console output from the first example, displaying three account records and the next page link.

```Console
{@odata.etag: "W/"1035541"", name: "A. Datum", accountid: "475b158c-541c-e511-80d3-3863bb347ba8"}
@odata.etag: "W/"1035541""accountid: "475b158c-541c-e511-80d3-3863bb347ba8"name: "A. Datum"__proto__: Object
VM5595:4 
{@odata.etag: "W/"947306"", name: "Adventure Works", accountid: "a8a19cdd-88df-e311-b8e5-6c3be5a8b200"}
VM5595:4 
{@odata.etag: "W/"1033754"", name: "Alpine Ski House", accountid: "aaa19cdd-88df-e311-b8e5-6c3be5a8b200"}
VM5595:6 
Next page link: [Organization URI]/api/data/v9.0/accounts?$select=name&$skiptoken=%3Ccookie%20pagenumber=%222%22%20pagingcookie=%22%253ccookie%2520page%253d%25221%2522%253e%253caccountid%2520last%253d%2522%257bAAA19CDD-88DF-E311-B8E5-6C3BE5A8B200%257d%2522%2520first%253d%2522%257b475B158C-541C-E511-80D3-3863BB347BA8%257d%2522%2520%252f%253e%253c%252fcookie%253e%22%20istracking=%22False%22%20/%3E
```

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

### SDK-style project file example

Source: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/build-and-package

Example of a plug-in project file in the SDK style, as generated by tools like `pac plugin init`. Must contain `<Project Sdk="Microsoft.NET.Sdk">` and target `net462`.

```xml
<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFramework>net462</TargetFramework>
    <PowerAppsTargetsPath>$(MSBuildExtensionsPath)\Microsoft\VisualStudio\v$(VisualStudioVersion)\PowerApps</PowerAppsTargetsPath>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
    <FileVersion>1.0.0.0</FileVersion>
    <ProjectTypeGuids>{4C25E9B5-9FA6-436c-8E19-B395D2A65FAF};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}</ProjectTypeGuids>
  </PropertyGroup>
  ...
</Project>

```

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

### Get saved query GUID (Active Accounts)

Source: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/web-api-query-data-sample

Retrieves the savedqueryid GUID for the saved query named 'Active Accounts' using a GET request with OData filters.

```HTTP
GET [Organization Uri]/api/data/v9.2/savedqueries?$select=name,savedqueryid&$filter=name eq 'Active Accounts' HTTP/1.1
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json

```

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

### Validate MCP endpoint setup

Source: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/cli/reference

Validates the MCP endpoints and authentication setup without starting the server. Recommended as a first step.

```PowerShell
dataverse mcp https://myorg.crm.dynamics.com --validate
```

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

### Create project folder and install dependencies

Source: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/quick-start-js-spa

Run these commands in a terminal to create a new folder named 'quickspa', move into it, install Parcel, MSAL.js, and dotenv, create a 'src' folder, and open Visual Studio Code.

```bash
mkdir quickspa
cd quickspa
npm install --save-dev parcel
npm install @azure/msal-browser
npm install dotenv
mkdir src
code .
```

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

### Retrieve AADUser records whose givenname does NOT start with 'test'

Source: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/aaduser-entity

HTTP GET request that filters AADUser records where givenname does not start with 'test'.

```HTTP
https://[Organization URI].crm.dynamics.com/api/data/v9.1/aadusers?$filter=not startswith(givenname, 'test')
```

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

### Install sample data using InstallSampleDataRequest (SDK for .NET)

Source: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/sample-data

Use the InstallSampleDataRequest class with the IOrganizationService.Execute method to install a pre-defined set of sample data. The returned InstallSampleDataResponse class does not include any properties to examine.

```C#
static void InstallSampleData(IOrganizationService service)
{
    var request = new InstallSampleDataRequest();
    service.Execute(request);
}

```

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

### Run and publish the app

Source: https://learn.microsoft.com/en-us/power-apps/developer/code-apps/how-to/add-flows

Build the app, and then use `pa app push` to publish it:

```Bash
npm run build
pa app push

```

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

### Retrieve AADUser records whose givenname starts with 'test'

Source: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/aaduser-entity

HTTP GET request that filters AADUser records where givenname starts with 'test'.

```HTTP
https://[Organization URI].crm.dynamics.com/api/data/v9.1/aadusers?$filter=startswith(givenname, 'test')
```

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

### pac tool prt

Source: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/download-tools-nuget

Downloads and launches the Plug-in Registration Tool (PRT), installing it on first launch. Creates a shortcut in the start menu and reports installation and launch success.

```Bash
> pac tool prt

Installing 9.1.0.155 version of PRT....
Shortcut in start menu created for 'Plugin Registration Tool'
Installation complete
Launched PRT (9.1.0.155).

```

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

### Install the SDK from GitHub source

Source: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/sdk-python/get-started

Clones the PowerPlatform-DataverseClient-Python repository and installs the SDK in editable mode. Use this instead of the PyPI package; do not install both.

```bash
git clone https://github.com/microsoft/PowerPlatform-DataverseClient-Python.git
cd PowerPlatform-DataverseClient-Python
pip install -e .
```

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

### Create .env file with configuration values

Source: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/quick-start-js-spa

Create a .env file in the root of the quickspa folder with the provided configuration values. Replace CLIENT_ID and TENANT_ID with values from your app registration, and set BASE_URL to your environment's Web API URL.

```text
# The environment this application will connect to.
BASE_URL=https://<yourorg>.api.crm.dynamics.com
# The registered Entra application id
CLIENT_ID=11112222-bbbb-3333-cccc-4444dddd5555
# The Entra tenant id
TENANT_ID=aaaabbbb-0000-cccc-1111-dddd2222eeee
# The SPA redirect URI included in the Entra application registration
REDIRECT_URI=http://localhost:1234/redirect.html
```

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

### Get GridRowData from a grid row

Source: https://learn.microsoft.com/en-us/power-apps/developer/model-driven-apps/clientapi/reference/grids/gridrowdata

Retrieves the GridRowData object for a grid row using the grid context. The example gets the grid, then a row by argument, and accesses the data property.

```javascript
var myRows = gridContext.getGrid().getRows();
var myRow = myRows.get(arg);
var gridRowData = myRow.data;

```

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

### Create .env file with connection settings

Source: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/samples/column-level-security-powershell

Create a .env file with the environment URL, client ID, client secret, and tenant ID. Replace the placeholder values with your actual credentials before running the sample.

```env
# The environment this application will connect to.
BASE_URL=https://<yourorg>.api.crm.dynamics.com/
# The application user application id
CLIENT_ID=00001111-aaaa-2222-bbbb-3333cccc4444
# The application user secret
CLIENT_SECRET=Aa1Bb~2Cc3.-Dd4Ee5Ff6Gg7Hh8Ii9_Jj0Kk1Ll2
# The Entra tenant id
TENANT_ID=aaaabbbb-0000-cccc-1111-dddd2222eeee
```

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

### GET [Organization URI]/api/data/v9.2/accounts

Source: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/query/overview

Example of a GET request to retrieve account data with query options. Demonstrates using $select, $orderby, and $filter without parameter aliases.

```APIDOC
## GET [Organization URI]/api/data/v9.2/accounts

### Description
Retrieves account data with specified columns, sorting, and filtering using OData query options.

### Method
GET

### Endpoint
[Organization URI]/api/data/v9.2/accounts

### Parameters
#### Query Parameters
- **$select** (string) - Optional - Specifies which properties to return.
- **$orderby** (string) - Optional - Specifies the sort order of the results.
- **$filter** (string) - Optional - Filters the collection based on a condition.

### Request Example

GET [Organization URI]/api/data/v9.2/accounts?$select=name,revenue
&$orderby=revenue asc,name desc
&$filter=revenue ne null


### Response
#### Success Response (200)
Returns the requested account data.

#### Response Example
(No explicit response example provided in the source.)
```

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

### InstallSampleData

Source: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/reference/actions

Installs the sample data.

```APIDOC
## InstallSampleData

### Description
Installs the sample data.

### Method
POST

### Endpoint
[Organization URI]/api/data/v9.2/InstallSampleData

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **Response** (string) - The response.

#### Response Example
```json
{
  "Response": ""
}
```
```

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

### GET [Organization URI]/api/data/v9.2/accounts (with parameter aliases)

Source: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/query/overview

Example of a GET request using parameter aliases for $filter and $orderby. Parameter aliases allow reusing values and can be used with functions.

```APIDOC
## GET [Organization URI]/api/data/v9.2/accounts

### Description
Retrieves account data using parameter aliases in $orderby and $filter to reuse values.

### Method
GET

### Endpoint
[Organization URI]/api/data/v9.2/accounts

### Parameters
#### Query Parameters
- **$select** (string) - Optional - Specifies which properties to return.
- **$orderby** (string) - Optional - Specifies the sort order using aliases (e.g., @p1 asc, @p2 desc).
- **$filter** (string) - Optional - Filters the collection using aliases (e.g., @p1 ne @p3).
- **@p1** (string) - Optional - Parameter alias for a property name (e.g., revenue).
- **@p2** (string) - Optional - Parameter alias for a property name (e.g., name).
- **@p3** (string) - Optional - Parameter alias for a value (e.g., null).

### Request Example

GET [Organization URI]/api/data/v9.2/accounts?$select=name,revenue
&$orderby=@p1 asc,@p2 desc
&$filter=@p1 ne @p3&@p1=revenue&@p2=name


### Response
#### Success Response (200)
Returns the requested account data.

#### Response Example
(No explicit response example provided in the source.)
```

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

### GET /aadusers?$filter=startswith(givenname, 'test')

Source: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/aaduser-entity

Retrieves AADUser records where the givenname starts with 'test'.

```APIDOC
## GET /aadusers?$filter=startswith(givenname, 'test')

### Description
Retrieves AADUser records where the givenname starts with 'test'.

### Method
GET

### Endpoint
https://[Organization URI].crm.dynamics.com/api/data/v9.1/aadusers?$filter=startswith(givenname, 'test')

### Parameters
#### Query Parameters
- **$filter** (string) - Required - OData filter expression to filter records by givenname.

### Request Example
No request body required.

### Response
#### Success Response (200)
- **value** (array) - List of AADUser records matching the filter.

#### Response Example
{
  "value": [
    {
      "givenname": "testuser"
    }
  ]
}
```
Tokens:
Raw