savedquery EntityType
Saved query against the database.
- Entity set path:
- [organization URI]/api/data/v9.2/savedqueries
- Base type:
- crmbaseentity
- Display name:
- View
- Primary key:
- savedqueryid
- 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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| advancedgroupby | Edm.String | 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 | Tells whether the view can be deleted. Display name: Can Be Deleted | ||||||||||
| columnsetxml | Edm.String | Contains the columns and sorting criteria for the view, stored in XML format. Display name: Column Set XML | ||||||||||
| componentstate | Edm.Int32 | For internal use only. Display name: Component State Read only 
								Default options
								 
 | ||||||||||
| conditionalformatting | Edm.String | Type information about how the items in the system view are formatted. Display name: Conditional formatting | ||||||||||
| createdon | Edm.DateTimeOffset | 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 | ||||||||||
| description | Edm.String | Type additional information to describe the view, such as the filter criteria or intended results set. Display name: Description | ||||||||||
| enablecrosspartition | Edm.Boolean | Tells whether the view can retrieve data from all cluster partitions. Display name: Default 
								Default options
								 
 | ||||||||||
| fetchxml | Edm.String | String specifying the query in Fetch XML language. Display name: Fetch XML | ||||||||||
| introducedversion | Edm.String | Version in which the form is introduced. Display name: Introduced Version | ||||||||||
| iscustom | Edm.Boolean | Tells whether a user created the view. Display name: Is Custom Read only 
								Default options
								 
 | ||||||||||
| iscustomizable | BooleanManagedProperty | Tells whether the component can be customized. Display name: Customizable | ||||||||||
| isdefault | Edm.Boolean | Tells whether the view is the default view for the specified record type (entity). Display name: Default 
								Default options
								 
 | ||||||||||
| ismanaged | Edm.Boolean | Tells whether the record is part of a managed solution. Display name: State Read only 
								Default options
								 
 | ||||||||||
| isquickfindquery | Edm.Boolean | Choose whether the view is compatible with Quick Find. When users search for specific items, you define the fields that are searched in. Display name: Quick Find Compatible 
								Default options
								 
 | ||||||||||
| isuserdefined | Edm.Boolean | Tells whether the view was created by a user. Display name: User Defined Read only 
								Default options
								 
 | ||||||||||
| layoutjson | Edm.String | Layout data in JSON format. Display name: Layout data in JSON format. | ||||||||||
| layoutxml | Edm.String | For internal use only. Display name: Layout XML | ||||||||||
| modifiedon | Edm.DateTimeOffset | 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 | ||||||||||
| name | Edm.String | 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 | ||||||||||
| offlinesqlquery | Edm.String | String specifying the corresponding sql query for the fetch xml specified for offline use. Display name: Offline SQL Query | ||||||||||
| organizationtaborder | Edm.Int32 | 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 | ||||||||||
| overwritetime | Edm.DateTimeOffset | For internal use only. Display name: Record Overwrite Time Read only | ||||||||||
| queryapi | Edm.String | For internal use only. Display name: Query API Read only | ||||||||||
| queryappusage | Edm.Int32 | For internal use only. Display name: Query Application Usage | ||||||||||
| querytype | Edm.Int32 | Shows the type of the query. Display name: Query Type | ||||||||||
| returnedtypecode | Edm.String | Type of entity displayed in the view. Display name: Entity Name | ||||||||||
| roledisplayconditionsxml | Edm.String | Contains the role display conditions for the SavedQuery. Display name: Role display conditions for the SavedQuery | ||||||||||
| savedqueryid | Edm.Guid | Unique identifier of the view. Display name: View | ||||||||||
| savedqueryidunique | Edm.Guid | For internal use only. Read only | ||||||||||
| solutionid | Edm.Guid | Unique identifier of the associated solution. Display name: Solution Read only | ||||||||||
| statecode | Edm.Int32 | Shows the status of the view. Display name: Status 
								Default options
								 
 | ||||||||||
| statuscode | Edm.Int32 | Shows the reason code that explains the status of the record. Display name: Status Reason 
								Default options
								 
 | ||||||||||
| versionnumber | Edm.Int64 | Version number of the view. 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 | 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
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_savedquerybase_createdby | 
| createdonbehalfby | systemuser | lk_savedquery_createdonbehalfby | 
| modifiedby | systemuser | lk_savedquerybase_modifiedby | 
| modifiedonbehalfby | systemuser | lk_savedquery_modifiedonbehalfby | 
| organizationid | organization | organization_saved_queries | 
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 | 
|---|---|---|
| lk_mobileofflineprofileitem_savedquery | mobileofflineprofileitem | profileitemrule | 
| SavedQuery_AsyncOperations | asyncoperation | regardingobjectid_savedquery | 
| SavedQuery_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_savedquery | 
| SavedQuery_SyncErrors | syncerror | regardingobjectid_savedquery_syncerror | 
Operations
The following operations can be used with the savedquery entity type.
| Name | Binding | 
|---|---|
| InstantiateFilters | Not Bound | 
| RetrieveUnpublished | Bound to Entity | 
| RetrieveUnpublishedMultiple | Bound to Collection | 
| Validate | Not Bound | 
| ValidateSavedQuery | Bound to Collection | 
| ValidateUnpublished | Not Bound |