Skip to main content

ActivityMonitorCollectionResponse

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

Represents a 'Request' within the system. Usually, but not always, represents an HTTP request, but may also represent a Scheduled Task (cron job) or other special event types.

  • Array [
  • 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
    client_ip_addrstring

    The IP address of the client that initiated the request.

    Example: 10.0.0.31
    db_query_countinteger

    The number of database queries executed during the request.

    Example: 5
    db_records_readinteger

    The number of database records read during the request.

    Example: 143
    db_time_msinteger

    The total time in milliseconds spent executing database queries.

    Example: 114
    event_idsinteger[]

    The list of event IDs associated with the request.

    Example: [97029,97030]
    had_errorboolean

    Indicates if an error occurred during the request.

    heartbeat_countinteger

    The number of heartbeat messages received during the request.

    Example: 1
    heartbeat_timesdate-time[]

    The list of times that heartbeat messages were received.

    host_ip_addrstring

    The IP address of the host that processed the request.

    Example: 10.0.0.21
    host_namestring

    The name of the host that processed the request.

    Example: example.apps.journyx.com
    id_requeststring

    The unique identifier of the request (same as id).

    id_userstring

    The unique identifier of the user that initiated the request, if applicable.

    Example: jdoe
    is_async_taskboolean

    Indicates if the request is an asynchronous task.

    is_completedboolean

    Indicates if the request has completed.

    is_cron_actionboolean

    Indicates if the request is a cron action (scheduled task).

    is_this_requestboolean

    Indicates if the request is the current request being processed.

    killedboolean

    Indicates if the request was killed before completion.

    Note: you can set this value to true in a POST to the uri of this request to kill it, if you are an Administrator role.

    memory_rssinteger

    The Resident Set Size (RSS) memory usage in bytes.

    Example: 253190144
    memory_vmsinteger

    The Virtual Memory Size (VMS) memory usage in bytes.

    Example: 1797857280
    orderinteger

    The order of this request within the current response list.

    process_idstring

    The process ID of the request.

    Example: 45940
    properties object

    Additional properties associated with the request, if any.

    property name*string
    request_bodystring

    The body of the request, if any. This value may be truncated.

    request_descriptionstring

    The description of the request type, based on the request path.

    Example: Users Collection
    request_form object

    The form data (or query parameters) of the request, if any.

    property name* string[]
  • Array [
  • string
  • ]
  • request_lengthinteger

    The length of the request body in bytes.

    request_methodstring

    The HTTP method of the request.

    request_pathstring

    The path of the request URI.

    response_bodystring

    The body of the response, if any. This value may be truncated.

    response_lengthinteger

    The length of the response body in bytes.

    response_statusstring

    The status code of the response, if any.

    Example: 200
    response_time_msinteger

    The total time in milliseconds spent generating the response.

    Example: 123
    end_date_longstring

    The long-formatted end date of the request.

    Example: Monday, September 30, 2024
    end_date_shortstring

    The short-formatted end date of the request.

    Example: 09/30/2024
    end_datetime_longstring

    The long-formatted end date and time of the request.

    Example: Monday, September 30, 2024 14:25:43 CDT
    end_datetime_shortstring

    The short-formatted end date and time of the request.

    Example: 09/30/2024 14:25:43 CDT
    end_epochnumber

    The end date and time of the request in Unix epoch format.

    Example: 1727724343.434125
    end_isostring

    The end date and time of the request in ISO 8601 format.

    Example: 2024-09-30T14:25:43-05:00
    start_date_longstring

    The long-formatted start date of the request.

    Example: Monday, September 30, 2024
    start_date_shortstring

    The short-formatted start date of the request.

    Example: 09/30/2024
    start_datetime_longstring

    The long-formatted start date and time of the request.

    Example: Monday, September 30, 2024 14:25:43 CDT
    start_datetime_shortstring

    The short-formatted start date and time of the request.

    Example: 09/30/2024 14:25:43 CDT
    start_epochnumber

    The start date and time of the request in Unix epoch format.

    Example: 1727724343.434125
    start_isostring

    The start date and time of the request in ISO 8601 format.

    Example: 2024-09-30T14:25:43-05:00
    statusstring

    The status of the request. Possible values are:

    • OK
    • Running
    • Incomplete
    • Error
    • Stopped
    Example: OK
    status_longstring

    The long-formatted status of the request.

    Example: The request completed normally.
    status_numeric_orderinteger

    The numeric order of the status of the request, so that running requests are always sorted first.

    Example: 100
    user_fullnamestring

    The full name of the user that initiated the request, if applicable.

    Example: John Doe
    user_loginstring

    The login name of the user that initiated the request, if applicable.

    Example: jdoe
  • ]
  • 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.

    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
    custom_fields object

    An object with Custom Fields for this record. The key is the field ID and the value a description of the field. Additional details here: CustomFields Schema

    tip

    Updating Custom Field values

    When creating or updating an existing object that uses Custom Fields, for example a User record, you can follow this custom_field key structure to update the custom field values. The value field is the only required field for updating a custom field value; other fields such as pname will be ignored.

    info

    Important: depending on the endpoint, this may only be included in the response if $keys=custom_fields or $keys=$extended was set as a query parameter.

    There is also a more compact representation available in most object types, where each custom field value is a separate key in the main object (not under custom_fields).

    See the CustomFields Schema page for more detailed information on these topics.

    property name* CustomFieldValue

    A specific instance (value) of a Custom field for a particular object.

    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 and char 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.

    Note that when modifying Custom Fields of objects like Users or Projects, only the value key will be checked; other fields like the Custom Field pname will be ignored.

    Example: XYZ Pay Group
    group_names object[]

    A list of Groups (names and IDs) that the object belongs to.

    This is a read-only list. To change the Groups that an object belongs to, use the groups field.

    See GroupFields for additional information about Groups and this field.

  • Array [
  • iduuid

    The Group ID.

    pnamestring

    The Group name.

    uristring

    The URI of the Group.

    WARNING: this field is planned in a future release but is not yet available.

  • ]
  • groupsuuid[]

    A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.

    Example: ["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]
    is_hiddenboolean

    Indicates whether the object is hidden.

    See also status

    hiddenboolean

    Indicates whether the user is hidden.

    Read-only alias for is_hidden.

    statusstring

    The status of the user; either hidden, active, or inactive.

    Possible values: [Hidden, Loggable and Reportable, Reportable Only]

    Example: Loggable and Reportable
    status_codestring

    The internal code for the status of the object; either:

    • lr for Loggable and Reportable
    • ro for Reportable Only
    • h for Hidden

    Possible values: [lr, ro, h]

    Example: lr
    user_loginstringrequired

    The login name of the user.

    Example: john.smith@example.com
    fullnamestringrequired

    The full name of the user.

    Example: John Smith
    u_commentstring

    The default comment on the user's time entry screen.

    default_memorized_sheetstring

    The ID of the user's default memorized timesheet.

    dropdownthresholdinteger

    The number of items in a selection list to trigger a forced search.

    hideboolean

    Indicates whether the user is hidden.

    Note: the User object is the only one that uses this field; other objects use is_hidden.

    expire_new_pwboolean

    Whether the user's new password should expire after the first login.

    This is a write-only field that does not appear in User object responses.

    new_pwstring

    The new password for the user.

    The password must also be set in the new_pw2 field to confirm the change.

    This is a write-only field that does not appear in User object responses.

    new_pw2string

    The new password for the user, repeated to confirm the change.

    The password must also be set in the new_pw field to confirm the change.

    This is a write-only field that does not appear in User object responses.

    rolesstring[]

    A list of role IDs belonging to this user.

    This list can be modified to change the user's roles.

    timerecs_ininteger

    The number of blank rows to show on the entry screen.

    Example: 3
    time_periodstring

    The "Entry Screen period" (time-span) associated with the user's Time Entry screen.

    Example: default_weekly
    expense_periodstring

    The "Entry Screen period" (time-span) associated with the user's Expense Entry screen.

    Example: default_weekly
    custom_periodstring

    The "Entry Screen period" (time-span) associated with the user's Custom Entry screen.

    Example: default_weekly
    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.

    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_propertiesobject

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

    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
    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, or custom_fields.users_email.value.

    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.

    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
    custom_fields object

    An object with Custom Fields for this record. The key is the field ID and the value a description of the field. Additional details here: CustomFields Schema

    tip

    Updating Custom Field values

    When creating or updating an existing object that uses Custom Fields, for example a User record, you can follow this custom_field key structure to update the custom field values. The value field is the only required field for updating a custom field value; other fields such as pname will be ignored.

    info

    Important: depending on the endpoint, this may only be included in the response if $keys=custom_fields or $keys=$extended was set as a query parameter.

    There is also a more compact representation available in most object types, where each custom field value is a separate key in the main object (not under custom_fields).

    See the CustomFields Schema page for more detailed information on these topics.

    property name* CustomFieldValue

    A specific instance (value) of a Custom field for a particular object.

    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 and char 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.

    Note that when modifying Custom Fields of objects like Users or Projects, only the value key will be checked; other fields like the Custom Field pname will be ignored.

    Example: XYZ Pay Group
    group_names object[]

    A list of Groups (names and IDs) that the object belongs to.

    This is a read-only list. To change the Groups that an object belongs to, use the groups field.

    See GroupFields for additional information about Groups and this field.

  • Array [
  • iduuid

    The Group ID.

    pnamestring

    The Group name.

    uristring

    The URI of the Group.

    WARNING: this field is planned in a future release but is not yet available.

  • ]
  • groupsuuid[]

    A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.

    Example: ["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]
    is_hiddenboolean

    Indicates whether the object is hidden.

    See also status

    hiddenboolean

    Indicates whether the user is hidden.

    Read-only alias for is_hidden.

    statusstring

    The status of the user; either hidden, active, or inactive.

    Possible values: [Hidden, Loggable and Reportable, Reportable Only]

    Example: Loggable and Reportable
    status_codestring

    The internal code for the status of the object; either:

    • lr for Loggable and Reportable
    • ro for Reportable Only
    • h for Hidden

    Possible values: [lr, ro, h]

    Example: lr
    user_loginstringrequired

    The login name of the user.

    Example: john.smith@example.com
    fullnamestringrequired

    The full name of the user.

    Example: John Smith
    u_commentstring

    The default comment on the user's time entry screen.

    default_memorized_sheetstring

    The ID of the user's default memorized timesheet.

    dropdownthresholdinteger

    The number of items in a selection list to trigger a forced search.

    hideboolean

    Indicates whether the user is hidden.

    Note: the User object is the only one that uses this field; other objects use is_hidden.

    expire_new_pwboolean

    Whether the user's new password should expire after the first login.

    This is a write-only field that does not appear in User object responses.

    new_pwstring

    The new password for the user.

    The password must also be set in the new_pw2 field to confirm the change.

    This is a write-only field that does not appear in User object responses.

    new_pw2string

    The new password for the user, repeated to confirm the change.

    The password must also be set in the new_pw field to confirm the change.

    This is a write-only field that does not appear in User object responses.

    rolesstring[]

    A list of role IDs belonging to this user.

    This list can be modified to change the user's roles.

    timerecs_ininteger

    The number of blank rows to show on the entry screen.

    Example: 3
    time_periodstring

    The "Entry Screen period" (time-span) associated with the user's Time Entry screen.

    Example: default_weekly
    expense_periodstring

    The "Entry Screen period" (time-span) associated with the user's Expense Entry screen.

    Example: default_weekly
    custom_periodstring

    The "Entry Screen period" (time-span) associated with the user's Custom Entry screen.

    Example: default_weekly
    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.

    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_propertiesobject

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

    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
    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
    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, or custom_fields.users_email.value.

    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 and char 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.

    Note that when modifying Custom Fields of objects like Users or Projects, only the value key will be checked; other fields like the Custom Field pname will be ignored.

    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 and char 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.

    Note that when modifying Custom Fields of objects like Users or Projects, only the value key will be checked; other fields like the Custom Field pname will be ignored.

    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.

    ActivityMonitorCollectionResponse
    {
    "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": [
    {
    "id": "64BBA147B9AC41D9978062300826C89F",
    "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
    "tablename": "users",
    "table_label": "codes_pay_types",
    "client_ip_addr": "10.0.0.31",
    "db_query_count": 5,
    "db_records_read": 143,
    "db_time_ms": 114,
    "event_ids": [
    97029,
    97030
    ],
    "had_error": true,
    "heartbeat_count": 1,
    "heartbeat_times": [
    "2024-07-29T15:51:28.071Z"
    ],
    "host_ip_addr": "10.0.0.21",
    "host_name": "example.apps.journyx.com",
    "id_request": "string",
    "id_user": "jdoe",
    "is_async_task": true,
    "is_completed": true,
    "is_cron_action": true,
    "is_this_request": true,
    "killed": true,
    "memory_rss": 253190144,
    "memory_vms": 1797857280,
    "order": 0,
    "process_id": "45940",
    "properties": {},
    "request_body": "string",
    "request_description": "Users Collection",
    "request_form": {},
    "request_length": 0,
    "request_method": "string",
    "request_path": "string",
    "response_body": "string",
    "response_length": 0,
    "response_status": "200",
    "response_time_ms": 123,
    "end_date_long": "Monday, September 30, 2024",
    "end_date_short": "09/30/2024",
    "end_datetime_long": "Monday, September 30, 2024 14:25:43 CDT",
    "end_datetime_short": "09/30/2024 14:25:43 CDT",
    "end_epoch": 1727724343.434125,
    "end_iso": "2024-09-30T14:25:43-05:00",
    "start_date_long": "Monday, September 30, 2024",
    "start_date_short": "09/30/2024",
    "start_datetime_long": "Monday, September 30, 2024 14:25:43 CDT",
    "start_datetime_short": "09/30/2024 14:25:43 CDT",
    "start_epoch": 1727724343.434125,
    "start_iso": "2024-09-30T14:25:43-05:00",
    "status": "OK",
    "status_long": "The request completed normally.",
    "status_numeric_order": 100,
    "user_fullname": "John Doe",
    "user_login": "jdoe"
    }
    ],
    "screen": {
    "id": "64BBA147B9AC41D9978062300826C89F",
    "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
    "tablename": "users",
    "table_label": "codes_pay_types",
    "creator": "64BBA147B9AC41D9978062300826C89F",
    "creator_fullname": "John Doe",
    "creator_properties": {
    "id": "64BBA147B9AC41D9978062300826C89F",
    "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
    "tablename": "users",
    "table_label": "codes_pay_types",
    "custom_fields": {
    "C41B2DDA662F4EF6B730F9CB6DB04696": {
    "attr_type": "ENUM_STRING_252",
    "description": "Employee pay group.",
    "id_attr_type": "C41B2DDA662F4EF6B730F9CB6DB04696",
    "id_attr_type_uri": "/api/v1/custom_fields/C41B2DDA662F4EF6B730F9CB6DB04696",
    "pname": "Pay Group",
    "value": "XYZ Pay Group"
    },
    "users_email": {
    "attr_type": "STRING_252",
    "description": "Email address",
    "id_attr_type": "users_email",
    "id_attr_type_uri": "/api/v1/custom_fields/users_email",
    "pname": "Email Address",
    "value": "username@example.com"
    }
    },
    "group_names": [
    {
    "id": "5088C427E8B64EBEBE1C5B5961DB1902",
    "pname": "Sales"
    },
    {
    "id": "3553F715A6F54DAB95D0D25B08468195",
    "pname": "Accounting"
    }
    ],
    "groups": [
    "5088C427E8B64EBEBE1C5B5961DB1902",
    "3553F715A6F54DAB95D0D25B08468195"
    ],
    "is_hidden": true,
    "hidden": true,
    "status": "Loggable and Reportable",
    "status_code": "lr",
    "user_login": "john.smith@example.com",
    "fullname": "John Smith",
    "u_comment": "string",
    "default_memorized_sheet": "string",
    "dropdownthreshold": 0,
    "hide": true,
    "expire_new_pw": true,
    "new_pw": "string",
    "new_pw2": "string",
    "roles": [
    "string"
    ],
    "timerecs_in": 3,
    "time_period": "default_weekly",
    "expense_period": "default_weekly",
    "custom_period": "default_weekly",
    "expense_gui": "string",
    "time_gui": "string",
    "travel_gui": "string",
    "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": {},
    "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",
    "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": {
    "id": "64BBA147B9AC41D9978062300826C89F",
    "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
    "tablename": "users",
    "table_label": "codes_pay_types",
    "custom_fields": {
    "C41B2DDA662F4EF6B730F9CB6DB04696": {
    "attr_type": "ENUM_STRING_252",
    "description": "Employee pay group.",
    "id_attr_type": "C41B2DDA662F4EF6B730F9CB6DB04696",
    "id_attr_type_uri": "/api/v1/custom_fields/C41B2DDA662F4EF6B730F9CB6DB04696",
    "pname": "Pay Group",
    "value": "XYZ Pay Group"
    },
    "users_email": {
    "attr_type": "STRING_252",
    "description": "Email address",
    "id_attr_type": "users_email",
    "id_attr_type_uri": "/api/v1/custom_fields/users_email",
    "pname": "Email Address",
    "value": "username@example.com"
    }
    },
    "group_names": [
    {
    "id": "5088C427E8B64EBEBE1C5B5961DB1902",
    "pname": "Sales"
    },
    {
    "id": "3553F715A6F54DAB95D0D25B08468195",
    "pname": "Accounting"
    }
    ],
    "groups": [
    "5088C427E8B64EBEBE1C5B5961DB1902",
    "3553F715A6F54DAB95D0D25B08468195"
    ],
    "is_hidden": true,
    "hidden": true,
    "status": "Loggable and Reportable",
    "status_code": "lr",
    "user_login": "john.smith@example.com",
    "fullname": "John Smith",
    "u_comment": "string",
    "default_memorized_sheet": "string",
    "dropdownthreshold": 0,
    "hide": true,
    "expire_new_pw": true,
    "new_pw": "string",
    "new_pw2": "string",
    "roles": [
    "string"
    ],
    "timerecs_in": 3,
    "time_period": "default_weekly",
    "expense_period": "default_weekly",
    "custom_period": "default_weekly",
    "expense_gui": "string",
    "time_gui": "string",
    "travel_gui": "string",
    "creator": "64BBA147B9AC41D9978062300826C89F",
    "creator_fullname": "John Doe",
    "creator_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",
    "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",
    "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": {}
    }
    }