The entityview object is used within the entityview tag, and provides access to the metadata for the view, as well as view result records.

Attributes

columns

Returns the columns in the view, as entity view column objects.

entity_permission_denied

Returns true if access to view results was denied due to insufficient Entity Permissions for the current user. Returns false if read access to view results was granted.

entity_logical_name

The CRM entity logical name of the view result records.

e.g. contact

first_page

The page number of the first page of view results. This will be 1 unless there were no results returned, in which case it will be null.

id

The GUID ID of the CRM view that defines this entityview.

language_code

The CRM integer language code being used to load localized labels for the current view.

last_page

The page number of the last page of view results. If there were no results returned, this will be null.

name

The name of the CRM view that defines this entityview.

e.g. Active Contacts

next_page

The page number of the next page of view results. If there is no next page of results, this will be null.

page

The page number of the current page of view results.

pages

Returns an array of page numbers containing all pages of results for the current view.

page_size

The number of results returned per page for the current view.

previous_page

The page number of the next page of view results. If there is no previous page of results, this will be null.

primary_key_logical_name

The CRM logical name of the primary key attribute of the result entity for this view.

e.g. contactid

records

The current page of result records for the view, as entity objects.

sort_expression

The default sort expression for the view.

e.g. name ASC, createdon DESC

total_pages

The total number of result pages for the view.

total_records

The total number of results for the view (across all pages).