| Name (singular): | Custom Field |
| Name (plural): | Custom Fields |
| Alias (uri): | custom_field |
| Identifier (ID): | cerberusweb.contexts.custom_field |
Records API
These fields are available in the Records API and packages:
| Req’d | Field | Type | Notes |
|---|---|---|---|
| x | context |
context | The record type to add the field to |
custom_fieldset_id |
number | The ID of the parent custom fieldset; if any | |
links |
links | An array of record type:id tuples to link to. Prefix with - to unlink. |
|
| x | name |
text | The name of this custom field |
params |
object | JSON-encoded key/value object | |
pos |
number | Display order; positive integer; 0 is first |
|
| x | type |
text | C (checkbox), D (picklist), E (date), F (file), I (files), L (record link), M (list), N (number), O (decimal), S (single line of text), T (multiple lines of text), U (url), W (worker), X (multiple checkboxes), Y (currency) |
updated_at |
timestamp | The date/time when this record was last modified | |
| x | uri |
text | The unique alias for this custom field |
Dictionary Placeholders
These placeholders are available in dictionaries for automations, snippets, and API responses:
| Field | Type | Description |
|---|---|---|
_context |
text | Record type extension ID |
_label |
text | Label |
_type |
text | Record type alias |
context |
text | Context |
id |
number | Id |
name |
text | Name |
pos |
number | Order |
search_filter |
text | Search Filter Name |
type |
text | Type |
type_label |
text | Type Label |
updated_at |
date | Updated |
uri |
text | Uri |
These optional placeholders are also available with key expansion in dictionaries and the API:
| Field | Type | Description |
|---|---|---|
comment_count |
number | Comment count on the record |
comments |
comments | Comments |
Search Query Fields
These filters are available in custom field search queries:
| Field | Type | Description |
|---|---|---|
context: |
text | Context |
fieldset: |
record | Fieldset |
fieldset.id: |
chooser | Custom Fieldset |
id: |
number | Id |
links: |
links | Record Links |
name: |
text | Name |
pos: |
number | Order |
type: |
text | Type |
updated: |
date | Updated |
uri: |
text | Uri |
Worklist Columns
These columns are available on custom field worklists:
| Column | Description |
|---|---|
c_context |
Context |
c_custom_fieldset_id |
Custom Fieldset |
c_id |
Id |
c_name |
Name |
c_pos |
Order |
c_type |
Type |
c_updated_at |
Updated |
c_uri |
Uri |