CustomElement.getList (Method)
Returns a structure containing information about a custom element; for example, 'Owner', 'CategoryName', 'Description', 'Type', and so on.
Returns:
CustomElement_GetList_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| Owner | Person_LastNameFirstNameMiddleName | The custom element's owner. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| id | CustomElementID_0 | Optional. Defaults to '0'. | A custom element's ID or 0. If this argument's value is 0, CommonSpot returns information on all objects instead of just one. |
| category | ElementCategoryFilter | Optional. Defaults to 'ALL'. | An element's category name. |
| state | ElementStateFilter | Optional. Defaults to 'Active'. | A custom element's state, which can be 'Active', 'All', 'Deleted', and 'Inactive'. |
| type | CustomElementTypeFilter | Optional. Defaults to 'All'. | A custom element's type, which can be 'All', 'Global', or 'Local'. |
| securityPermissionFilter | CustomElementPermissionList_EmptyString | Optional. Defaults to an empty string. | A comma-delimited list of element permissions. Elements in this list are values such as 'AddData', 'EditData', 'EditFields', and so on. If this argument is an empty string, CommonSpot returns information on all of the element permissions that meet the conditions of other arguments to this method. |
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:
None
Notes:
None