Available API Methods

This table shows the API methods available in the /oneviewapi endpoint:

Method Type Description
/data GET Get events or messages based on the filter. Define the 'store' parameter to access the type of collection to address: Event (default) or Message. For example, use this query:

/data?[filter=<filterExpression>]&[store=<Event|Message>]&[page=<pageNumber>]&[records=<numberOfRecords>]&[sort=<sortFieldName>]

You can use the 'filter' URL parameter to express "dynamic" search query by the client.

Example of compound and nested condition:

(event_source_type eq '*jdbc') and (event_type eq 3 OR (event_type eq 4 AND event_source_name eq "infor.rec.rec") )

/data/facets GET

Get aggregations for statistics analysis. For example, you can find the mostly used connection points.

Parameters can be one of the available fields, such as message header and content fields, document type, document id, or document noun.

The fields slightly differ for on-premises and in cloud; see the Infor ION Desk User Guide.

The Swagger documentation indicates which parameters of the method "GET/data/facets" are limited to only one ION version, on premises or cloud.

/data/documentPayload GET Retrieve a document payload for the specified message Id.

The message id that is sent as a parameter cannot be empty. A correct value must be used. The payload object for the message id that is sent as a parameter cannot be empty or purged.

/data/streamDocumentPayload GET Stream a document payload for the specified message Id.

The message id that is sent as a parameter cannot be empty. A correct value must be used. The payload object for the message id that is sent as a parameter cannot be empty or purged.

/data/ping GET Test whether the service is running.