UserQuery Entity Reference

Saved database query that is owned by a user.

Messages

Message Web API Operation SDK Assembly
Assign PATCH [org URI]/api/data/v9.0/userqueries(userqueryid)
Update ownerid property.
AssignRequest
Create POST [org URI]/api/data/v9.0/userqueries
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/userqueries(userqueryid)
See Delete
DeleteRequest or
Delete
ExecuteByIdUserQuery Retrieve and execute predefined queries ExecuteByIdUserQueryRequest
GrantAccess GrantAccess Action GrantAccessRequest
ModifyAccess ModifyAccess Action ModifyAccessRequest
Retrieve GET [org URI]/api/data/v9.0/userqueries(userqueryid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/userqueries
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess Function RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess Function RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess Action RevokeAccessRequest
SetState PATCH [org URI]/api/data/v9.0/userqueries(userqueryid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/userqueries(userqueryid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName UserQueries
DisplayCollectionName Saved Views
DisplayName Saved View
EntitySetName userqueries
IsBPFEntity False
LogicalCollectionName userqueries
LogicalName userquery
OwnershipType UserOwned
PrimaryIdAttribute userqueryid
PrimaryNameAttribute name
SchemaName UserQuery

Writable attributes

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

AdvancedGroupBy

Property Value
Description Type the column name that will be used to group the results from the data collected across multiple records from a user view.
DisplayName Advanced Group By
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName advancedgroupby
MaxLength 20
RequiredLevel None
Type String

ColumnSetXml

Property Value
Description Shows the columns and sorting criteria for the saved view, stored in XML format.
DisplayName Column Set XML
Format TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName columnsetxml
MaxLength 1073741823
RequiredLevel None
Type Memo

ConditionalFormatting

Property Value
Description Type information about how the items in the user view are formatted.
DisplayName User Group By
Format TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName conditionalformatting
MaxLength 1073741823
RequiredLevel None
Type Memo

Description

Property Value
Description Type additional information to describe the saved view, such as the filter criteria or intended results set.
DisplayName Description
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 2000
RequiredLevel None
Type Memo

FetchXml

Property Value
Description Contains the Fetch XML query that defines the entities and attributes included in the saved view.
DisplayName Fetch XML
Format TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName fetchxml
MaxLength 1073741823
RequiredLevel SystemRequired
Type Memo

LayoutJson

Property Value
Description Layout data in JSON format.
DisplayName Layout data in JSON format.
Format TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName layoutjson
MaxLength 1073741823
RequiredLevel None
Type Memo

LayoutXml

Property Value
Description For internal use only.
DisplayName Layout XML
Format TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName layoutxml
MaxLength 1073741823
RequiredLevel None
Type Memo

Name

Property Value
Description Type a descriptive name for the saved view.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 200
RequiredLevel SystemRequired
Type String

OfflineSqlQuery

Property Value
Description String specifying the corresponding sql query for the fetch xml specified for offline use.
DisplayName Offline SQL Query
Format TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName offlinesqlquery
MaxLength 1073741823
RequiredLevel None
Type Memo

OwnerId

Property Value
Description Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user.
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Property Value
Description Type of the owner of the saved view, such as user, team, or business unit.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

ParentQueryId

Property Value
Description Choose the ID of the saved query that the record was created from.
DisplayName Parent Query
IsValidForForm True
IsValidForRead True
LogicalName parentqueryid
RequiredLevel None
Targets
Type Lookup

QueryType

Property Value
Description Shows the code for the query type to indicate whether the saved view is an address book filter, advanced search, or other view.
DisplayName Query Type
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName querytype
MaxValue 1000000000
MinValue 0
RequiredLevel SystemRequired
Type Integer

ReturnedTypeCode

Property Value
Description Type of entity that the saved view displays.
DisplayName Returned Type
IsValidForForm False
IsValidForRead True
LogicalName returnedtypecode
RequiredLevel SystemRequired
Type EntityName

StateCode

Property Value
Description Shows whether the saved view is active or inactive.
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

StateCode Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 Inactive

StatusCode

Property Value
Description Select the item's status.
DisplayName Status Reason
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

StatusCode Options

Value Label State
1 Active 0
2 Inactive 1
3 All 0

UserQueryId

Property Value
Description Unique identifier of the saved view.
DisplayName User Query
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName userqueryid
RequiredLevel SystemRequired
Type Uniqueidentifier

Read-only attributes

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

CreatedBy

Property Value
Description Shows who created the record.
DisplayName Created By
IsValidForForm False
IsValidForRead True
LogicalName createdby
RequiredLevel SystemRequired
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description Name of the user who created the saved view.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description YomiName of the user who created the saved view.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel None
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.
DisplayName Created On
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName createdon
RequiredLevel SystemRequired
Type DateTime

CreatedOnBehalfBy

Property Value
Description Shows who created the record on behalf of another user.
DisplayName Created By (Delegate)
IsValidForForm False
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

ModifiedBy

Property Value
Description Shows who last updated the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel SystemRequired
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description Name of the user who last modified the saved view.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description YomiName of the user who last modified the saved view.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel None
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.
DisplayName Last Modified
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel SystemRequired
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Shows who last updated the record on behalf of another user.
DisplayName Modified By (Delegate)
IsValidForForm False
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

OwnerIdName

Property Value
Description Name of the owner of the saved view.
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 Shows the business unit that the record owner belongs to.
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 this saved view.
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 this saved view.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

VersionNumber

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

One-To-Many Relationships

Listed by SchemaName.

UserQuery_BulkDeleteFailures

Same as bulkdeletefailure entity UserQuery_BulkDeleteFailures Many-To-One relationship.

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

UserQuery_SyncErrors

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

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

UserQuery_AsyncOperations

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

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

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_userquery_modifiedonbehalfby

See systemuser Entity lk_userquery_modifiedonbehalfby One-To-Many relationship.

business_unit_userquery

See businessunit Entity business_unit_userquery One-To-Many relationship.

user_userquery

See systemuser Entity user_userquery One-To-Many relationship.

team_userquery

See team Entity team_userquery One-To-Many relationship.

lk_userquery_modifiedby

See systemuser Entity lk_userquery_modifiedby One-To-Many relationship.

lk_userquery_createdby

See systemuser Entity lk_userquery_createdby One-To-Many relationship.

lk_userquery_createdonbehalfby

See systemuser Entity lk_userquery_createdonbehalfby One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
userquery EntityType