GET /system/information/encodings

Retrieves the list of encodings that are supported by the system for event data..

Table 1. GET /system/information/encodings resource details
MIME Type

application/json

Table 2. GET /system/information/encodings request parameter details
Parameter Type Optionality Data Type MIME Type Description

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. GET /system/information/encodings response codes
HTTP Response Code Unique Code Description

200

The encodings were retrieved successfully.

500

1020

An error occurred during the attempt to retrieve the encodings.

Response Description

The list of encodings available on the system. A encoding contains the following fields:
  • id - String - The name/descriptor that identifies the character encoding. Not localized.

Response Sample


[
    {
        "id": "String"
    }
]