FormTemplateField

org.sagebionetworks.repo.model.dataaccess.schema.FormTemplateField

A single field slot in a form template step. Maps a JSON pointer in the referenced schema to a UI definition. Validation that the slot resolves to a real leaf property in the schema, that the slot's UI definition is compatible with the property's type/format, and that no two slots in the template share a schemaPath, is performed when the template is created or updated.

Field	Type	Description
schemaPath	STRING	JSON pointer (RFC 6901) into the template's referenced schema, identifying the leaf property this slot renders. Example: '/institution'. The pointer is resolved against the schema with '$ref's expanded.
uiDefinition	OBJECT	Defines the appearance of this slot in the form UI. Defined by react-jsonschema-form.
submissionContext	SubmissionContext	Controls whether this slot appears (and the underlying schema property is collected) for an initial REQUEST, a RENEWAL, or both. Default is 'ALWAYS'. The schema's 'required' declaration only binds for contexts in which the property is included; if a required property is excluded for the active context, it is treated as not required.
templateFileHandleId	STRING	A Synapse FileHandle ID used to download a template file for this slot. Intended only for slots whose target schema property uses the 'synapse-filehandle-id' format. The file can be downloaded using FileHandleAssociateType.AccessRequirementAttachment.
isPublic	BOOLEAN	When true, responses to this field will be publicly viewable after approval. Default is false.