Versions Compared

Key

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

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

Details how to get host and port you can find at REST Endpoints

In order to get report asynchronously you should send POST request to the http://host:port/eagle/report/v1/adhocReport with HTTP header x-eagle-return-ticket: true or x-eagle-rest-callback: http://your_host/your_endpoint (in case of set x-eagle-rest-callback header result will be sent to defined URL) and set query parameters in JSON format as a request body

{
"reportName": "RF PLA SM LPO",
"entityId": "2005P01",
"beginDate": "20140101",
"endDate": "20140131",
"fields": "",
"outputFormat":"JSON"
}

In response you will get ACK with scheduleId and correlationId

{
"taskIdentifier": {
"correlationId": {
"value": "8RTFPDOM5CQCNOVB1"
}
},
"isNegative": false,
"reason": {
"reasonTypeEnum": "INFO",
"reasonCode": {
"value": "3554701"
}
},
"header": {
"sentBy": {
"value": "http://www.eagleinvsys.com/"
},
"creationTimestamp": "2018-03-22T14:37:46.854-04:00",
"messageId": {
"value": "RGCOCKW1ED"
}
}
}

To get status of your request send request to the http://host:port/eagle/report/v1/adhocReport/correlationId?statusonly=1 where correlationId is value from response above.

If report request is processed you will get TSR with status of request

{
"statusItem": [
{
"taskIdentifier": {},
"status": "SUCCESS",
"severityCode": {
"value": "1"
},
"reason": [ {} ]
}
],
"header": {
"sentBy": {
"value": "http://www.eagleinvsys.com/"
},
"creationTimestamp": "2018-03-22T14:43:13.095-04:00"
}
}

Where status could be "SUCCESS" of "FAILED" or if request still in processing you will get ACK similar to the first one. In case of success you can get report sending the request http://host:port/eagle/report/v1/adhocReport/correlationId

If you accidently define wrong correlationId you will get TSR with error description