SystemForm (system dashboard) entity messages and methods

 

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

The system form entity represents the entity forms and organization-owned dashboards in Microsoft Dynamics 365. The display name for this entity is “System Dashboard,” but this entity is used for all entity forms. The schema name for this entity is SystemForm. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message	Description
AssociateRequest	Creates a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Associate method. For more information, see Actions on entity records. For a list of default relationships for this entity, see the SystemForm entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
CreateRequest	Creates a system form. You can also call the IOrganizationService.Create method.
CopySystemFormRequest	Creates a new entity form that’s based on an existing entity form.
DeleteRequest	Deletes a system form. You can also call the IOrganizationService.Delete method.
DisassociateRequest	Removes a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Disassociate method. For more information, see Actions on entity records. For a list of default relationships for this entity, see the SystemForm entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
InitializeFromRequest	Initializes a new record from an existing record provided that an attribute map is defined for the two entities. For more information, see Customize entity and attribute mappings.
RetrieveDuplicatesRequest	Detects and retrieves duplicate records for the specified record provided that duplicate detection is enabled and there are published duplicate detection rules for the entity. For more information, see Detect duplicate data.
RetrieveRequest	Retrieves a system form. You can also call the IOrganizationService.Retrieve method.
RetrieveFilteredFormsRequest	Retrieves the system forms for the specified user.
RetrieveLocLabelsRequest	Retrieves localized labels for SystemForm.Name and SystemForm.Description attributes.
RetrieveMultipleRequest	Retrieves a collection of organization-owned dashboards. You can also call the IOrganizationService.RetrieveMultiple method.
RetrieveUnpublishedRequest	Retrieves an unpublished organization-owned dashboard.
RetrieveUnpublishedMultipleRequest	Retrieves a collection of unpublished organization-owned dashboards.
SetLocLabelsRequest	Sets localized labels for SystemForm.Name and SystemForm.Description attributes.
UpdateRequest	Updates a system form. You can also call the IOrganizationService.Update method.

See Also

Dashboard entities
UserForm (user dashboard) entity messages and methods
Customize entity forms
Privileges by entity

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright