infor

This interface is used to Oneview client applications

ION OneView

/data?[filter=&lt;filterExpression&gt;]&amp;[store=&lt;Event|Message&gt;]&amp;[page=&lt;pageNumber&gt;]&amp;[records=&lt;numberOfRecords&gt;]&amp;[sort=&lt;sortFieldName&gt;] 
 
Filter query parameter:
 
&#39;filter&#39; URL parameter can be used to express &quot;dynamic&quot; search query by the client. It is composed of conditions, which are connected with boolean operators.
 
Each condition has following format:
 
   Simple condition:
   (field_name operator &#39;value&#39;)
 
Conditions can be connected with &quot;and&quot; and &quot;or&quot; operators:
   Compound condition:
       (event_source_type eq &#39;*jdbc&#39;) and (event_type eq 3) and event_date range [2014-12-19T23:24:22.410Z, 2014-12-19T23:24:22.700Z]
 
Conditions can be nested as follows:
   Compound and nested condition
       (event_source_type eq &#39;*jdbc&#39;) and (event_type eq 3 OR (event_type eq 4 AND event_source_name eq &quot;infor.rec.rec&quot;) )
 
Condition structure breakdown:
 
   - field_name: name of field that is going to be compared
       A name of one of the attributes, belonging to the queried collection
   - operator: one of the binary operators for operators list below
   - value: Value to compare to.
       If value is string, it is enclosed in single or double quotes.It is case sensitive.
           double quote: value is phrase(the whole phrase is matched)
           single quote: value is word. It can contain wild characters: * 
       If value is a number, it is not enclosed
       If value is date, date is not enclosed and conforms to DATE_ISO8601_FORMAT = &quot;yyyy-MM-dd&#39;T&#39;HH:mm:ss.SSS&#39;Z&#39;&quot;; e.g. 2014-12-19T23:24:22.410Z
 
Operator list:
   - eq - equals
   - gt - greater than
   - ge - greater than or equal
   - lt - less than
   - le - less than or equal
   - range - range of dates

Logical operator list:
   - and - and
   - or - or

Values
   - Numeric values are not enclosed in quotes
   - Decimal numbers - dot character is used as a separator for numeric values with decimal part
       - Example: 123.45
 
Value examples:
 
   // General value examples
 
   (custom eq &#39;User2&#39;) // String, enclosed in single. Returns records where custom contains specified word. It accepts wildcard *.
 
   (custom eq &quot;User2&quot;) // String, enclosed in double quotes is phrase. It returns the exact match.
 
   (tenant_id eq &quot;*test*&quot;) // String, enclosed in double quotes can contain wild chars
 
   (age lt 35) // Number, not enclosed
 
   event_date range [2014-12-19T23:24:22.410Z, 2014-12-19T23:24:22.700Z]

Get events or messages by filter. Define 'store' to access event domain or message domain

Retrieve document payload based on messageId

Stream document payload based on messageId

Parameters can be one of the following fields: 
 
    document_noun
    document_verb
    document_type
    document_id 
    document_sent_from

    Message header fields
    header_document_id
    header_accounting_entity
    header_location
    header_source

    Message content fields
    content_accounting_entity
    content_location
    content_description
    content_status
    content_revision_id
    content_variation_id

    handled_in_activation_policy
    handled_in_connection_point
    handled_in_mapping
    handled_in_message_listener (On-Prem only)
    handled_in_monitor
    handled_in_workflow
    handled_in_alarm_template
    handled_in_alarm_instance
    handled_in_document_split 
    handled_in_merge          (ION CE only)
    handled_in_scripting      (ION CE only)

    message_statuses
    message_date(),
    // bod properties
    message_custom_keys
    message_custom_properties



Get Facets response

Ping call for oneviewapi

Default

Oneviewapi

Infor API | Oneviewapi

Field name followed by colon followed by direction (asc or desc; default asc). Example: 'event_date:desc'

sort

The page number from which to start returning records. Starts from 1

page

The number of records that will be returned. Starts from 0

records

The restrictions to be applied on the returned records

filter

Type of collection to address(Event or Message). Defaults to Event.

store

numFound

objectList

aggregationResultList

start

fields

facetFields

facetQuery

empty

The matched records in JSON format

When tenant id is not filled from HTTP header in CE edition query cannot be performed

Server error

messageId

The matched records in XML format

** When tenant id is not filled from HTTP header in CE edition query cannot be performed

** ‘messageid’ is a mandatory field and can’t be empty.

** Failed to retrieve document contents(document was empty or purged using Data Lake Purge).

** Payload address is null or empty, could not find payload for tenant '{TenantId}' and messageId '{MessageId}'


The requested document in XML format

field

Returns all facets

** When tenant id is not filled from HTTP header in CE edition query cannot be performed.

** 'handled_in_message_listener' got deprecated in ION CE. It is applicable for On-Prem only.

** 'handled_in_merge' field(s) not applicable for On-Prem. It is applicable for ION CE only.

** 'handled_in_scripting' field(s) not applicable for On-Prem. It is applicable for ION CE only.

** 'handled_in_merge' and 'handled_in_scripting' field(s) not applicable for On-Prem. It is applicable for ION CE only.



Sections