Skip to main content

Request

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.

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
    Request
    {
      "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",
      "id": "64BBA147B9AC41D9978062300826C89F",
      "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
      "tablename": "users",
      "table_label": "codes_pay_types"
    }