FieldMasks.getList (Method)

Returns zero or more structures, each containing information on field masks registered for the site. The 'fieldTypeID' tells CommonSpot to return information for just that field mask.

Returns:

FieldMasks_GetList_Result (query)

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

Field Name	Type	Description
InputModule	PlainText	Either the name of a ColdFusion module or the full path to it.
InputModuleType	FieldMaskType	String naming the input module's type, which is either 'Standard' or 'Explicit'.
isDefault	Boolean	Boolean flag which when true indicates this is the default mask for this field type.
IsLocked	Boolean	Boolean flag which when true indicates that the mask is locked.
MaskDesc	PlainText_2000	The mask's description.
MaskID	MaskID	The mask's ID.
MaskName	PlainText_NonNull_255	The mask's name.
OutputModule	PlainText	Either the name of a ColdFusion module or the full path to it.
OutputModuleType	FieldMaskType	String naming the output module's type, which is either 'Standard' or 'Explicit'.

Arguments:

Name	Type	Required	Description
fieldTypeID	FieldTypeID	Required	A field type's ID.
maskID	MaskID_0	Optional. Defaults to '0'.	A mask's ID. If this value is 0, CommonSpot returns information on all masks associated with a field type instead of information for one mask.

Context:

License Requirements	None
Permission Requirements	site:ManageFieldTypesMasks
Deny Context	None
Require Context	None
Author Lock	(not required)
Transaction Logging	Transaction logging is disabled for this method
Customization	Customization is not supported for this method.

Error Codes:

Code	Error Message
18005	MaskID $1 for $2 is not valid.

Notes:

None