Versions Compared

Key

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

...

Code Block
languagejs
titlex-eagle-return-ticket: true
curl -X POST -H "x-eagle-return-ticket: true" -d @requestBody.json "http://host:port/eagle/report/v1/adhocReport"

The response is the same ACK as in the case with callback, but you can use the correlationId value as a key to get information about processing or, in case of success, the result.

...

Code Block
languagejs
titleTSR Request Status
{
  "statusItem": [
    {
      "taskIdentifier": {
        "correlationId": {
          "value": "8S8WFEP8H14HIZJT9"
        }
      },
      "status": "SUCCESS",
      "severityCode": {
        "value": "1"
      },
      "reason": [
        {}
      ]
    }
  ],
  "header": {
    "sentBy": {
      "value": "http://www.eagleinvsys.com/"
    },
    "creationTimestamp": "2018-03-23T13:01:50.312-04:00"
  }
}

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

If you accidently accidentally define the wrong correlationId, you will get receive a TSR with an error description.

Code Block
languagejs
titleTSR with Error
{
  "statusItem": [
    {
      "taskIdentifier": {
        "correlationId": {
          "value": "89OVZ7XM47N4WUVYJ"
        }
      },
      "status": "FAILED",
      "severityCode": {
        "value": "1"
      },
      "reason": [
        {
          "description": "Could not find any request with correlation id 8RTFPDOM5CQCNOVB1q"
        }
      ]
    }
  ],
  "header": {
    "sentBy": {
      "value": "http://www.eagleinvsys.com/"
    },
    "creationTimestamp": "2018-03-22T15:22:39.864-04:00"
  }
}



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

...