CustomElement.getFields (Method)
Returns zero or more structures, each containing information about a custom element's fields such as its label, name, position, and the like.
Returns:
CustomElement_GetFields_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| Description | PlainText_2000 | The field's description. |
| ID | FieldID | The field's ID. |
| isShared | Boolean | Boolean flag which when set to true indicates that the field is shared. |
| Label | PlainText_NonNull | The field's label. |
| Name | PlainText_NonNull_255 | The field's name. |
| Params | Struct | Structure containing the field params. |
| Position | PositiveInteger | The field's position on the tab or form. |
| Required | Boolean | Boolean flag which when set to true indicates that the field is required. |
| TabID | FormTabID | The ID of the tab on which CommonSpot displays the field. |
| Type | PlainText_NonNull | The field's type in human-readable form. |
| TypeID | ID | An integer representing the field's type. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| elementID | CustomElementID | Required | A custom element's ID. |
| fieldID | FieldIDList_0 | Optional. Defaults to '0'. | The ID of a custom element field. If this value is 0, CommonSpot return results for all fields instead of just one field. |
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 |
|---|---|
| 9014 | The specified field ID '$1' does not exist for this custom element. |
Notes:
None