Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

PACE report REST API base path path http://host:port/eagle/report/v1 and  and REST API definition resides at http://host:port/eagle/report/v1/api-doc.
For more information about how to get host and port, see REST Endpoints.

...

In order to get report asynchronously, send your POST request to the http://host:port/eagle/report/v1/adhocReport with HTTP header x-eagle-rest-callback: http://your_host/your_endpoint. The result is sent to the defined URL.

Set your query parameters in JSON format as a request body.

...

In response, you receive an ACK with the scheduleId and the correlationIdschedule ID  and the correlation ID.

Code Block
languagejs
titleACK
{
  "taskIdentifier": {
    "correlationId": {
      "value": "QJPUFAJAJ0KRA0PWF"
    }
  },
  "isNegative": false,
  "reason": {
    "reasonTypeEnum": "INFO",
    "reasonCode": {
      "value": "3556152"
    }
  },
  "header": {
    "sentBy": {
      "value": "http://www.eagleinvsys.com/"
    },
    "creationTimestamp": "2018-03-23T13:00:28.349-04:00",
    "messageId": {
      "value": "Q57Y8G6AJC"
    }
  }
}

In the response above, the reasonCode reason Code value is a schedule definition ID. After successful processing, the result is sent to the URL defined as a callback. In the case of unavailable an unavailable PACE report service server, or any error before actual processing takes place, the server responds as a negative ACK with an error description.

Example:

...