Skip to main content

EntryColumnItemResponse

response_codeinteger

HTTP status code of the response for reference purposes.

Default value: 200
Example: 200
results object

Represents an Entry Column definition. That is an available selection (dropdown) or text entry column on an Entry Screen.

activatedboolean

Indicates whether the Entry Column is activated. A non-activated column will not appear anywhere in the system, e.g. in Entry Screen Configuration.

Example: true
activation_gdefstring

The system setting name (gdef) that controls whether this Entry Column is activated. This is used to set the activated property.

Example: ACTIVATE_E_C_4
base_labelstring

The base label of the Entry Column. This is the label without any suffixes or prefixes.

Example: Currency
base_label_pluralstring

The plural form of the label of the Entry Column.

Example: Currencies
column_fullstring

The full name of the column in the database table.

Example: expense_recs.id_code_currency
current_priorityinteger

The current priority of the Entry Column. This is used to determine the order of columns in the Entry Screen. (Lower numbers appear to the left.)

entry_obj_indexinteger

The index of this Entry Column in the core entry database table record.

Example: 6
entry_tablestring

The name of the database table that stores main entry values, where this Entry Column is a field in that record.

Example: expense_recs
entry_table_columnstring

The name of the column in the main entry table that stores this Entry Column value.

Example: id_code_currency
entry_typestring

The Entry Screen type of this Entry Column. Values can be: time, expense, mileage. The value mileage is used for what the system calls "Custom Entry" sheets.

Possible values: [time, expense, mileage]

entryguilib_keystring

An internal system identifier for this Entry Column used in some areas.

Example: subsubcode
field_typestring

The type of the field in the entry database table.

  • code - an Entry Code type
  • text - a text entry (comment) field
  • project - the special Project field
  • group - the special Group field, not used in most configurations

Possible values: [code, text, project, group]

fixed_orderinteger

The default ordering of this Entry Column when added to new Entry Screens.

Example: 1
gui_default_db_keystring

The GUI (Entry Screen Configuration) setting that controls the default value for this Entry Column.

Example: currency_default
gui_default_indexinteger

The index of the default value for this Entry Column in the GUI configuration record.

Example: 20
gui_idstring

The internal ID of the GUI (Entry Screen Configuration) record for this Entry Column, if this record is associated with a specific Entry Screen config.

gui_priority_db_keystring

The GUI (Entry Screen Configuration) setting that controls the on-screen ordering (priority) for this Entry Column.

Example: currency_priority
gui_priority_indexinteger

The index in the GUI configuration record that stores the priority (ordering) of this Entry Column.

Example: 22
gui_tablestring

The name of the database table that stores the Entry Screen configuration (GUI) for this Entry Column.

Example: expense_guis
idstring

The unique internal ID of this Entry Column.

Example: expense_recs.id_code_currency
jtgui_keystring

An internal system identifier for this Entry Column used in some areas.

Example: dd2
jxapi_keystring

An internal system identifier for this Entry Column used in some areas, notably in the Legacy SOAP API.

Example: code2
labelstring

The label of the Entry Column. This is the human-readable name of the column.

Example: Currency
label_gdefstring

The system setting name (gdef) that controls the label of this Entry Column.

Example: COLUMN_E_C_4
label_pluralstring

The plural form of the label of the Entry Column.

Example: Currencies
object_key_fullstring

The full primary key name (table and column name) of the Entry Column values table.

Example: codes_currencies.id_code
object_table_keystring

The primary key name of the Entry Column values table.

Example: id_code
object_tablenamestring

The table name of the Entry Column values table.

Example: codes_currencies
request_recs_indexinteger

The index of this Entry Column in the Leave Requests database table record.

Example: 6
uristring

The URI of this Entry Column.

Example: /api/v1/entry_columns/expense_recs.id_code_currency
value_collection_uristring

The URI to get a collection of values for this Entry Column.

Example: /api/v1/entry_codes/codes_currencies
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
EntryColumnItemResponse
{
  "response_code": 200,
  "results": {
    "activated": true,
    "activation_gdef": "ACTIVATE_E_C_4",
    "base_label": "Currency",
    "base_label_plural": "Currencies",
    "column_full": "expense_recs.id_code_currency",
    "current_priority": 0,
    "entry_obj_index": 6,
    "entry_table": "expense_recs",
    "entry_table_column": "id_code_currency",
    "entry_type": "time",
    "entryguilib_key": "subsubcode",
    "field_type": "code",
    "fixed_order": 1,
    "gui_default_db_key": "currency_default",
    "gui_default_index": 20,
    "gui_id": "string",
    "gui_priority_db_key": "currency_priority",
    "gui_priority_index": 22,
    "gui_table": "expense_guis",
    "id": "expense_recs.id_code_currency",
    "jtgui_key": "dd2",
    "jxapi_key": "code2",
    "label": "Currency",
    "label_gdef": "COLUMN_E_C_4",
    "label_plural": "Currencies",
    "object_key_full": "codes_currencies.id_code",
    "object_table_key": "id_code",
    "object_tablename": "codes_currencies",
    "request_recs_index": 6,
    "uri": "/api/v1/entry_columns/expense_recs.id_code_currency",
    "value_collection_uri": "/api/v1/entry_codes/codes_currencies"
  },
  "success": true,
  "uri": "https://example.apps.journyx.com/api/v1/users"
}