report EntityType
Data summary in an easy-to-read layout.
- Entity Set Path
- [organization URI]/api/data/v9.0/reports
- Base Type
- crmbaseentity
- Display Name
- Report
- Primary Key
- reportid
- Primary Key Attribute
- 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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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 |
||||||||||
| 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 |
||||||||||
| 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 |
||||||||||
| 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
|
||||||||||
| 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
|
||||||||||
| reporttypecode | Edm.Int32 |
Type of the report. Display Name: Report Type
Default Options
|
||||||||||
| 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 Retrieve data about lookup properties.
| 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. |
| _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. |
| _owningteam_value | createdby |
Unique identifier of the team who owns the report. |
| _owninguser_value | createdby |
Unique identifier of the user who 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 |
| 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_parent_report | report | parentreportid |
| Report_ProcessSessions | processsession | regardingobjectid_report |
| report_reportcategories | reportcategory | reportid |
| Report_SyncErrors | syncerror | regardingobjectid_report_syncerror |
Operations
The following operations can be used with the report entity type.
| Name | Binding |
|---|---|
| DownloadReportDefinition | Entity |
| GetReportHistoryLimit | Entity |
| GrantAccess | Not Bound |
| ModifyAccess | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |
| SetReportRelated | Not Bound |
Solutions
The following solutions include the report entity type.
| Name | Description |
|---|---|
| System Solution | Internal CRM System Solution |