document
v1
POST /api/v1/document/document-fields/{uid}/check_formula/
Check formula for EXISTING Document Field Expects request data arguments:
- formula: str OR
- convert_decimals_to_floats_in_formula_args: bool
- hide_until_python: str
- field_type: str
- document_type: str - document type uid
- depends_on_fields: List[str] - list of field uids Either "request.data.formula" or "request.data.hide_until_python" should be filled.
Request
- Base URL/ (relative, and the document was published on a file host, not at the API’s origin)
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
uidstring required
A UUID string identifying this document field.
Request body
Example request
{
"formula": "formula",
"hide_until_python": "hide_until_python"
}Response
object required
Changes
No recorded changes to this operation across all 5 revisions of this API.