|
|
APIServer.CustomField.GetInstancesForValue
| Field | Variable | ...as | Description |
|---|---|---|---|
| CustomFieldSiteKey | Position | Input | The current site. Mandatory. |
| CustomFieldEntity | Position | Input | The entity the custom field is defined for. Mandatory. |
| CustomFieldName | Position | Input | The name of the custom field. Mandatory. |
| Value | Position | Input | The value to retrieve instances for. Mandatory. |
| InstanceKey | Position | Input | The unique identification of the record in the
entity (converted to a character string).
Used to position the list of retrieved instances. |
| 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. |
| InstanceKey | FetchedData(64) | Output | The unique identification of the record in the entity specified by Position<CustomFieldEntity> that has the value Position<Value> for the custom field Position<CustomFieldName>. |
The API provides all the instances in an entity that has a specific value for a custom field.
This can be used to search for records that has specified values for custom fields.
Online documentation - WebsydianExpress v3.5