ScheduleTransactionActivityReport

Category: User Permissions: Operator, Trading Call Type: Synchronous

Schedules a series of transaction activity reports for a list of accounts on a single Order Management System, starting at a specific date/time, and covering a specific time interval (90 days, for example). The reports run periodically until canceled.

Users with Trading permission can schedule transaction activity reports only for accounts with which they are associated; users with Operator permission can schedule transaction activity reports for any account.

Transaction Activity Reports are delivered in comma-separated-value (CSV) format. For specific CSV formatting information, see the APEX Extract CSV Data Dictionary, available from AlphaPoint.

Request

{
  "frequency": 0,
  "accountIdList": [1],
  "omsId": 1,
  "beginTime": "2018-08-10T04:00:00.000Z",
  "intervalDuration": 10
}

Response

{
    "RequestingUser": 1,
    "OMSId": 1,
    "reportFlavor": "Transaction",
    "createTime": "2018-08-17T18:02:23Z",
    "initialRunTime": "2018-08-10T04:00:00Z",
    "intervalStartTime": "2018-08-10T04:00:00Z",
    "intervalEndTime": "2018-08-10T05:00:00Z",
    "RequestStatus": "Submitted",
    "ReportFrequency": "Hourly",
    "intervalDuration": 36000000000,
    "RequestId": "I2nCtvyY8UuHsoSyrLe2QA==",
    "lastInstanceId": "AAAAAAAAAAAAAAAAAAAAAA==",
    "accountIds": [1]
}

Similar objects are returned for Generate~Report and Schedule~Report calls.

Last updated

Logo