ActivityMonitorCollectionResponse
HTTP status code of the response for reference purposes.
200
200
Indicates whether the request was successful (normally true
if it's
not an error response).
true
URL of the current request / resource, for reference purposes.
https://example.apps.journyx.com/api/v1/users
The total number of items matching the query; not the number of items in the current response.
100
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.
0
The number of items returned in the current response. When used as a query parameter, this is the maximum number of items to return.
10
The URL to fetch the next set (page) of results.
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.
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.
64BBA147B9AC41D9978062300826C89F
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.
/api/v1/objects/64BBA147B9AC41D9978062300826C89F
The name of the internal database table associated with this resource.
users
The user-visible label of the database table associated with this object.
codes_pay_types
The IP address of the client that initiated the request.
10.0.0.31
The number of database queries executed during the request.
5
The number of database records read during the request.
143
The total time in milliseconds spent executing database queries.
114
The list of event IDs associated with the request.
[97029,97030]
Indicates if an error occurred during the request.
The number of heartbeat messages received during the request.
1
The list of times that heartbeat messages were received.
The IP address of the host that processed the request.
10.0.0.21
The name of the host that processed the request.
example.apps.journyx.com
The unique identifier of the request (same as id
).
The unique identifier of the user that initiated the request, if applicable.
jdoe
Indicates if the request is an asynchronous task.
Indicates if the request has completed.
Indicates if the request is a cron action (scheduled task).
Indicates if the request is the current request being processed.
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.
The Resident Set Size (RSS) memory usage in bytes.
253190144
The Virtual Memory Size (VMS) memory usage in bytes.
1797857280
The order of this request within the current response list.
The process ID of the request.
45940
properties object
Additional properties associated with the request, if any.
The body of the request, if any. This value may be truncated.
The description of the request type, based on the request path.
Users Collection
request_form object
The form data (or query parameters) of the request, if any.
property name* string[]
The length of the request body in bytes.
The HTTP method of the request.
The path of the request URI.
The body of the response, if any. This value may be truncated.
The length of the response body in bytes.
The status code of the response, if any.
200
The total time in milliseconds spent generating the response.
123
The long-formatted end date of the request.
Monday, September 30, 2024
The short-formatted end date of the request.
09/30/2024
The long-formatted end date and time of the request.
Monday, September 30, 2024 14:25:43 CDT
The short-formatted end date and time of the request.
09/30/2024 14:25:43 CDT
The end date and time of the request in Unix epoch format.
1727724343.434125
The end date and time of the request in ISO 8601 format.
2024-09-30T14:25:43-05:00
The long-formatted start date of the request.
Monday, September 30, 2024
The short-formatted start date of the request.
09/30/2024
The long-formatted start date and time of the request.
Monday, September 30, 2024 14:25:43 CDT
The short-formatted start date and time of the request.
09/30/2024 14:25:43 CDT
The start date and time of the request in Unix epoch format.
1727724343.434125
The start date and time of the request in ISO 8601 format.
2024-09-30T14:25:43-05:00
The status of the request. Possible values are:
- OK
- Running
- Incomplete
- Error
- Stopped
OK
The long-formatted status of the request.
The request completed normally.
The numeric order of the status of the request, so that running requests are always sorted first.
100
The full name of the user that initiated the request, if applicable.
John Doe
The login name of the user that initiated the request, if applicable.
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.
:::
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.
64BBA147B9AC41D9978062300826C89F
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.
/api/v1/objects/64BBA147B9AC41D9978062300826C89F
The name of the internal database table associated with this resource.
users
The user-visible label of the database table associated with this object.
codes_pay_types
The internal User ID of the user who created the object.
64BBA147B9AC41D9978062300826C89F
The full name of the user who created the object.
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.
The ID of the user's assigned Expense entry screen configuration.
The ID of the user's assigned time entry screen configuration.
The ID of the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.
UNUSED FIELD This is a legacy field that is no longer used.
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.
The first name of the user.
Note: read-only; set via the fullname
field.
The unique internal ID of this user. (Same as id
.)
5CD906A3941C463B9CC98F49DBCC25AA
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.
The internal ID of the memorized timesheet.
The name of the memorized timesheet.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
Details about the user's assigned time entry screen configuration.
Details about the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.
Details about the user's assigned Expense entry screen configuration.
The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.
1696021987.01375
The object creation date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023
The object creation date in the "short date" format defined in the system settings.
03/22/2023
The object creation date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDT
The object creation date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDT
The creation timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00
The internal User ID of the user who most recently modified the object.
64BBA147B9AC41D9978062300826C89F
The full name of the user who most recently modified the object.
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.
The ID of the user's assigned Expense entry screen configuration.
The ID of the user's assigned time entry screen configuration.
The ID of the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.
UNUSED FIELD This is a legacy field that is no longer used.
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.
The first name of the user.
Note: read-only; set via the fullname
field.
The unique internal ID of this user. (Same as id
.)
5CD906A3941C463B9CC98F49DBCC25AA
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.
The internal ID of the memorized timesheet.
The name of the memorized timesheet.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
Details about the user's assigned time entry screen configuration.
Details about the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.
Details about the user's assigned Expense entry screen configuration.
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.
1696021987.01375
The last modification date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023
The last modification date in the "short date" format defined in the system settings.
03/22/2023
The last modification date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDT
The last modification date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDT
The last modification timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00
The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.
install_root_dom
Indicates whether the user can customize the columns displayed in the screen.
true
cf_filters object[]
A list of custom field filters that are available for this screen.
The unique internal ID of this Custom Field definition (same as id
field)
2DDD372DC4D3422D9E73F6DE936C4265
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
.
["STRING_100","ENUM_STRING_20","M_ENUM_STRING_252","ENUM_INTEGER","NUMBER"]
Description of custom field
Name of custom field
Pay Group
URI of the custom field to get more information about the custom field definition.
/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9
Value of the custom field for this object. To update the value, see the note on the CustomFields schema page.
XYZ Pay Group
cf_filters_unused object[]
A list of custom field filters that are available for this screen, but are not currently used.
The unique internal ID of this Custom Field definition (same as id
field)
2DDD372DC4D3422D9E73F6DE936C4265
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
.
["STRING_100","ENUM_STRING_20","M_ENUM_STRING_252","ENUM_INTEGER","NUMBER"]
Description of custom field
Name of custom field
Pay Group
URI of the custom field to get more information about the custom field definition.
/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9
Value of the custom field for this object. To update the value, see the note on the CustomFields schema page.
XYZ Pay Group
fields object[]
The list of fields to show in this management screen's search results.
The default tooltip for the field shown when hovering over the field label.
The name of the Accrual.
The database ID for the instance of the configured field within the screen. This is a generated value (not fixed).
34
If this field represents a Custom Field, this is the ID of the Custom Field Type.
null
The hardcoded identifier for the field within the screen. These are unique within the screen, but not across different screens.
id_user_properties.fullname
The internal database ID for the configured field, if this is a global settings field.
34
The unique identifier for the screen that this field belongs to.
accruals
Whether the field is a boolean field, which will be displayed as a "Yes" or "No" value in the column.
false
Whether the field is a Custom Field.
false
Whether the field is a date-time field, which will be displayed as a formatted date-time value in the column.
false
Whether the field is a numeric field, which will be displayed as a formatted number in the column.
false
Whether the field is a percentage field, which will be displayed as a formatted percentage value in the column.
false
Whether the field is automatically truncated when displayed in the search results; the full value can be seen in the tooltip.
false
Whether the field is a URL field, which will be displayed as a clickable link in the column.
false
The key for the field, which is used to identify the field in the
search results and in the API.
Same as id_field
.
id_user_properties.fullname
The label to show for this field in the management screen search results.
Owner Name
The order in which this field should be displayed in the search results.
1
properties object
Additional extended properties of the field.
Whether the field is searchable in the search panel area on the management screen.
true
Whether the field is sortable in the search results.
true
Label of the database table that stores field settings.
Field Config (global)
The name of the database table that stores the field settings.
fields_config_global
The tooltip to show for this field in the management screen search results.
The full name of the owner of this Accrual.
Indicates whether the screen's global settings allow for per-user customization of the columns displayed in the screen.
true
The unique internal ID of this screen. (Same as id
.)
These are fixed values that are defined in the system.
accruals
Indicates whether this user is currently user global settings for this screen. If false, the user is using their own settings.
false
A list of other search filters that are available for this screen.
["project","group"]
A list of other search filters that are available for this screen, but are not currently used.
["px_teams"]
A list of additional properties for this screen. Currently unused.
{
"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": {
"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": {}
}
}