Purge Archived Transactions (Transaction Matching)

Purges matched transactions that are already archived in Transaction Matching.

REST Resource

POST       /arm/rest/{api_version}/jobs

Required Roles

Service Administrator

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request specific to this job.

Table 17-68 PURGE ARCHIVED TRANSACTIONS

Name	Description	Type	Required
api_version	Version of the API you are working with: v1	Path	Yes
jobName	The name of a job, purgearchivetransactions	Payload	Yes
jobId	Job Id of the Archive job which needs to be purged	Payload	Yes
logFileName	The name of the log file If a file name is not provided, the log file is named Purge_Transactions_<reconTypeId>_<Job_id>.log.	Payload	No

Example of request body

{
 "jobName": "purgearchivetransactions",
 "parameters": {
     "jobId": "100000003801002"
     "logFileName" : "Purge_Archive_Transactions_IC120XXXX.log"
}
}

Response

Supported Media Types: application/json

Example of Response Body

The following is an example of the response body in JSON format.

{
    "type": "TM",
    "items": null,
    "error": null,
    "link": null,
    "status": -1,
    "details": null,
    "links": [
        {
            "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/arm/rest/v1/jobs/100000003801002",
            "action": "GET",
            "rel": "self",
            "data": null
        }
    ]
}

To get the status of the purge archived transactions job and view its details, see Retrieve Job Status (Transaction Matching).