Actions on visualizations (charts)

Article
11/28/2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Using the Microsoft Dynamics 365 SDK, you can perform the following actions on the visualization entities.

Actions on organization-owned visualizations

To perform actions on an organization-owned visualization (SavedQueryVisualization), you must have the System Administrator or the System Customizer role. You can perform the following actions on an organization-owned visualization:

Create, retrieve, update, and delete an organization-owned visualization. More information: Create a visualization (chart)

Note

After updating an organization-owned visualization, you must publish the metadata changes to make it visible across the organization by using the PublishAllXmlRequest message. Alternatively, whenever you publish an entity, all the unpublished organization-owned visualizations that are attached to the entity are published automatically.
Query and retrieve all the organization-owned visualizations that are attached to an entity using the SavedQueryVisualization.PrimaryEntityTypeCode attribute. Multiple organization-owned visualizations can be attached to a single entity. For a list of entities with which you can attach a visualization, see Entities supported for visualizations. For a code sample that demonstrates how to retrieve all the organization-owned visualizations attached to an entity, see Sample: Retrieve all charts attached to an entity.

Note

You cannot change or update a visualization to attach it with a different entity after you have created the visualization. It implies that the SavedQueryVisualization.PrimaryEntityTypeCode attribute is not valid for the update action on the organization-owned visualization.
Specify an organization-owned visualization as the default visualization for the associated entity by setting the SavedQueryVisualization.IsDefault attribute to true. When you set an organization-owned visualization as the default visualization for an entity, the visualization is displayed by default when you select to view the visualizations for this entity in the Microsoft Dynamics 365.

Note

Using the Microsoft Dynamics 365 SDK, if you set an organization-owned visualization as default for an entity that already has another visualization set as default, both the visualizations are marked as default visualizations for the entity. To set a visualization as a default visualization for an entity, make sure that no other visualization is set as the default visualization for the entity.

For a list of supported messages on the organization-owned visualization entity, see SavedQueryVisualization (system chart) entity messages and methods.

Actions on user-owned visualizations

You can perform the following actions on a user-owned visualization (UserQueryVisualization):

Create, retrieve, update, and delete a user-owned visualization. More information: Create a visualization (chart)
Query and retrieve all the user-owned visualizations that are attached to an entity using the UserQueryVisualization.PrimaryEntityTypeCode attribute. Multiple user-owned visualizations can be attached to an entity. For a list of entities with which you can attach a visualization, see Entities supported for visualizations.

Note

You cannot change or update a visualization to attach it with a different entity after you have created the visualization. It implies that the UserQueryVisualization.PrimaryEntityTypeCode attribute is not valid for the update action on the user-owned visualization.
Change the ownership of a user-owned visualization by assigning it to another user or team using AssignRequest.
Retrieve the access that the specified security principal (user or team) has to a user-owned visualization using RetrievePrincipalAccessRequest. You can also retrieve all the security principals (users or teams) that have access to a user-owned visualization, along with their access rights to the user-owned visualization using the RetrieveSharedPrincipalsAndAccessRequest.
Collaborate with other users and teams on specific areas by sharing a user-owned visualization with them using GrantAccessRequest, ModifyAccessRequest, and RevokeAccessRequest.

For a list of supported messages on the user-owned visualization entity, see UserQueryVisualization (user chart) entity messages and methods.

Share via

Actions on visualizations (charts)

Actions on organization-owned visualizations

Actions on user-owned visualizations

See Also

Additional resources