report EntityType
Data summary in an easy-to-read layout.
- Entity set path:
- [organization URI]/api/data/v9.2/reports
- Base type:
- crmbaseentity
- Table type:
- Standard
- Display name:
- Report
- Primary key:
- reportid
- Primary name column:
- name
- Operations supported:
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| applicationid | Edm.String |
Represents the application id to which a CDS powerbi report belongs to. Display name: ApplicationId Read only
|
||||||||||||||||
| bodybinary | Edm.String |
Binary report contents (base-64 encoded). Display name: Body Binary |
||||||||||||||||
| bodybinary_binary | Edm.Binary |
Binary report contents (base-64 encoded). |
||||||||||||||||
| bodytext | Edm.String |
Text contents of the RDL file for a Reporting Services report. Display name: Body Text |
||||||||||||||||
| bodyurl | Edm.String |
URL for a linked report. Display name: Linked Report URL |
||||||||||||||||
| cdsdatasetid | Edm.String |
Represents the dataset id of a report. Display name: cdsdatasetid Read only
|
||||||||||||||||
| componentstate | Edm.Int32 |
For internal use only. Display name: Component State Read only
Default options
|
||||||||||||||||
| createdinmajorversion | Edm.Int32 |
Major version number of Crm, used to identify the version of Crm in which report is created. Display name: Crm Version in which the Report is created |
||||||||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the report was created. Display name: Created On Read only
|
||||||||||||||||
| customreportxml | Edm.String |
XML used to define a custom report. Display name: Custom Report XML Read only
|
||||||||||||||||
| defaultfilter | Edm.String |
Default filter for the report. Display name: Default filter |
||||||||||||||||
| description | Edm.String |
Description of the report. Display name: Description |
||||||||||||||||
| filecontent | Edm.Binary |
Display name: File Content Read only
|
||||||||||||||||
| filecontent_name | Edm.String |
Read only
|
||||||||||||||||
| filename | Edm.String |
File name of the report. Display name: File Name |
||||||||||||||||
| filesize | Edm.Int32 |
File size of the report. Display name: File Size (Bytes) Read only
|
||||||||||||||||
| introducedversion | Edm.String |
Version in which the report is introduced. Display name: Introduced Version |
||||||||||||||||
| iscustomizable | BooleanManagedProperty |
Information that specifies whether this component can be customized. Display name: Customizable |
||||||||||||||||
| iscustomreport | Edm.Boolean |
Information about whether the report is a custom report. Display name: Is Custom Report Read only
Default options
|
||||||||||||||||
| ismanaged | Edm.Boolean |
Indicates whether the solution component is part of a managed solution. Display name: Is Managed Read only
Default options
|
||||||||||||||||
| ispersonal | Edm.Boolean |
Information about whether the report is personal or is available to all users. Display name: Viewable By
Default options
|
||||||||||||||||
| isscheduledreport | Edm.Boolean |
Information about whether the report is a scheduled report. Display name: Is Scheduled Report Read only
Default options
|
||||||||||||||||
| languagecode | Edm.Int32 |
Language in which the report will be displayed. Display name: Language |
||||||||||||||||
| managedtype | Edm.Int32 |
Determine how the report workspace is managed. Display name: ManagedType
Default options
|
||||||||||||||||
| mimetype | Edm.String |
MIME type of the report. Display name: Mime Type |
||||||||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the report was last modified. Display name: Modified On Read only
|
||||||||||||||||
| name | Edm.String |
Name of the report. Display name: Name |
||||||||||||||||
| originalbodytext | Edm.String |
Original Text contents of the RDL file for a Reporting Services report. Display name: Body Text Read only
|
||||||||||||||||
| overwritetime | Edm.DateTimeOffset |
For internal use only. Display name: Record Overwrite Time Read only
|
||||||||||||||||
| powerbidatasetid | Edm.String |
Represents the Power BI dataset id of a report. Display name: PowerBI Dataset Id Read only
|
||||||||||||||||
| powerbifeaturetag | Edm.String |
Field to maintain the sub application id and feature tag for powerbi reports. Display name: powerbifeaturetag |
||||||||||||||||
| powerbireportid | Edm.String |
Represents the powerbi report id for a CDS report. Display name: PowerBiReportId Read only
|
||||||||||||||||
| powerbireportinternalstate | Edm.String |
Field to maintain the internal state of the report Display name: powerbireportinternalstate Read only
|
||||||||||||||||
| powerbireportname | Edm.String |
Contains the name of the Power Bi embedded report. Display name: Power Bi Report Name Read only
|
||||||||||||||||
| powerbiworkspaceinfo | Edm.String |
Contains the workspace information of the Power Bi embedded report. Display name: Power Bi Workspace Information Read only
|
||||||||||||||||
| queryinfo | Edm.String |
For internal use only. Display name: Query Info Structure Read only
|
||||||||||||||||
| rdlhash | Edm.Int32 |
Hash value of the body text of the report. Display name: Body Text Hash Read only
|
||||||||||||||||
| reportid | Edm.Guid |
Unique identifier of the report. Display name: Report |
||||||||||||||||
| reportidunique | Edm.Guid |
For internal use only. Display name: Report Read only
|
||||||||||||||||
| reportnameonsrs | Edm.String |
Name of the report on SRS. Display name: Name on SRS Read only
|
||||||||||||||||
| reportstatus | Edm.String |
Represents the status of the Report. Display name: Report Status |
||||||||||||||||
| reporttypecode | Edm.Int32 |
Type of the report. Display name: Report Type
Default options
|
||||||||||||||||
| reportversion | Edm.Int32 |
Represents the version of a report. Display name: Report Version |
||||||||||||||||
| schedulexml | Edm.String |
XML used for defining the report schedule. Display name: Schedule Definition XML Read only
|
||||||||||||||||
| signaturedate | Edm.DateTimeOffset |
Report signature date, used to identify a report for upgrades and hotfixes. Display name: Report Signature Date |
||||||||||||||||
| signatureid | Edm.Guid |
Unique identifier of the report signature used to identify a report for upgrades and hotfixes. Display name: Signature |
||||||||||||||||
| signaturelcid | Edm.Int32 |
Report signature language code used to identify a report for upgrades and hotfixes. Display name: Signature Language Code |
||||||||||||||||
| signaturemajorversion | Edm.Int32 |
Report signature major version, used to identify a report for upgrades and hotfixes. Display name: Report Signature Major Version |
||||||||||||||||
| signatureminorversion | Edm.Int32 |
Report signature minor version, used to identify a report for upgrades and hotfixes. Display name: Report Signature Minor Version |
||||||||||||||||
| solutionid | Edm.Guid |
Unique identifier of the associated solution. Display name: Solution Read only
|
||||||||||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display name: Time Zone Rule Version Number |
||||||||||||||||
| utcconversiontimezonecode | Edm.Int32 |
Time zone code that was in use when the record was created. Display name: UTC Conversion Time Zone Code |
||||||||||||||||
| versionnumber | Edm.Int64 |
Version number of the report. Display name: Version Number Read only
|
Lookup properties
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _createdby_value | createdby |
Unique identifier of the user who created the report. |
| _createdonbehalfby_value | createdonbehalfby |
Unique identifier of the delegate user who created the report. |
| _dependentmodelreportid_value | DependentModelReportId |
Field to represent the dependent report dataset model. |
| _modifiedby_value | modifiedby |
Unique identifier of the user who last modified the report. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Unique identifier of the delegate user who last modified the report. |
| _ownerid_value | ownerid |
Unique identifier of the user or team who owns the report. |
| _owningbusinessunit_value | owningbusinessunit |
Unique identifier of the business unit that owns the report. |
| _parentreportid_value | parentreportid |
Unique identifier of the parent report. |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
| Name | Type | Partner |
|---|---|---|
| createdby | systemuser | lk_reportbase_createdby |
| createdonbehalfby | systemuser | lk_report_createdonbehalfby |
| DependentModelReportId | report | Report_Report_DependentModelReportId |
| modifiedby | systemuser | lk_reportbase_modifiedby |
| modifiedonbehalfby | systemuser | lk_report_modifiedonbehalfby |
| ownerid | principal | owner_reports |
| owningbusinessunit | businessunit | business_unit_reports |
| parentreportid | report | report_parent_report |
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
| Name | Type | Partner |
|---|---|---|
| Report_AsyncOperations | asyncoperation | regardingobjectid_report |
| report_FileAttachments | fileattachment | objectid_report |
| report_parent_report | report | parentreportid |
| Report_ProcessSessions | processsession | regardingobjectid_report |
| Report_Report_DependentModelReportId | report | DependentModelReportId |
| report_reportcategories | reportcategory | reportid |
| Report_ReportParameters | reportparameter | Report_ReportParameters |
| Report_SyncErrors | syncerror | regardingobjectid_report_syncerror |
Operations
The following operations can be used with the report entity type.
| Name | Binding |
|---|---|
| DownloadReportDefinition | Bound to Entity |
| GetReportHistoryLimit | Bound to Entity |
| GrantAccess | Not Bound |
| ModifyAccess | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |
| SetReportRelated | Not Bound |