infor

Compass SQL query platform (version 2).

The Compass API allows you to retrieve and interact data that has been stored in the Infor Datalake via SQL query.

This API is broken up into two parts:

* • General
* • Jobs

The Jobs API contains the endpoints that allow you execute Compass queries. The General API contains only one endpoint, _ping_, which allows you to check the availability of the Compass services. The general workflow for executing a Compass query is as follows:

* • Submit a query
* • Periodically check on the status of the query until it has completed or been canceled
* • Retrieve the query results


Compass SQL Query Platform

General

Checks the availability of the Compass service provided by the _queryExecutor_.
Note that the body of the response is irrelevant.  Any other HTTP status code response other than 200,
which could be from an intermediate load balancer or other component, indicates an inability
to successfully call the service.


Ping call for the Compass API

Jobs

Submit a Compass query as an asynchronous job.

A successful response will include a queryId. The supplied queryId can then be used to cancel the query, check the status of the query, and retrieve the results of the query once the query has completed executing.


Submits a Compass SQL job request.

Cancel a query using the queryId that was provided when submitting a Compass job.

An OK response status, HTTP 200, indicates a successful cancel request. Note that calling cancel on a completed/failed query will have no effect.



Cancels running SQL query.

Retrieve the query results using the queryId that was provided when submitting the a query.

Use this API after the Compass Status API indicates that the query has finished successfully, failed, or has been cancelled.
A query that finished successfully returns the query results, and a query that fails or was cancelled displays an error message.


Get the result for a queryId that was provided from a Compass job.

Check the status of a query using the queryId that was provided when submitting a Compass job.

The response indicates the current query status. Possible values for "status" property in the response:

* • RUNNING - indicates that the query is executing.
* • FINISHED - indicates that the query completed successfully. Use the GET result API call to retrieve the results.
* • FAILED - indicates that the query is finished and ended in error. Use the GET result API call to retrieve the error details.
* • CANCELED - indicates that the query has been canceled.


Check the status of a queryId provided by the executed Compass job.

Default

Compass V2

Infor API | Compass V2

Generated server url

The maximum number of records to return, optional. Passing zero (the default) will return all records.

records

location

queryId

status

dataObjectId

line

localizedMessage

message

messageCategory

messageCode

messageTime

messageType

position

suggestedLocalizedText

userTableName

Compass operations are not allowed for the tenant.

The unique queryId provided as a response by the Compass Jobs API when the query was submitted.

result

Use this to specify whether the results are deflated (compressed) or identity (uncompressed).

Accept-Encoding

Offset is the row offset for the result; offset is 0-based.

offset

Limit is the maximum number of rows in the result. The limit is 100 000 rows max with a maximum 10MB size cap.

limit

The matched records in JSON, NDJSON, or DSV format.

Requested media type doesn't match the result format

Specify the long-polling timeout period. The value can be 0 – 25 seconds. 0 is the default, indicating that long-polling is not used.

Sections