Skip to main content

ScreensChoicesCollectionResponse

response_codeinteger

HTTP status code of the response for reference purposes.

Default value: 200
Example: 200
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
$countinteger

The total number of items matching the query; not the number of items in the current response.

Example: 100
$skipinteger

The number of items skipped in the query; in other words, the offset of the first item in the current response compared to the total set of items in the collection. When used as a query parameter, this is the number of items to skip over.

Example: 0
$topinteger

The number of items returned in the current response. When used as a query parameter, this is the maximum number of items to return.

Example: 10
@nextLinkstring

The URL to fetch the next set (page) of results.

Example: https://example.apps.journyx.com/api/v1/users?$top=10&$skip=10
results object[]

A list of choices for a screen field.

  • Array [
    • 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
  • ]
    • screen object

    Defines various user interface properties for the web UI screen that this collection supports. This is an internal object that is read-only on most object endpoints and is not guaranteed to be a stable interface. This mainly defines the search filters available in the UI. This object may not be present in all collections.

    :::warning Not available in every collection

    This key (object) may not be present in all collections that refer to this schema.

    :::

    iduuid

    The internal ID of the resource or object.

    In general, the id field is the primary key of the object and cannot be changed or updated.

    Example: 64BBA147B9AC41D9978062300826C89F
    uriuri-reference

    The URI associated with this resource. This is usually a relative URL that can be used to access the resource. Typically it incorporates the Unique ID of the resource.

    Example: /api/v1/objects/64BBA147B9AC41D9978062300826C89F
    tablenamestring

    The name of the internal database table associated with this resource.

    Example: users
    table_labelstring

    The user-visible label of the database table associated with this object.

    Example: codes_pay_types
    creatorstring

    The internal User ID of the user who created the object.

    Example: 64BBA147B9AC41D9978062300826C89F
    creator_fullnamestring

    The full name of the user who created the object.

    Example: John Doe
    creator_properties object

    Extended information about the User who created the object. This field is only included if the $keys parameter requests it.

    expense_guistring

    The ID of the user's assigned Expense entry screen configuration.

    time_guistring

    The ID of the user's assigned time entry screen configuration.

    travel_guistring

    The ID of the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.

    daysinlistinteger

    UNUSED FIELD This is a legacy field that is no longer used.

    emailstring

    The email address of the user.

    Note: This is a read-only field. To change the user's email address, you must modify the users_attribs:users_email field.

    first_namestring

    The first name of the user.

    Note: read-only; set via the fullname field.

    id_userstring

    The unique internal ID of this user. (Same as id.)

    Example: 5CD906A3941C463B9CC98F49DBCC25AA
    last_namestring

    The last name of the user.

    Note: read-only; set via the fullname field.

    memorized_sheet_choices object[]

    A list of memorized timesheets associated with the user.

    These are the choices available to set in the default_memorized_sheet field.

  • Array [
    • valuestring

    The internal ID of the memorized timesheet.

    textstring

    The name of the memorized timesheet.

  • ]
    • reserved1string

    UNUSED FIELD This is a legacy field that is no longer used.

    reserved2float

    UNUSED FIELD This is a legacy field that is no longer used.

    reserved3float

    UNUSED FIELD This is a legacy field that is no longer used.

    timerecs_outinteger

    UNUSED FIELD This is a legacy field that is no longer used.

    time_gui_propertiesobject

    Details about the user's assigned time entry screen configuration.

    travel_gui_propertiesobject

    Details about the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.

    expense_gui_propertiesobject

    Details about the user's assigned Expense entry screen configuration.

    create_timestampfloat

    The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.

    Example: 1696021987.01375
    create_timestamp_date_longstring

    The object creation date in the "long date" format defined in the system settings.

    Example: Wednesday, March 22, 2023
    create_timestamp_date_shortstring

    The object creation date in the "short date" format defined in the system settings.

    Example: 03/22/2023
    create_timestamp_datetime_longstring

    The object creation date and time in the "long date" format defined in the system settings.

    Example: Wednesday, March 22, 2023 12:18:46 CDT
    create_timestamp_datetime_shortstring

    The object creation date and time in the "short date" format defined in the system settings.

    Example: 03/22/2023 12:18:46 CDT
    create_timestamp_isodate-time

    The creation timestamp in ISO 8601 format.

    Example: 2023-03-22T12:18:46-05:00
    modifierstring

    The internal User ID of the user who most recently modified the object.

    Example: 64BBA147B9AC41D9978062300826C89F
    modifier_fullnamestring

    The full name of the user who most recently modified the object.

    Example: John Doe
    modifier_properties object

    Extended information about the User who last modified the object. This field is only included if the $keys parameter requests it.

    expense_guistring

    The ID of the user's assigned Expense entry screen configuration.

    time_guistring

    The ID of the user's assigned time entry screen configuration.

    travel_guistring

    The ID of the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.

    daysinlistinteger

    UNUSED FIELD This is a legacy field that is no longer used.

    emailstring

    The email address of the user.

    Note: This is a read-only field. To change the user's email address, you must modify the users_attribs:users_email field.

    first_namestring

    The first name of the user.

    Note: read-only; set via the fullname field.

    id_userstring

    The unique internal ID of this user. (Same as id.)

    Example: 5CD906A3941C463B9CC98F49DBCC25AA
    last_namestring

    The last name of the user.

    Note: read-only; set via the fullname field.

    memorized_sheet_choices object[]

    A list of memorized timesheets associated with the user.

    These are the choices available to set in the default_memorized_sheet field.

  • Array [
    • valuestring

    The internal ID of the memorized timesheet.

    textstring

    The name of the memorized timesheet.

  • ]
    • reserved1string

    UNUSED FIELD This is a legacy field that is no longer used.

    reserved2float

    UNUSED FIELD This is a legacy field that is no longer used.

    reserved3float

    UNUSED FIELD This is a legacy field that is no longer used.

    timerecs_outinteger

    UNUSED FIELD This is a legacy field that is no longer used.

    time_gui_propertiesobject

    Details about the user's assigned time entry screen configuration.

    travel_gui_propertiesobject

    Details about the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.

    expense_gui_propertiesobject

    Details about the user's assigned Expense entry screen configuration.

    modify_timestampfloat

    The timestamp when the object was most recently modified, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.

    Example: 1696021987.01375
    modify_timestamp_date_longstring

    The last modification date in the "long date" format defined in the system settings.

    Example: Wednesday, March 22, 2023
    modify_timestamp_date_shortstring

    The last modification date in the "short date" format defined in the system settings.

    Example: 03/22/2023
    modify_timestamp_datetime_longstring

    The last modification date and time in the "long date" format defined in the system settings.

    Example: Wednesday, March 22, 2023 12:18:46 CDT
    modify_timestamp_datetime_shortstring

    The last modification date and time in the "short date" format defined in the system settings.

    Example: 03/22/2023 12:18:46 CDT
    modify_timestamp_isodate-time

    The last modification timestamp in ISO 8601 format.

    Example: 2023-03-22T12:18:46-05:00
    id_domainstring

    The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.

    Example: install_root_dom
    allow_customizeboolean

    Indicates whether the user can customize the columns displayed in the screen.

    Example: true
    cf_filters object[]

    A list of custom field filters that are available for this screen.

  • 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
  • ]
    • cf_filters_unused object[]

    A list of custom field filters that are available for this screen, but are not currently used.

  • 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[]

    The list of fields to show in this management screen's search results.

  • 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.
  • ]
    • global_allows_customizeboolean

    Indicates whether the screen's global settings allow for per-user customization of the columns displayed in the screen.

    Example: true
    id_screenstring

    The unique internal ID of this screen. (Same as id.) These are fixed values that are defined in the system.

    Example: accruals
    is_globalboolean

    Indicates whether this user is currently user global settings for this screen. If false, the user is using their own settings.

    Example: false
    other_search_filtersstring[]

    A list of other search filters that are available for this screen.

    Example: ["project","group"]
    other_search_filters_unusedstring[]

    A list of other search filters that are available for this screen, but are not currently used.

    Example: ["px_teams"]
    propertiesobject

    A list of additional properties for this screen. Currently unused.

    ScreensChoicesCollectionResponse
    {
      "response_code": 200,
      "success": true,
      "uri": "https://example.apps.journyx.com/api/v1/users",
      "$count": 100,
      "$skip": 0,
      "$top": 10,
      "@nextLink": "https://example.apps.journyx.com/api/v1/users?$top=10&$skip=10",
      "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"
        }
      ],
      "screen": {
        "id": "64BBA147B9AC41D9978062300826C89F",
        "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
        "tablename": "users",
        "table_label": "codes_pay_types",
        "creator": "64BBA147B9AC41D9978062300826C89F",
        "creator_fullname": "John Doe",
        "creator_properties": {
          "expense_gui": "string",
          "time_gui": "string",
          "travel_gui": "string",
          "daysinlist": 0,
          "email": "string",
          "first_name": "string",
          "id_user": "5CD906A3941C463B9CC98F49DBCC25AA",
          "last_name": "string",
          "memorized_sheet_choices": [
            {
              "value": "string",
              "text": "string"
            }
          ],
          "reserved1": "string",
          "reserved2": 0,
          "reserved3": 0,
          "timerecs_out": 0,
          "time_gui_properties": {},
          "travel_gui_properties": {},
          "expense_gui_properties": {}
        },
        "create_timestamp": 1696021987.01375,
        "create_timestamp_date_long": "Wednesday, March 22, 2023",
        "create_timestamp_date_short": "03/22/2023",
        "create_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
        "create_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
        "create_timestamp_iso": "2023-03-22T12:18:46-05:00",
        "modifier": "64BBA147B9AC41D9978062300826C89F",
        "modifier_fullname": "John Doe",
        "modifier_properties": {
          "expense_gui": "string",
          "time_gui": "string",
          "travel_gui": "string",
          "daysinlist": 0,
          "email": "string",
          "first_name": "string",
          "id_user": "5CD906A3941C463B9CC98F49DBCC25AA",
          "last_name": "string",
          "memorized_sheet_choices": [
            {
              "value": "string",
              "text": "string"
            }
          ],
          "reserved1": "string",
          "reserved2": 0,
          "reserved3": 0,
          "timerecs_out": 0,
          "time_gui_properties": {},
          "travel_gui_properties": {},
          "expense_gui_properties": {}
        },
        "modify_timestamp": 1696021987.01375,
        "modify_timestamp_date_long": "Wednesday, March 22, 2023",
        "modify_timestamp_date_short": "03/22/2023",
        "modify_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
        "modify_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
        "modify_timestamp_iso": "2023-03-22T12:18:46-05:00",
        "id_domain": "install_root_dom",
        "allow_customize": true,
        "cf_filters": [
          {
            "id_attr_type": "2DDD372DC4D3422D9E73F6DE936C4265",
            "attr_type": [
              "STRING_100",
              "ENUM_STRING_20",
              "M_ENUM_STRING_252",
              "ENUM_INTEGER",
              "NUMBER"
            ],
            "description": "string",
            "pname": "Pay Group",
            "id_attr_type_uri": "/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9",
            "value": "XYZ Pay Group"
          }
        ],
        "cf_filters_unused": [
          {
            "id_attr_type": "2DDD372DC4D3422D9E73F6DE936C4265",
            "attr_type": [
              "STRING_100",
              "ENUM_STRING_20",
              "M_ENUM_STRING_252",
              "ENUM_INTEGER",
              "NUMBER"
            ],
            "description": "string",
            "pname": "Pay Group",
            "id_attr_type_uri": "/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9",
            "value": "XYZ Pay Group"
          }
        ],
        "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."
          }
        ],
        "global_allows_customize": true,
        "id_screen": "accruals",
        "is_global": false,
        "other_search_filters": [
          "project",
          "group"
        ],
        "other_search_filters_unused": [
          "px_teams"
        ],
        "properties": {}
      }
    }