Element.getList (Method)

Returns one or more structures, each containing information about each element type; for example, 'Name', 'Description'.'CategoryName', 'CategoryID', and so on.

Returns:

Element_GetList_Result (query)

Each row of the returned query results has the following fields:

Field Name	Type	Description
canAddPriDisplayTemplates	Boolean	Boolean flag which when set to true indicates that the user can create private display templates for this element.
canAddPubDisplayTemplates	Boolean	Boolean flag which when set to true indicates that the user can create public display templates for this element.
canAdmin	Boolean	Boolean flag which when set to true indicates that the current user can administer this element's field definitions.
canEdit	Boolean	Boolean flag which when set to true indicates that the current user can edit this element.
CategoryID	CategoryID_0	The element category's ID. If this value is 0, this element does not have a category.
CategoryName	PlainText	The category's name. If this element does not have a category, this is set to an empty string.
DefaultLayoutID	ID_0	The ID of the default layout option or 0 if none.
DefaultLayoutName	PlainText_255	The name of the default layout or an empry string.
DefaultLayoutType	LayoutType_EmptyString	The type of layout choosen as the default.
Description	PlainText	The element's description.
DisplayTemplateCount	NonNegativeInteger	The number of display templates associated with the element.
ElementFieldCount	Integer	The number of field definitions associated with the element.
ID	ElementTypeID	The element's type ID. For example 46 if a Simple Form element.
isLocked	Boolean	Boolean flag which when set to true indicates that the custom element is locked.
Name	PlainText_NonNull	The element's name.
OwnerID	ContributorIDGroupID_0	The owner's ID. If this value is 0, no owner for this object exists.
ParentElementTypeID	ElementTypeID_0	If this element is a saved element, this is the parent element's ID. If it is not a saved element, this value is 0.
ParentElementTypeName	PlainText_255	If a saved element, the name of the parent element type. Otherwise an empty string.
RenderHandlerCount	NonNegativeInteger	The number of render handlers associated with the element.
SavedLayoutCount	NonNegativeInteger	The number of saved layouts associated with the element.
State	ElementStatus	An elements state, which can be 'Active', 'Deleted', or 'Inactive'.
SupportsRenderHandlers	Boolean	Boolean flag which when set to true indicates that the element supports render handlers.
Type	ElementType	The element's type, which can be 'Global', 'Local', 'Standard' or 'Saved'.

Arguments:

Name	Type	Required	Description
idList	ElementTypeIDList_0	Optional. Defaults to '0'.	List of element's IDs. If this value is 0, CommonSpot returns all records instead of just given element IDs.
category	ElementCategoryFilter	Optional. Defaults to 'ALL'.	A string containing an element's category.
state	ElementStateFilter	Optional. Defaults to 'Active'.	The state of the element to filter by. Possible values are 'All', 'Active', 'Inactive', and 'Deleted'.
type	ElementTypeFilter	Optional. Defaults to 'All'.	The type of element to filter by, as follows: 'All', 'Standard', 'Custom', 'Local', or 'Global'.
searchString	PlainText_100	Optional. Defaults to an empty string.	If specified, the string for which CommonSpot will search against. The search will compare the element name and description fields.
searchOperator	SearchOperator_EmptyString	Optional. Defaults to an empty string.	The operator used to perform the search; for example, 'Contains', 'Begins with', 'Equals', and so on.

Context:

License Requirements	None
Permission Requirements	(none)
Deny Context	None
Require Context	None
Author Lock	(not required)
Transaction Logging	Transaction logging is disabled for this method
Customization	This method may be customized at the site level

Error Codes:

Code	Error Message
1000103	A valid search operator is required when specifying a search string.

Notes:

None