Actions on dashboards

You can perform actions such as create, retrieve, update, or delete, on organization-owned and user-owned dashboards.

Actions on an organization-owned dashboard

To perform the following actions on an organization-owned dashboard (SystemForm), you must have the System Administrator or the System Customizer role assigned to your account in Microsoft Dataverse:

  • Create, retrieve, update, and delete. You can create or update an organization-owned dashboard by using the Dataverse web services or by customizing the form. For detailed information about creating a dashboard, see Create a dashboard.

  • Set an organization-owned dashboard as the default dashboard for an organization by setting the SystemForm.IsDefault value to true while creating or updating the dashboard.

    Important

    Using the methods available in the Dataverse Web Services, it is possible to set two dashboards as the default. Make sure that no other dashboard is the default dashboard for the organization before updating this setting programmatically.

    After you update an organization-owned dashboard, you must publish the metadata changes to make it visible across the organization. You can use the PublishAllXmlRequest message or PublishXmlRequest message to publish the changes made for an organization-owned dashboard. For a sample code that demonstrates this, see Sample: Create, retrieve, update, and delete (CRUD) a dashboard.

    For a list of supported messages on the organization-owned dashboard table, see SystemForm table.

Note

Unsure about entity vs. table? See Developers: Understand terminology in Microsoft Dataverse.

Actions on a user-owned dashboard

You can perform the following actions on a user-owned dashboard (UserForm):

  • Create, retrieve, update, and delete. For detailed information about creating a user-owned dashboard, see Create a dashboard.

  • Change the ownership of a user-owned dashboard by assigning it to another user or team using the AssignRequest message.

  • Retrieve the access that the specified security principal (user or team) has to a user-owned dashboard using the RetrievePrincipalAccessRequest message. You can also retrieve all the security principals (users or teams) that have access to a user-owned dashboard, along with their access rights to the user dashboard using the RetrieveSharedPrincipalsAndAccessRequest message.

  • Collaborate with other users and teams on specific areas by sharing a user-owned dashboard with them using the GrantAccessRequest, ModifyAccessRequest, and RevokeAccessRequest messages.

    For a list of supported messages on the user-owned dashboard table, see UserForm table.

See also

Dashboards for Microsoft Dataverse
Using FormXML for dashboards
Create a dashboard
Sample dashboards
Sample: Create, retrieve, update, and delete (CRUD) a dashboard
Sample: Assign a user-owned dashboard to another user