SheetFields

Fields within a sheet (input boxes, output text, checkboxes, signatures). Per OpenDental API SheetFields.

SheetFields — GET all fields (optional SheetNum, Offset), GET single by SheetFieldNum, or PUT to update FieldValue (only for FieldType OutputText, InputField, CheckBox). See SheetField Database Schema. Related: SheetDefs, Sheets.

SheetNum (optional)

Offset (optional)

Leave SheetNum empty to get all fields; set it to filter by sheet. Offset for pagination.

Click "Load SheetFields" to view.

SheetFieldNum	SheetNum	FieldType	FieldName	FieldValue	IsRequired	ReportableName	DateTimeSig	Actions

Get Single SheetField

Fetch one SheetField by its SheetFieldNum.

SheetFieldNum *

Result:

Update SheetField

Only FieldValue can be updated via the API, and only for FieldType OutputText, InputField, and CheckBox. All fields are listed for reference.

Identify sheet field

SheetFieldNum *

Primary key of the SheetField to update.

Field to update (sent on PUT)

FieldValue

Optional. New value. Only for OutputText, InputField, CheckBox.

All SheetField fields (read-only reference)

SheetNum

Parent sheet.

FieldType

e.g. InputField, OutputText, CheckBox, SigBoxPractice.

FieldName

e.g. prov.nameFormal.

IsRequired

"true" or "false".

ReportableName

Reportable name if any.

DateTimeSig

Signature timestamp if applicable.

Result:

SheetFields GET (multiple)

GET /sheetfields or GET /sheetfields?SheetNum=24 or GET /sheetfields?SheetNum=24&Offset=200. SheetNum optional (after 25.2.3). Offset optional for pagination. Version 22.1.

Example Response (200 OK):

[
  {
    "SheetFieldNum": 1049,
    "SheetNum": 24,
    "FieldType": "InputField",
    "FieldName": "prov.nameFormal",
    "FieldValue": "John D. Smith",
    "IsRequired": "true",
    "ReportableName": "",
    "DateTimeSig": "0001-01-01 00:00:00"
  }
]

Response fields (description):

SheetFieldNum — Primary key of the sheet field.
SheetNum — FK to sheet; the sheet this field belongs to.
FieldType — Type (e.g. InputField, OutputText, CheckBox, SigBoxPractice).
FieldName — Name/source (e.g. prov.nameFormal).
FieldValue — Current value (user input or output text).
IsRequired — "true" or "false"; whether the field is required.
ReportableName — Name used for reporting; may be empty.
DateTimeSig — Signature date/time if applicable (e.g. 0001-01-01 00:00:00 when none).

Responses: 200 OK; 400 BadRequest; 404 NotFound.

SheetFields GET (single)

GET /sheetfields/{SheetFieldNum}. SheetFieldNum required in URL. Version 22.1.

Example Response (200 OK):

{
  "SheetFieldNum": 1049,
  "SheetNum": 24,
  "FieldType": "InputField",
  "FieldName": "prov.nameFormal",
  "FieldValue": "John D. Smith",
  "IsRequired": "true",
  "ReportableName": "",
  "DateTimeSig": "0001-01-01 00:00:00"
}

Response fields (description):

SheetFieldNum — Primary key.
SheetNum — Parent sheet.
FieldType — InputField, OutputText, CheckBox, SigBoxPractice, etc.
FieldName — Name/source (e.g. prov.nameFormal).
FieldValue — Current value.
IsRequired — "true" or "false".
ReportableName — Reportable name if any.
DateTimeSig — Signature timestamp when applicable.

Responses: 200 OK; 400 BadRequest; 404 NotFound.

SheetFields PUT

PUT /sheetfields/{SheetFieldNum}. Updates a SheetField. Only FieldTypes OutputText, InputField, and CheckBox are supported. FieldValue is optional. Version 25.2.

Example Request:

PUT /sheetfields/1049
{
  "FieldValue": "John D. Smith"
}

Request body (description):

FieldValue — Optional. OutputText is pulled from DB to print on sheet. InputField is a blank box for user input. CheckBox is a clickable area; treated like InputField.

Example Response (200 OK):

{
  "SheetFieldNum": 1049,
  "SheetNum": 24,
  "FieldType": "InputField",
  "FieldName": "prov.nameFormal",
  "FieldValue": "John D. Smith",
  "IsRequired": "true",
  "ReportableName": "",
  "DateTimeSig": "0001-01-01 00:00:00"
}

Responses: 200 OK; 400 BadRequest; 404 NotFound.