Table of Contents

TTMSMCPElicitFieldType Enumeration

Data type requested for one field of an elicitation schema. eftString asks for free-form text, eftNumber asks for a numeric value, eftBoolean asks for a yes/no value, and eftEnum asks for one choice out of a fixed list of values.

API unit family: TMS.MCP.Elicitation

Remarks

The schema that travels with the request is JSON Schema, which has no separate enumeration type: an eftEnum field is emitted as a string property carrying the permitted values as an additional constraint.

Members

Name Description
eftString Free-form text, emitted as a string property in the schema. It is also the type an unrecognized schema type name falls back to.
eftNumber Numeric value, emitted as a number property in the schema. The value comes back as text and is converted by the caller.
eftBoolean Two-state value, emitted as a boolean property in the schema and normally rendered by the client as a check box.
eftEnum One choice out of a fixed list. It is emitted as a string property carrying the permitted values as an additional constraint, so the list of values must be filled in as well; a field of this type with an empty list is emitted as a plain text property.