User-defined fields API
Definitions and values of the ten user-defined fields of each table.
Objects
Each reference table (securities, issuers, accounts, account_groups, brokers, models, benchmarks, desks, list_entries) has ten slots, udf_1 … udf_10. A definition gives a slot a name, a type (text, integer, decimal, date, boolean, list), validation and where it appears; definitions are versioned. Values are per record, by field name (or udf_N).
Typical use
GET /udf/securities to learn the fields, then GET /udf/securities/records/AAPL (keep the ETag) and PUT the values with If-Match. Values are validated like a form; an invalid value answers 422 with the reason. Defining fields needs udf:admin (Admins).
Endpoints
| Call | What it does | Scope |
|---|---|---|
GET/udf/{table} | The ten user-defined field definitions of a table | reference:read |
PUT/udf/{table}/{slot} | Define a field (Admins; versioned) | udf:admin |
GET/udf/{table}/records/{key} | The user-defined values of one record | reference:read |
PUT/udf/{table}/records/{key} | Set user-defined values of one record (If-Match) | reference:write |