Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Template

Get available system fields for a roster type

Returns the catalog of mappable Certify attributes for the given roster type. Used by the 'create template from scratch' builder to populate the attribute dropdown.

get/templates/fields

Query parameters

type'PRACTITIONER' | 'FACILITY' | 'GROUP' required

Roster type (PRACTITIONER, FACILITY, or GROUP)

Headers

tenant-idstring required

Tenant identifier

Response

Fields retrieved successfully

namestring

CSV column header this mapping applies to, exactly as it appears in the roster file.

mappedKeystring

Key of the Certify system field this column maps to, from the field catalog returned by GET /templates/fields. The sentinel [skipped] marks a column the user explicitly chose not to map: skipped columns persist in the template/mappings CSVs but are excluded from the generated validation schema.

mappedEntitystring

Entity that owns the mapped attribute (for example practitioner or location). When set, mappedKey is accepted as-is instead of being validated against the system-field catalog.

entityGroupstring

Group label linking columns that belong to the same repeating entity instance (a multiple-value group), so related columns are ingested together.

isRequiredboolean

Whether every roster row must supply a value for this column; drives the required constraint in the generated validation schema.

isStaticFieldboolean

Catalog metadata: whether the mapped system field is a static (fixed-value) field rather than one populated from roster data.

isSingleSelectboolean

Catalog metadata: whether the mapped system field accepts a single value from a fixed option list.

validationRegexstring

Regular expression applied to this column's values during roster validation. Rows whose values do not match are rejected.

descriptionstring

Human-readable description of the mapped system field, from the field catalog.

enumstring[]

Allowed values for enum-type system fields; roster values outside this list fail validation. Absent for free-form fields.

separatorstring

Literal separator character used to split a single cell value into multiple tokens for multi-value attributes. Blank or absent defaults to a comma at schema-generation time.

singleSelectboolean
skippedboolean

Example response

[
  {
    "name": "First Name",
    "mappedKey": "firstName",
    "mappedEntity": "practitioner",
    "entityGroup": "license",
    "validationRegex": "^\\d{10}$",
    "separator": ";"
  }
]