Versions Compared

Key

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

...

Table of Contents
minLevel2

Ad Hoc Report POST Endpoint

PACE report REST API base path http://host:port/eagle/report/v1 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.

Execute Ad Hoc Report Asynchronously with a Callback

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 the response above, the reasonCode value is a schedule definition idID. After successful processing, the result is sent to the URL defined as a callback.

In case of unavailable pace-PACE report service server or any error before actual processing takes place, the server responds as a negative ACK with error description.

...

Code Block
titleNegative ACK
{
  "taskIdentifier": {
    "correlationId": {
      "value": "8RTFPDOM5CQCNOVB1"
    }
  },
  "isNegative": true,
  "reason": {
    "reasonTypeEnum": "ERROR",
    "description": "Service Temporarily Unavailable"
  },
  "header": {
    "sentBy": {
      "value": "http://www.eagleinvsys.com/"
    },
    "creationTimestamp": "2018-03-23T12:31:57.541-04:00",
    "messageId": {
      "value": "L2364E1UX6"
    }
  }
}

Execute Ad Hoc Report with Ticketing

To be able to track the status of processing, send a request with x-eagle-return-ticket: true.

...

You can also use x-eagle-correlation-id HTTP header to specify your correlation id.

...

Adhoc Report get Endpoint in MC2

This endpoint redirects requests to the existing AdhocReport POST endpoint transforming the GET parameters into the JSON HTTP body and allows the use of HTTP GET parameters as shown in the examples below.

...