ScreenChoicesItemResponse

response_codeinteger

HTTP status code of the response for reference purposes.

Default value: 200

Example: 200

results object

A list of choices for a screen field.

custom_fields object

A list of choices for searchable custom fields to show on this management screen. The keys are the table name of the custom field table, e.g. users_attribs for User Custom Fields.

property name* object[]

Array [

id_attr_typestring

The unique internal ID of this Custom Field definition (same as id field)

Example: 2DDD372DC4D3422D9E73F6DE936C4265

attr_typestring

Datatype of the custom field. The basic types available are:

STRING - a variable-length string.
CHAR - a fixed-length string. (The value may be padded with spaces.)
NUMBER - a floating-point number.
INTEGER - an integer (whole number).
TIMESTAMP - a date and time, stored in Unix epoch format.
DATE - a YYYYMMDD (F8) date.

In addition, most types can be modified with a prefix to indicate whether they are "select lists" (ENUM or enumerated) or "multi-select lists" (M_ENUM) which can take on multiple values.

Strings may also have a maximum length specified, such as STRING_100.

Example: ["STRING_100","ENUM_STRING_20","M_ENUM_STRING_252","ENUM_INTEGER","NUMBER"]

descriptionstring

Description of custom field

pnamestring

Name of custom field

Example: Pay Group

id_attr_type_uristring

URI of the custom field to get more information about the custom field definition.

Example: /api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9

valuestring

Value of the custom field for this object. To update the value, see the note on the CustomFields schema page.

Example: XYZ Pay Group

]

fields object[]

A list of choices for built-in fields available to show on this management screen.

Array [

default_labelstring

The default label for the field.

Example: Accrual Name

default_tooltipstring

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

Example: The name of the Accrual.

field_typestring

The type of the field. Direct fields are fields that are directly on the main table. Extended fields are fields that are on a related table.

Possible values: [direct, extended]

Example: direct

idstring

The hardcoded identifier for the field within the screen. These are unique within the screen, but not across different screens. (Same as id_field.)

Example: pname

id_fieldstring

The hardcoded identifier for the field within the screen. These are unique within the screen, but not across different screens. (Same as id.)

Example: pname

id_screenstring

The unique identifier for the screen that this field is on.

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_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

mod_labelstring

The description to show for this field in the Field Modification screen (the UI adjustment screen). This does not appear on the actual management screen.

Example: Accrual Name

mod_label_tooltipstring

The tooltip to show for this field in the Field Modification screen (the UI adjustment screen). This does not appear on the actual management screen.

Example: The name of the Accrual.

numericboolean

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

Example: false

requiredboolean

Whether the field is required to be present on the management screen.

Example: false

searchableboolean

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

Example: true

sort_by_fieldstring

If set, this is an alternate field to use for sorting the search results when this field is selected for sorting.

sortableboolean

Whether the field is sortable in the search results.

Example: true

]

idstring

The ID of the management screen that these choices are for. (Same value is in the field id_screen.)

Example: accruals

id_screenstring

The ID of the management screen that these choices are for. (Same value is in the field id.)

Example: accruals

successboolean

Indicates whether the request was successful (normally true if it's not an error response)

Default value: true

uristring

URL of the current request / resource, for reference purposes.

Example: https://example.apps.journyx.com/api/v1/users

ScreenChoicesItemResponse
{
  "response_code": 200,
  "results": {
    "custom_fields": {},
    "fields": [
      {
        "default_label": "Accrual Name",
        "default_tooltip": "The name of the Accrual.",
        "field_type": "direct",
        "id": "pname",
        "id_field": "pname",
        "id_screen": "accruals",
        "is_boolean": false,
        "is_percent": false,
        "is_truncated": false,
        "is_url": false,
        "mod_label": "Accrual Name",
        "mod_label_tooltip": "The name of the Accrual.",
        "numeric": false,
        "required": false,
        "searchable": true,
        "sort_by_field": "string",
        "sortable": true
      }
    ],
    "id": "accruals",
    "id_screen": "accruals"
  },
  "success": true,
  "uri": "https://example.apps.journyx.com/api/v1/users"
}