Microsoft Power Apps

https://learn.microsoft.com/en-us/power-apps/
Admin
Microsoft Power Apps is a low-code platform that enables users to quickly build custom business...
Tokens:9,005,482
Snippets:58,138
Trust Score:10
Update:6 hours ago
Show doc for...
Tokens:
Raw
### Run the SPA with npm start

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

Run the quick start SPA by typing 'npm start' in a terminal. The first run may show Parcel installing additional Node modules to prevent issues with dotenv.

```bash
npm start
```

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

### data get examples

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

Retrieves a single record by primary key or alternate key using the `dataverse data get` command. The first example fetches an account by GUID; the second targets the linked ERP environment and uses an alternate key with a select clause.

```bash
dataverse data get --table accounts --id 00000000-0000-0000-0000-000000000001
```

```bash
dataverse data get --target erp --table Currencies --key "CurrencyCode='AED'" --select "CurrencyCode,Name"
```

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

### Example: Add SQL data source with sample values

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

Example command using sample connection ID and database details. This shows the exact format for the --dataset parameter with server and database names separated by a comma.

```bash
pa app add data-source --connector "shared_sql" --connection-id "aaaa0000bb11222233cc444444dddddd"  --dataset "sql-codeapps-dev.database.windows.net,sqldb-codeapps-dev" --procedure "dbo.GetAllProjects"
```

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

### pac tool list - Show installed tools

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

Displays the current installation status of each tool. In this example, none are installed yet; they will be installed on first launch.

```plaintext
> pac tool list

ToolName Installed Version Nuget     Status
CMT      No        N/A     9.1.0.80  not yet installed; 'pac tool CMT' will install on first launch
PD       No        N/A     9.1.0.104 not yet installed; 'pac tool PD' will install on first launch
PRT      No        N/A     9.1.0.155 not yet installed; 'pac tool PRT' will install on first launch
```

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

### Run All Function and Action Examples

Source: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/samples/functions-actions-client-side-javascript

This snippet shows the Run method that sequentially executes all eight examples: WhoAmI, FormatAddress, InitializeFrom, RetrieveCurrentOrganization, RetrieveTotalRecordCount, IsSystemAdmin, GrantAccess, and AddPrivilegesRole. It catches errors and attempts cleanup even if an error occurs.

```JavaScript
   // Run the sample
   async Run() {
      try {
         this.#util.appendMessage("<h2>1: Unbound Function WhoAmI</h2>");
         await this.#whoAmIExample();
         this.#util.appendMessage("<h2>2: Unbound Function FormatAddress</h2>");
         await this.#formatAddressExample();
         this.#util.appendMessage("<h2>3: Unbound Function InitializeFrom</h2>");
         await this.#initializeFromExample();
         this.#util.appendMessage(
            "<h2>4: Unbound Function RetrieveCurrentOrganization</h2>"
         );
         await this.#retrieveCurrentOrganizationExample();
         this.#util.appendMessage(
            "<h2>5: Unbound Function RetrieveTotalRecordCount</h2>"
         );
         await this.#retrieveTotalRecordCountExample();
         this.#util.appendMessage(
            "<h2>6: Bound Function IsSystemAdmin custom API</h2>"
         );
         await this.#isSystemAdminExample();
         this.#util.appendMessage("<h2>7: Unbound Action GrantAccess</h2>");
         await this.#grantAccessExample();
         this.#util.appendMessage("<h2>8: Bound Action AddPrivilegesRole</h2>");
         await this.#addPrivilegesRoleExample();
      } catch (error) {
         this.#util.showError(error.message);
         // Try to clean up even if an error occurs
         await this.CleanUp();
      }
   }
```

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

### pac modelbuilder build with parameters

Source: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/org-service/generate-early-bound-classes

Use this command to generate early-bound classes using parameters directly, without a builderSettings.json file. The example uses the same settings as the Get started section, including filters for entities and messages, and writes a builderSettings.json file because of the --writesettingsTemplateFile parameter.

```powershell
PS C:\>pac modelbuilder build `
   --outdirectory C:\projects\exampleproject\model `
   --entitynamesfilter 'account;contact' `
   --generatesdkmessages `
   --messagenamesfilter 'searchautocomplete;searchquery;sample_*' `
   --namespace ExampleProject `
   --serviceContextName OrgContext `
   --suppressGeneratedCodeAttribute `
   --suppressINotifyPattern `
   --writesettingsTemplateFile
```

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

### Create project folder and install dependencies

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

Commands to create the quickspa folder, 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 .
```

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

### GET /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 $orderby and $filter to reuse values.

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

### Description
Retrieves accounts using parameter aliases to avoid repeating values in query options.

### Method
GET

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

### Parameters
#### Query Parameters
- **$select** (string) - Optional - Comma-separated list of properties to return.
- **$orderby** (string) - Optional - Comma-separated list of properties to sort by, using aliases.
- **$filter** (string) - Optional - Boolean expression to filter the collection, using aliases.
- **@p1** (string) - Optional - Alias for a property name.
- **@p2** (string) - Optional - Alias for a property name.
- **@p3** (string) - Optional - Alias for a value.

### 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)
- **value** (array) - The collection of account records.

#### Response Example
```json
{
  "value": [
    {
      "name": "Example Account",
      "revenue": 100000
    }
  ]
}
```
```

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

### Create Web Resource in Solution with SDK for .NET

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

C# example using the SDK for .NET to create a web resource and associate it with a solution by setting the 'SolutionUniqueName' request parameter to 'ExampleSolution'. The web resource content is base64-encoded HTML.

```csharp
static void CreateWebResourceInSolution(IOrganizationService service)
{
    Entity webResource = new("webresource");

    webResource["displayname"] = "Simple HTML web resource";
    webResource["content"] = "PCFET0NUWVBFIGh0bWw+CjxodG1sPgogIDxib2R5PgogICAgPGgxPkhlbGxvIFdvcmxkPC9oMT4KICA8L2JvZHk+CjwvaHRtbD4=";
    webResource["webresourcetype"] = new OptionSetValue(1);
    webResource["name"] = "sample_SimpleHTMLWebResource.htm";
    webResource["description"] = "An example HTML web resource";

    CreateRequest request = new();
    request.Target = webResource;
    request["SolutionUniqueName"] = "ExampleSolution";

    service.Execute(request);
}
```

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

### 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 retrieve the lastResponse. The agentName is 'cr3e1_trendAnalyzer'.

```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

Example console output showing three account records and the nextLink URL with a skiptoken.

```Console Output
{@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
```

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

### Validate MCP 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.

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

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

### Run the sample

Source: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/samples/query-data-client-side-javascript

This method orchestrates the entire sample by calling each query demonstration method in sequence, appending section headings to the output, and handling errors with cleanup. It covers sections for selecting properties, query functions, ordering, aliases, limiting, counting, pagination, expanding, aggregating, FetchXML, and predefined queries.

```JavaScript
  // Run the sample
  async Run() {
    try {
      // Section 1: Select specific properties
      this.#util.appendMessage(
        "<h2>Section 1: Select specific properties</h2>"
      );

      await this.#selectSpecificProperties();

      // Section 2: Use query functions
      this.#util.appendMessage("<h2>Section 2: Use query functions</h2>");
      // standard query functions
      await this.#retrieveContactsWhereFullNameContainsSample();
      // Dataverse query functions
      await this.#retrieveContactsCreatedInLastHour();
      // Use operators
      await this.#retrieveHighIncomeContacts();
      // Set Set precedence
      await this.#retrieveHighIncomeSeniorOrManagerContacts();
      // Section 3: Ordering and aliases
      this.#util.appendMessage("<h2>Section 3: Ordering and aliases</h2>");
      // Order results
      await this.#retrieveContosoContactsOrderedByAnnualIncomeAndTitle();
      // Parameter alias
      await this.#demonstrateParameterAliases();
      // Section 4: Limit and count results
      this.#util.appendMessage("<h2>Section 4: Limit and count results</h2>");
      // Top results
      await this.#getTop5Contacts();
      // Collection count
      await this.#getContactCount();
      // Result count
      await this.#getCountOfFilteredCollection();
      // Section 5: Pagination
      this.#util.appendMessage("<h2>Section 5: Pagination</h2>");
      const results = await this.#retrievePageOfFourContacts();
      await this.#showNextPageOfContacts(results);
      // Section 6: Expand results
      this.#util.appendMessage("<h2>Section 6: Expand results</h2>");
      // Expand on single-valued navigation property
      await this.#retrieveAccountWithPrimaryContact();
      // Expand on partner property
      await this.#retrieveContactWithAccounts();
      // Expand on collection-valued navigation property
      await this.#retrieveAccountContacts();
      // Expand on multiple navigation properties
      await this.#retrieveAccountContactsAndTasks();
      // Multi-level expands
      await this.#retrieveMultiLevelExpands();
      // Section 7: Aggregate results
      this.#util.appendMessage("<h2>Section 7: Aggregate results</h2>");
      await this.#retrieveAnnualIncomeAggregates();
      // Section 8: FetchXML queries
      this.#util.appendMessage("<h2>Section 8: FetchXML queries</h2>");
      await this.#retrieveContactsWithFetchXml();
      await this.#retrieveFirstPageOfContactsWithFetchXml();
      // Section 9: Use predefined queries
      this.#util.appendMessage("<h2>Section 9: Use predefined queries</h2>");
      await this.#getSavedQueryResults();
      const userQueryId = await this.#createUserQuery();
      await this.#showUserQueryResults(userQueryId);
    } catch (error) {
      this.#util.showError(error.message);
      // Try to clean up even if an error occurs
      await this.CleanUp();
    }
  }
```

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

### GET /api/data/v9.2/savedqueries

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

Retrieves the saved query definition by name. This request gets the savedqueryid GUID for a saved query named 'Active Accounts'.

```APIDOC
## [GET] [Organization Uri]/api/data/v9.2/savedqueries

### Description
Retrieves the saved query definition by name. This request gets the savedqueryid GUID for a saved query named 'Active Accounts'.

### Method
GET

### Endpoint
[Organization Uri]/api/data/v9.2/savedqueries

### Parameters
#### Query Parameters
- **$select** (string) - Required - Specifies the properties to return: name, savedqueryid.
- **$filter** (string) - Required - Filters the results to the saved query with name equal to 'Active Accounts'.

### Request Example
```
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
```

### Response
#### Success Response (200)
- **@odata.context** (string) - The OData context URL.
- **value** (array) - Array of saved query objects.
  - **@odata.etag** (string) - The ETag of the record.
  - **name** (string) - The name of the saved query.
  - **savedqueryid** (string) - The GUID of the saved query.

#### Response Example
```
HTTP/1.1 200 OK
OData-Version: 4.0

{
  "@odata.context": "[Organization Uri]/api/data/v9.2/$metadata#savedqueries(name,savedqueryid)",
  "value": [
    {
      "@odata.etag": "W/\"966435\"",
      "name": "Active Accounts",
      "savedqueryid": "00000000-0000-0000-00aa-000010001002"
    }
  ]
}
```
```

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

### NuGet.Config example with package source credentials

Source: https://learn.microsoft.com/en-us/power-apps/developer/component-framework/issues-and-workarounds

Example NuGet.Config file showing how to add package source credentials using a PAT token to resolve authorization errors when building. The feed URL and credentials are placeholders.

```xml
<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <add key="YourFeedName" value="https://contoso.com/_packaging/YourFeedName/nuget/v3/index.json" />
  </packageSources>
  <packageSourceCredentials>
    <YourFeedName>
      <add key="Username" value="anything" />
      <add key="Password" value="User PAT" />
    </YourFeedName>
  </packageSourceCredentials>
</configuration>
```

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

### Get saved query GUID for Active Accounts

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

Request to retrieve the savedqueryid GUID of the saved query named 'Active Accounts' using the savedqueries entity set. The response includes the GUID 00000000-0000-0000-00aa-000010001002.

```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
```

```HTTP
HTTP/1.1 200 OK
OData-Version: 4.0

{
  "@odata.context": "[Organization Uri]/api/data/v9.2/$metadata#savedqueries(name,savedqueryid)",
  "value": [
    {
      "@odata.etag": "W/\"966435\"",
      "name": "Active Accounts",
      "savedqueryid": "00000000-0000-0000-00aa-000010001002"
    }
  ]
}
```

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

### auth list examples

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

Lists all authentication profiles. Add --json for raw JSON output.

```bash
dataverse auth list
dataverse auth list --json
```

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

### GET /api/data/v9.2/accounts (with query options)

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

Example of a GET request to retrieve accounts with selected columns, ordering, and filtering using OData query options.

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

### Description
Retrieves a collection of account records with the specified properties, ordering, and filtering.

### Method
GET

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

### Parameters
#### Query Parameters
- **$select** (string) - Optional - Comma-separated list of properties to return.
- **$orderby** (string) - Optional - Comma-separated list of properties to sort by, with optional `asc` or `desc` suffix.
- **$filter** (string) - Optional - Boolean expression to filter the collection.

### 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)
- **value** (array) - The collection of account records.

#### Response Example
```json
{
  "value": [
    {
      "name": "Example Account",
      "revenue": 100000
    }
  ]
}
```
```

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

### Install Dataverse plugin from Awesome Copilot marketplace

Source: https://learn.microsoft.com/en-us/power-apps/maker/data-platform/data-platform-mcp-vscode

Run this command to install the Dataverse plugin from the Awesome Copilot marketplace. After installation, use the `/dataverse:mcp-configure` skill in a Copilot chat session to configure the MCP server.

```bash
copilot plugin install dataverse@awesome-copilot
```

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

### Example apksigner sign command

Source: https://learn.microsoft.com/en-us/power-apps/maker/common/wrap/code-sign-android

Example command showing how to sign an APK with a specific keystore path, alias, and APK path.

```bash
apksigner.bat sign --ks C:\Users\name\Desktop\powerappswrap.jks --ks-key-alias powerappswrap C:\Users\name\Desktop\MyApp.apk
```

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

### Output of SDK for .NET example

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

Shows the console output from the SDK example, listing entity schema names and attribute logical names, with truncation for brevity.

```text
Entity SchemaName:Account
        Attribute LogicalName:emailaddress3
        Attribute LogicalName:emailaddress1
        Attribute LogicalName:address1_city
    <List truncated for brevity>
Entity SchemaName:Contact
        Attribute LogicalName:contactid
        Attribute LogicalName:emailaddress3
        Attribute LogicalName:emailaddress2
    <List truncated for brevity>
```

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

### Filter formula example

Source: https://learn.microsoft.com/en-us/power-apps/maker/canvas-apps/power-apps-ideas-transform

Example of a Power Fx formula that filters a table based on a name starting with 'Yvonne'. This is shown as an alternative to typing a natural language query.

```powerfx
Filter('Table1', StartsWith('fullname', "Yvonne"))
```
Tokens:
Raw