API SheetFieldDefs
Anyone using the API should also become very familiar with our schema documentation which contains important details about individual database table columns.
See Sheetfielddef Database Schema.
SheetFieldDefs GET (single)
Version Added: 25.1.27
Gets a single sheetfielddef.
Parameter:
SheetFieldDefNum: Required in URL.
Example Request:
GET /sheetfielddef/1
Example Response:
{
"SheetFieldDefNum": 1,
"SheetDefNum": 1,
"FieldType": "StaticText",
"FieldName": "",
"FieldValue": "Sincerely",
"IsRequired": "false"
}
200 OK
404 NotFound (with explanation)
SheetFieldDefs GET (multiple)
Version Added: 25.1.27
Gets a list of sheetfielddefs.
SheetDefNum: Optional. Filter by SheetDefNum.
Example Requests:
GET /sheetfielddefs
GET /sheetfielddefs?SheetDefNum=1
Example Response:
[
{
"SheetFieldDefNum": 1,
"SheetDefNum": 1,
"FieldType": "StaticText",
"FieldName": "",
"FieldValue": "Sincerely",
"IsRequired": "false"
},
{
"SheetFieldDefNum": 2,
"SheetDefNum": 1,
"FieldType": "OutputText",
"FieldName": "today.DayDate",
"FieldValue": "",
"IsRequired": "false"
},
{
"SheetFieldDefNum": 3,
"SheetDefNum": 1,
"FieldType": "StaticText",
"FieldName": "",
"FieldValue": "Please excuse [nameFL] due to a dental appointment on [dateToday]. You are welcome to contact us with any questions.",
"IsRequired": "false"
},
etc...
]
200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)