savedquery EntityType

Dynamics CRM 2016
 

Updated: November 29, 2016

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

Description: Saved query against the database.

Entity Set path:[organization URI]/api/data/v8.2/savedqueries

Base Type: crmbaseentity EntityType

Display Name: View

Primary Key: savedqueryid

Primary Name Attribute: name

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to savedquery

Operations using the savedquery entity type.

Properties represent fields of data stored in the entity. Some properties are read-only.

Name

Type

Details

advancedgroupby

Edm.String

Description: Type the column name that will be used to group the results from the data collected across multiple records from a system view.

Display Name: Advanced Group By

canbedeleted

BooleanManagedProperty ComplexType

Description: Tells whether the view can be deleted.

Display Name: Can Be Deleted

columnsetxml

Edm.String

Description: Contains the columns and sorting criteria for the view, stored in XML format.

Display Name: Column Set XML

componentstate

Edm.Int32

Description: For internal use only.

Default Options:

0 : Published
1 : Unpublished
2 : Deleted
3 : Deleted Unpublished

Display Name: Component State

Read-only property

conditionalformatting

Edm.String

Description: Type information about how the items in the system view are formatted.

Display Name: Conditional formatting

createdon

Edm.DateTimeOffset

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.

Display Name: Created On

Read-only property

description

Edm.String

Description: Type additional information to describe the view, such as the filter criteria or intended results set.

Display Name: Description

fetchxml

Edm.String

Description: String specifying the query in Fetch XML language.

Display Name: Fetch XML

introducedversion

Edm.String

Description: Version in which the form is introduced.

Display Name: Introduced Version

iscustom

Edm.Boolean

Description: Tells whether a user created the view.

Default Options:

1 : Yes
0 : No

Display Name: Is Custom

Read-only property

iscustomizable

BooleanManagedProperty ComplexType

Description: Tells whether the component can be customized.

Display Name: Customizable

isdefault

Edm.Boolean

Description: Tells whether the view is the default view for the specified record type (entity).

Default Options:

1 : Yes
0 : No

Display Name: Default

ismanaged

Edm.Boolean

Description: Tells whether the record is part of a managed solution.

Default Options:

1 : Managed
0 : Unmanaged

Display Name: State

Read-only property

isquickfindquery

Edm.Boolean

Description: Choose whether the view is compatible with Quick Find. When users search for specific items, you define the fields that are searched in.

Default Options:

1 : Yes
0 : No

Display Name: Quick Find Compatible

isuserdefined

Edm.Boolean

Description: Tells whether the view was created by a user.

Default Options:

1 : Yes
0 : No

Display Name: User Defined

Read-only property

layoutxml

Edm.String

Description: For internal use only.

Display Name: Layout XML

modifiedon

Edm.DateTimeOffset

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.

Display Name: Modified On

Read-only property

name

Edm.String

Description: Type a name for the view to describe what results the view will contain. This name is visible to users in the View list.

Display Name: Name

organizationtaborder

Edm.Int32

Description: For the organization, type the tab order to determine how users navigate through the screen using only the Tab key.

Display Name: Default Organization tab order

Read-only property

overwritetime

Edm.DateTimeOffset

Description: For internal use only.

Display Name: Record Overwrite Time

Read-only property

queryapi

Edm.String

Description: For internal use only.

Display Name: Query API

Read-only property

queryappusage

Edm.Int32

Description: For internal use only.

Display Name: Query Application Usage

querytype

Edm.Int32

Description: Shows the type of the query.

Display Name: Query Type

returnedtypecode

Edm.String

Description: Type of entity displayed in the view.

Display Name: Returned Type

savedqueryid

Edm.Guid

Description: Unique identifier of the view.

Display Name: View

savedqueryidunique

Edm.Guid

Description: For internal use only.

Read-only property

solutionid

Edm.Guid

Description: Unique identifier of the associated solution.

Display Name: Solution

Read-only property

statecode

Edm.Int32

Description: Shows the status of the view.

Default Options:

0 : Active
1 : Inactive

Display Name: Status

statuscode

Edm.Int32

Description: Shows the reason code that explains the status of the record.

Default Options:

1 : Active
2 : Inactive

Display Name: Status Reason

versionnumber

Edm.Int64

Description: Version number of the view.

Display Name: Version Number

Read-only property

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

Shows who created the record.

_createdonbehalfby_value

createdonbehalfby

Shows who created the record on behalf of another user.

_modifiedby_value

modifiedby

Shows who last updated the record.

_modifiedonbehalfby_value

modifiedonbehalfby

Shows who last updated the record on behalf of another user.

_organizationid_value

organizationid

Choose the ID of the organization that the record is associated with.

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 EntityType

lk_savedquerybase_createdby

createdonbehalfby

systemuser EntityType

lk_savedquery_createdonbehalfby

modifiedby

systemuser EntityType

lk_savedquerybase_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_savedquery_modifiedonbehalfby

organizationid

organization EntityType

organization_saved_queries

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

lk_mobileofflineprofileitem_savedquery

mobileofflineprofileitem EntityType

profileitemrule

SavedQuery_AsyncOperations

asyncoperation EntityType

regardingobjectid_savedquery

SavedQuery_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_savedquery

SavedQuery_SyncErrors

syncerror EntityType

regardingobjectid_savedquery_syncerror

The following operations are bound to the savedquery entity type.

Name

Bound to

ValidateSavedQuery Action

Collection

RetrieveUnpublishedMultiple Function

Collection

The following operations use the savedquery entity type in a parameter or return type.

Name

How used

Description

InstantiateFilters Action

TemplateCollection Parameter

Instantiates a set of filters for Dynamics 365 for Outlook for the specified user.

ValidateSavedQuery Action

entityset Parameter

Validates a saved query.

RetrieveUnpublishedMultiple Function

entityset Parameter

Retrieves a collection of unpublished organization-owned records that satisfy the specified query criteria.

RetrieveUnpublishedMultiple Function

ReturnType

Retrieves a collection of unpublished organization-owned records that satisfy the specified query criteria.

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: