Report entity reference

Note

Effective Nov 2020, Common Data Service has been renamed to Microsoft Dataverse.

Data summary in an easy-to-read layout.

Messages

Message Web API Operation SDK Assembly
Assign PATCH [org URI]/api/data/v9.0/reports(reportid)
Update ownerid property.
AssignRequest
Create POST [org URI]/api/data/v9.0/reports
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/reports(reportid)
See Delete
DeleteRequest or
Delete
DownloadReportDefinition DownloadReportDefinition Function DownloadReportDefinitionRequest
GetReportHistoryLimit GetReportHistoryLimit Function GetReportHistoryLimitRequest
GrantAccess GrantAccess Action GrantAccessRequest
ModifyAccess ModifyAccess Action ModifyAccessRequest
Retrieve GET [org URI]/api/data/v9.0/reports(reportid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/reports
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess Function RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess Function RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess Action RevokeAccessRequest
SetReportRelated SetReportRelated Action SetReportRelatedRequest
Update PATCH [org URI]/api/data/v9.0/reports(reportid)
See Update
UpdateRequest or
Update

Entity properties

Property Value
CollectionSchemaName Reports
DisplayCollectionName Reports
DisplayName Report
EntitySetName reports
IsBPFEntity False
LogicalCollectionName reports
LogicalName report
OwnershipType UserOwned
PrimaryIdAttribute reportid
PrimaryNameAttribute name
SchemaName Report

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

BodyBinary

Property Value
Description Binary report contents (base-64 encoded).
DisplayName Body Binary
FormatName TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName bodybinary
MaxLength 1073741823
RequiredLevel None
Type String

BodyText

Property Value
Description Text contents of the RDL file for a Reporting Services report.
DisplayName Body Text
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName bodytext
MaxLength 1073741823
RequiredLevel None
Type String

BodyUrl

Property Value
Description URL for a linked report.
DisplayName Linked Report URL
FormatName Url
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName bodyurl
MaxLength 200
RequiredLevel None
Type String

CreatedInMajorVersion

Property Value
Description Major version number of Crm, used to identify the version of Crm in which report is created.
DisplayName Crm Version in which the Report is created
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName createdinmajorversion
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

DefaultFilter

Property Value
Description Default filter for the report.
DisplayName Default filter
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName defaultfilter
MaxLength 1073741823
RequiredLevel None
Type String

Description

Property Value
Description Description of the report.
DisplayName Description
FormatName TextArea
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 256
RequiredLevel None
Type String

FileName

Property Value
Description File name of the report.
DisplayName File Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName filename
MaxLength 255
RequiredLevel None
Type String

IntroducedVersion

Property Value
Description Version in which the report is introduced.
DisplayName Introduced Version
FormatName VersionNumber
IsLocalizable False
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName introducedversion
MaxLength 48
RequiredLevel None
Type String

IsCustomizable

Property Value
Description Information that specifies whether this component can be customized.
DisplayName Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

IsPersonal

Property Value
Description Information about whether the report is personal or is available to all users.
DisplayName Viewable By
IsValidForForm False
IsValidForRead True
LogicalName ispersonal
RequiredLevel SystemRequired
Type Boolean

IsPersonal Options

Value Label
1 Individual
0 Organization

DefaultValue: True

LanguageCode

Property Value
Description Language in which the report will be displayed.
DisplayName Language
Format Language
IsValidForForm True
IsValidForRead True
LogicalName languagecode
MaxValue 2147483647
MinValue 0
RequiredLevel ApplicationRequired
Type Integer

MimeType

Property Value
Description MIME type of the report.
DisplayName Mime Type
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName mimetype
MaxLength 256
RequiredLevel None
Type String

Name

Property Value
Description Name of the report.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName name
MaxLength 425
RequiredLevel SystemRequired
Type String

OwnerId

Property Value
Description Unique identifier of the user or team who owns the report.
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

ParentReportId

Property Value
Description Unique identifier of the parent report.
DisplayName Parent Report
IsValidForForm True
IsValidForRead True
LogicalName parentreportid
RequiredLevel None
Targets report
Type Lookup

ReportId

Property Value
Description Unique identifier of the report.
DisplayName Report
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName reportid
RequiredLevel SystemRequired
Type Uniqueidentifier

ReportTypeCode

Property Value
Description Type of the report.
DisplayName Report Type
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName reporttypecode
RequiredLevel ApplicationRequired
Type Picklist

ReportTypeCode Options

Value Label
1 Reporting Services Report
2 Other Report
3 Linked Report

SignatureDate

Property Value
DateTimeBehavior UserLocal
Description Report signature date, used to identify a report for upgrades and hotfixes.
DisplayName Report Signature Date
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName signaturedate
RequiredLevel None
Type DateTime

SignatureId

Property Value
Description Unique identifier of the report signature used to identify a report for upgrades and hotfixes.
DisplayName Signature
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName signatureid
RequiredLevel None
Type Uniqueidentifier

SignatureLcid

Property Value
Description Report signature language code used to identify a report for upgrades and hotfixes.
DisplayName Signature Language Code
Format Language
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName signaturelcid
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

SignatureMajorVersion

Property Value
Description Report signature major version, used to identify a report for upgrades and hotfixes.
DisplayName Report Signature Major Version
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName signaturemajorversion
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

SignatureMinorVersion

Property Value
Description Report signature minor version, used to identify a report for upgrades and hotfixes.
DisplayName Report Signature Minor Version
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName signatureminorversion
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

ComponentState

Property Value
Description For internal use only.
DisplayName Component State
IsValidForForm False
IsValidForRead True
LogicalName componentstate
RequiredLevel SystemRequired
Type Picklist

ComponentState Options

Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

CreatedBy

Property Value
Description Unique identifier of the user who created the report.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel None
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the report was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the report.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

CustomReportXml

Property Value
Description XML used to define a custom report.
DisplayName Custom Report XML
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName customreportxml
MaxLength 1073741823
RequiredLevel None
Type String

FileSize

Property Value
Description File size of the report.
DisplayName File Size (Bytes)
Format None
IsValidForForm False
IsValidForRead True
LogicalName filesize
MaxValue 1000000000
MinValue 0
RequiredLevel None
Type Integer

IsCustomReport

Property Value
Description Information about whether the report is a custom report.
DisplayName Is Custom Report
IsValidForForm False
IsValidForRead True
LogicalName iscustomreport
RequiredLevel SystemRequired
Type Boolean

IsCustomReport Options

Value Label
1 True
0 False

DefaultValue: False

IsManaged

Property Value
Description Indicates whether the solution component is part of a managed solution.
DisplayName Is Managed
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel SystemRequired
Type Boolean

IsManaged Options

Value Label
1 Managed
0 Unmanaged

DefaultValue: False

IsScheduledReport

Property Value
Description Information about whether the report is a scheduled report.
DisplayName Is Scheduled Report
IsValidForForm False
IsValidForRead True
LogicalName isscheduledreport
RequiredLevel SystemRequired
Type Boolean

IsScheduledReport Options

Value Label
1 True
0 False

DefaultValue: False

ModifiedBy

Property Value
Description Unique identifier of the user who last modified the report.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel None
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the report was last modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who last modified the report.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

OriginalBodyText

Property Value
Description Original Text contents of the RDL file for a Reporting Services report.
DisplayName Body Text
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName originalbodytext
MaxLength 1073741823
RequiredLevel None
Type String

OverwriteTime

Property Value
DateTimeBehavior UserLocal
Description For internal use only.
DisplayName Record Overwrite Time
Format DateOnly
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime

OwnerIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwnerIdYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningBusinessUnit

Property Value
Description Unique identifier of the business unit that owns the report.
DisplayName Owning Business Unit
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningTeam

Property Value
Description Unique identifier of the team who owns the report.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Property Value
Description Unique identifier of the user who owns the report.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

ParentReportIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName parentreportidname
MaxLength 100
RequiredLevel None
Type String

QueryInfo

Property Value
Description For internal use only.
DisplayName Query Info Structure
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName queryinfo
MaxLength 1073741823
RequiredLevel None
Type String

RdlHash

Property Value
Description Hash value of the body text of the report.
DisplayName Body Text Hash
Format None
IsValidForForm False
IsValidForRead True
LogicalName rdlhash
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

ReportIdUnique

Property Value
Description For internal use only.
DisplayName Report
IsValidForForm False
IsValidForRead True
LogicalName reportidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

ReportNameOnSRS

Property Value
Description Name of the report on SRS.
DisplayName Name on SRS
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName reportnameonsrs
MaxLength 425
RequiredLevel None
Type String

ScheduleXml

Property Value
Description XML used for defining the report schedule.
DisplayName Schedule Definition XML
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName schedulexml
MaxLength 1073741823
RequiredLevel None
Type String

SolutionId

Property Value
Description Unique identifier of the associated solution.
DisplayName Solution
IsValidForForm False
IsValidForRead True
LogicalName solutionid
RequiredLevel SystemRequired
Type Uniqueidentifier

SupportingSolutionId

Property Value
Description For internal use only.
DisplayName Solution
IsValidForForm False
IsValidForRead False
LogicalName supportingsolutionid
RequiredLevel None
Type Uniqueidentifier

VersionNumber

Property Value
Description Version number of the report.
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

Report_ProcessSessions

Same as processsession entity Report_ProcessSessions Many-To-One relationship.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Report_ProcessSessions
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 110
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Report_SyncErrors

Same as syncerror entity Report_SyncErrors Many-To-One relationship.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Report_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Report_AsyncOperations

Same as asyncoperation entity Report_AsyncOperations Many-To-One relationship.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Report_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

report_reportcategories

Same as reportcategory entity report_reportcategories Many-To-One relationship.

Property Value
ReferencingEntity reportcategory
ReferencingAttribute reportid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName report_reportcategories
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

report_parent_report

Same as report entity report_parent_report Many-To-One relationship.

Property Value
ReferencingEntity report
ReferencingAttribute parentreportid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName report_parent_report
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: RemoveLink
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_report_createdonbehalfby

See systemuser Entity lk_report_createdonbehalfby One-To-Many relationship.

lk_report_modifiedonbehalfby

See systemuser Entity lk_report_modifiedonbehalfby One-To-Many relationship.

report_parent_report

See report Entity report_parent_report One-To-Many relationship.

lk_reportbase_modifiedby

See systemuser Entity lk_reportbase_modifiedby One-To-Many relationship.

business_unit_reports

See businessunit Entity business_unit_reports One-To-Many relationship.

lk_reportbase_createdby

See systemuser Entity lk_reportbase_createdby One-To-Many relationship.

See also

About entity reference
Web API reference
report EntityType

Note

Can you tell us about your documentation language preferences? Take a short survey.

The survey will take about seven minutes. No personal data is collected (privacy statement).