MetadataForm.getForms (Method)
Returns zero or more structures, each containing metadata form information. The number of structures returned can be modified by the value of this method's arguments.
Returns:
MetadataForm_GetForms_Result (query)
Each row of the returned query results has the following fields:
Field Name | Type | Description |
---|---|---|
BindingCount | NonNegativeInteger | The number of bindings to which this metadata form is bound. |
BindingList | PlainText | A '||' pipe delimited list of bindings in the form 'type:name:id'; for example, subsite:/customers:12 or category:development:5). |
FormName | MetadataFormName_Existing | The metadata form's name. |
ID | MetadataFormID | The metadata form's ID. |
InheritFromTemplate | Boolean | Boolean flag which when set to true indicates that this metadata form inherits its data from templates. |
LockStatus | ImportedObjectLockStatus | The status indicates that this metadata form is locked or not. |
Arguments:
Name | Type | Required | Description |
---|---|---|---|
id | MetadataFormID_0 | Optional. Defaults to '0'. | A metadata form's ID. If you omit this argument, CommonSpot returns all records having this binding type instead of just one binding type. |
bindingType | BindingTypeFilter | Optional. Defaults to 'All'. | The target binding's type; for example, one of the following: 'ExternalURLs', 'ImageFiles', 'PageCategories' 'Subsite', and so on. |
searchString | PlainText_100 | Optional. Defaults to an empty string. | If specified, the string for which CommonSpot will search against. The search will compare the form name. |
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 | Customization is not supported for this method. |
Error Codes:
None
Notes:
None