Share via


Report entity messages and methods

 

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

A report is a data summary in an easy-to-read layout.The schema name for this entity is Report. 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

AssignRequest

Assigns a report to another user or team.

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 Report entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.

CreateRequest

Creates a report. You can also call the IOrganizationService.Create method.

DeleteRequest

Deletes a report. 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 Report entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.

DownloadReportDefinitionRequest

Returns the report definition associated with the report.

Pass the ID of a report in the ReportId property of this request. The report definition is returned in the BodyText property of the message response.

GetReportHistoryLimitRequest

Retrieves an integer value that represents the number of report history snapshots that a given report is permitted to have.

The default number of the report history snapshots is 8. If -1 is returned, the report can have an unlimited number of report history snapshots.

GrantAccessRequest

Shares a report with another security principal (user or team).

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.

MakeAvailableToOrganizationReportRequest

Deprecated. Use the UpdateRequest class. Changes the ownership of the report to organization-owned.

Pass the ID of a report in the ReportId property of this request.

MakeUnavailableToOrganizationReportRequest

Deprecated. Use the UpdateRequest class. Changes the ownership of the report to user-owned.

Pass the ID of a report in the ReportId property of this request.

ModifyAccessRequest

Changes the access rights for a report previously shared with another security principal (user or team).

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 report. You can also call the IOrganizationService.Retrieve method.

RetrieveMultipleRequest

Retrieves a collection of reports. You can also call the IOrganizationService.RetrieveMultiple method.

RetrievePrincipalAccessRequest

Retrieves the access the specified security principal (user or team) has to a report.

RetrieveSharedPrincipalsAndAccessRequest

Retrieves the security principals (users or teams) that have access to a report, and also retrieves their access rights to the report.

RevokeAccessRequest

Removes all access to a report for the specified security principal (user or team).

SetReportRelatedRequest

Specifies the areas of Microsoft Dynamics 365 where the report can be run and viewed.

UpdateRequest

Updates a report. You can also call the IOrganizationService.Update method.

See Also

Report entities
Privileges by entity
ReportCategory (report related category) entity messages and methods

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright