Changelog for i2 Analyze REST SPI 1.2

Version 1.2 contains minor changes to the i2 Analyze REST SPI.

This version contains new functionality that allows you to define Visual Query services for your connector. Analysts can then interrogate an external source in the same way as they query the Information Store.

There are also minor changes to the structure of the client configuration in the response that you return from the configuration endpoint.

Added

N/A

Modified

The following endpoints were modified at this version of the i2 Analyze REST SPI:

  • /CONFIGURATION_URL

    • The clientConfigType field in the Service object is now deprecated. The type field in the ClientConfig object is used instead.

      • The type field in the ClientConfig object is now mandatory as a replacement for the deprecated clientConfigType field in the Service object.

    • The config field in the ClientConfig object is now defined as one of FormConfig, VisualQueryConfig, or object.

      • The FormConfig object is used to define a form that is presented to users in the client. It contains a new mandatory field to indicate whether the form itself is mandatory, even if no conditions in the form are mandatory.

      • The VisualQueryConfig object is used to define the configuration that governs the behavior and content of visual queries.

  • /ASYNC_SERVICE_URL

    • A new visualQuery field is added to the DaodRequestPayload object. If the service uses a client configuration of type 'VISUAL_QUERY', this field is populated with the visual query payload to execute.

  • /SYNC_SERVICE_URL

    • A new visualQuery field is added to the DaodRequestPayload object. If the service uses a client configuration of type 'VISUAL_QUERY', this field is populated with the visual query payload to execute.

  • /VALIDATE_URL

    • A new visualQuery field is added to the DaodRequestPayload object. If the service uses a client configuration of type 'VISUAL_QUERY', this field is populated with the visual query payload to execute.

Removed

N/A