MetadataForm.getFields (Method)

Returns zero or more structures, each containing information about a metadata form's fields such as its label, name, position, and the type.

Returns:

MetadataForm_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
formID MetadataFormID Required The ID of the metadata form.
fieldID FieldIDList_0 Optional. Defaults to '0'. The ID of the field, or 0 for all fields.

Context:

License Requirements MetaData
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