ScreenModifiableFields

These are the fields that can be modified on the UI Screen endpoint.

allow_customizeboolean

Whether the user is allowed to customize the settings for this screen.

Example: true

fields object[]

The fields that are available on this screen.

Array [

default_tooltipstring

The default tooltip for the field shown when hovering over the field label.

Example: The name of the Accrual.

idstring

The database ID for the instance of the configured field within the screen. This is a generated value (not fixed).

Example: 34

id_attr_typestring

If this field represents a Custom Field, this is the ID of the Custom Field Type.

Example: null

id_fieldstring

The hardcoded identifier for the field within the screen. These are unique within the screen, but not across different screens.

Example: id_user_properties.fullname

id_field_globalstring

The internal database ID for the configured field, if this is a global settings field.

Example: 34

id_screenstring

The unique identifier for the screen that this field belongs to.

Example: accruals

is_booleanboolean

Whether the field is a boolean field, which will be displayed as a "Yes" or "No" value in the column.

Example: false

is_custom_fieldboolean

Whether the field is a Custom Field.

Example: false

is_datetime_floatboolean

Whether the field is a date-time field, which will be displayed as a formatted date-time value in the column.

Example: false

is_numericboolean

Whether the field is a numeric field, which will be displayed as a formatted number in the column.

Example: false

is_percentboolean

Whether the field is a percentage field, which will be displayed as a formatted percentage value in the column.

Example: false

is_truncatedboolean

Whether the field is automatically truncated when displayed in the search results; the full value can be seen in the tooltip.

Example: false

is_urlboolean

Whether the field is a URL field, which will be displayed as a clickable link in the column.

Example: false

keystring

The key for the field, which is used to identify the field in the search results and in the API. Same as id_field.

Example: id_user_properties.fullname

labelstring

The label to show for this field in the management screen search results.

Example: Owner Name

orderinginteger

The order in which this field should be displayed in the search results.

Example: 1

properties object

Additional extended properties of the field.

property name*string

searchableboolean

Whether the field is searchable in the search panel area on the management screen.

Example: true

sortableboolean

Whether the field is sortable in the search results.

Example: true

table_labelstring

Label of the database table that stores field settings.

Example: Field Config (global)

tablenamestring

The name of the database table that stores the field settings.

Example: fields_config_global

tooltipstring

The tooltip to show for this field in the management screen search results.

Example: The full name of the owner of this Accrual.

]

ScreenModifiableFields

{
  "allow_customize": true,
  "fields": [
    {
      "default_tooltip": "The name of the Accrual.",
      "id": "34",
      "id_attr_type": null,
      "id_field": "id_user_properties.fullname",
      "id_field_global": "34",
      "id_screen": "accruals",
      "is_boolean": false,
      "is_custom_field": false,
      "is_datetime_float": false,
      "is_numeric": false,
      "is_percent": false,
      "is_truncated": false,
      "is_url": false,
      "key": "id_user_properties.fullname",
      "label": "Owner Name",
      "ordering": 1,
      "properties": {},
      "searchable": true,
      "sortable": true,
      "table_label": "Field Config (global)",
      "tablename": "fields_config_global",
      "tooltip": "The full name of the owner of this Accrual."
    }
  ]
}