Skip to main content

Version: 20.05 (EOL)

PUT Confirm Published

Confirm multiple transaction history records as published to your data warehouse. Once records have been marked as published, they can be excluded from future GET requests using the dwhPublishStatus parameter.

Request​

HTTP request​

PUT /manager/secure/rest/transaction-history/v1/ HTTP/1.1
Host: https://<JM_SERVER>/
Content-Type: application/json

{
    "transactionHistoryOid": [ <TXN_HISTORY_OID_1>, <TXN_HISTORY_OID_2>, ...] 
}

For example:

Example request
PUT /manager/secure/rest/transaction-history/v1/ HTTP/1.1
Host: https://transact.maguire.com
Content-Type: application/json

{
    "transactionHistoryOid": [ 2303, 2304, 2305, 2305, 2307, 2308, 2309, 2311, 2312, 2313, 2314 ] 
}

The list of transactionHistoryOid values must be specified and must contain at least one value.

Journey Manager will find all transaction history entries with these OIDs and set their data warehouse publish status to "Completed" and their publish time to the current date time.

Response​

If successful, this operation returns a response with a HTTP 200 OK status code.

Example​

In this example, we get the list of transaction history entries that have not yet been marked as published (Call 1), mark some of them as published (Call 2), and again retrieve the now smaller set of unpublished transaction history entries (Call 3).

Finally, we will get the list of previously published entries (Call 4).

Call 1: GET request prior to PUT​

Example request (Call 1)
GET https://transact.maguire.com/manager/secure/rest/transaction-history/v1/?dwhPublishFlag=null

The result of this call has been heavily edited for brevity. For our purposes, it is enough to show which records are returned.

Example response (Call 1)
[
  {
    "receipt_number": "FTX-CCA-2",
    "submission_oid": 10,
    "transaction_history_oid": 1,
    ...
  },
  {
    "receipt_number": "COA-11",
    "submission_oid": 11,
    "transaction_history_oid": 2,
    ...
  },
  {
    "receipt_number": "NN1434-6",
    "submission_oid": 15,
    "transaction_history_oid": 3,
    ...
  },
  {
    "receipt_number": "NN1434-7",
    "submission_oid": 17,
    "transaction_history_oid": 4,
    ...
  }
]

Call 2: PUT to mark records 1 and 2 as published​

Example request (Call 2)
PUT /manager/secure/rest/transaction-history/v1/ HTTP/1.1
Host: https://transact.maguire.com
Content-Type: application/json

{
    "transactionHistoryOid": [1, 2]
}
"Example
{
  "result": "success"
}

Call 3: Same GET request after PUT​

Example request (Call 3)
GET https://transact.maguire.com/manager/secure/rest/transaction-history/v1/?dwhPublishFlag=null

The result of this call has been heavily edited for brevity. For our purposes, it is enough to show which records are returned.

Note how records that we marked as published in the PUT call are not returned because of the dwhPublishFlag=null URL parameter. You can get the full list of records by omitting the dwhPublishFlag URL parameter.

Example response (Call 3)
[
  {
    "receipt_number": "NN1434-6",
    "submission_oid": 15,
    "transaction_history_oid": 3,
    ...
  },
  {
    "receipt_number": "NN1434-7",
    "submission_oid": 17,
    "transaction_history_oid": 4,
    ...
  }
]

Call 4: GET request for previously published records​

Example request (Call 4)
GET https://transact.maguire.com/manager/secure/rest/transaction-history/v1/?dwhPublishFlag=Completed

The result of this call has been heavily edited for brevity. For our purposes, it is enough to show which records are returned.

Note how only records that we marked as published in the PUT call are returned because of the dwhPublishFlag=Completed URL parameter. These records also have the publish status and date set.

Example response (Call 4)
[
  {
    "dwh_publish_status": "Completed",
    "dwh_publish_time": "2016-05-17T15:32+1000",
    "receipt_number": "FTX-CCA-2",
    "submission_oid": 10,
    "transaction_history_oid": 1,
    ...
  },
  {
    "dwh_publish_status": "Completed",
    "dwh_publish_time": "2016-05-17T15:32+1000",
    "receipt_number": "COA-11",
    "submission_oid": 11,
    "transaction_history_oid": 2,
    ...
  }
]