Websydian v6.1 online documentationOnline documentation - WebsydianExpress v3.5

API: CustomField.GetAllValuesForInstance

Scoped Name

APIServer.CustomField.GetAllValuesForInstance

Interface

Field Variable ...as Description
CustomFieldEntity Position Input The entity the custom field is defined for.
InstanceKey Position Input The unique identification of the record in the entity (converted to a character string).
CustomFieldName Position Input The name of the custom field - used to position the retrieved list of name/value pairs.
Position Control Input Specifies whether the data in the Position variable is used for positioning when fetching the data.
RowsFetched Control Dual The number of fetched records in the output variable FetchedData.
CustomFieldName FetchedData(64) Output The name of the retrieved custom field.
Value FetchedData(64) Output The value registered for the custom field for the specified record.

Description

The API provides all the data registered as custom fields for a specific record.

The API retrieves all of the custom fields that has been specified for an entity. For each of these custom fields, the value registered for a specific record in the entity is returned together with the name of the custom field. If no value has been registered for a combination of entity, record, and custom field - blank is returned for the value.

Events

Universal events