Purge Transactions (Transaction Matching)

You can specify filterOperator and filterValue to further filter the matched transactions. Otherwise, all matched transactions older than or equal to the age from all accounts for the specified matchType are purged.

REST Resource

POST       /arm/rest/{api_version}/jobs

Required Roles

Service Administrator, Power User, User, Viewer

Users with Power User, User, and Viewer predefined roles may require additional application roles.

Request

Supported Media Types: application/json

Parameters

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

Table 17-33 Parameters

Name	Description	Type	Required	Values
`api_version`	Version of the API you are working with, such as v1	Path	Yes	v1
`jobName`	The name of a job	Payload	Yes	`purgetransactions`
`ReconTypeId`	The identifier (TextID) of the match type from which matched transactions should be deleted	Payload	Yes	Example: `CLEARING`
`matchedStatus`	The status of the transactions to be deleted. The only value currently supported is `matched`.	Payload	No	Default value: `matched`
`age`	Identifies the number of days since the transaction was matched. Matched transactions older than or equal to this value will be deleted.	Payload	Yes	Example: 180
`filterOperator`	Optionally, use one of the following filter conditions to identify the accounts containing matched transactions for deletion. This value is combined with the `filterValue` to identify the accounts from which matched transactions should be purged: `EQUALS` `NOT_EQUALS` `STARTS_WITH` `ENDS_WITH` `CONTAINS` `NOT_CONTAINS`	Payload	No	Examples: `EQUALS` `Starts_With`
`filterValue`	Optionally use one or more filter values to identify the transactions to purge. Use a space-separated list to specify multiple values as shown in the examples. If multiple values are specified, transactions from accounts matching any filter operator and filter value combination are selected for purging. `EQUALS` and `NOT_EQUALS` support multiple values. `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, and `NOT_CONTAINS` only support a single value.	Payload	No	Examples: `["101-1234","102-1234"]` `["102"]`
`logFileName`	Optionally, enter the name of a log file to record information about the API activity.	Payload	No	If a file name is not specified, a log file named `PurgeTransactions_Job_ID` is automatically generated. The file is located in the Outbox.

Example of request body

Example of purging matched transactions 120 days or older for CLEARING match type and accounts equal to 101-1234 and 102-1234:

{
	"jobName" : "purgetransactions",
	"parameters": 
				{
				   "reconTypeId" : "CLEARING", 
				   "age" : 120,
			          "filterOperator":"EQUALS",		
                              "filterValue" : ["101-1234","102-1234"],
                              "logFileName" : "purge-clearing"
				}
}

Example of purging matched transactions 120 days or older for CLEARING match type and accounts start with 101:

{
	"jobName" : "purgetransactions",
	"parameters": 
				{
				   "reconTypeId" : "CLEARING", 
				   "age" : 120,
			          "filterOperator":"STARTS_WITH",		
                              "filterValue" : ["101"],
                              "logFileName" : "purge-clearing"
				}
}

Response

Supported Media Types: application/json

Parameters:

Table 17-34 Parameters

Name	Description
`details`	In case of errors, details are published with the error string
`status`	See Migration Status Codes
`links`	Detailed information about the link
`href`	Links to API call or status API
`action`	The HTTP call type
`rel`	Relationship type
`data`	Parameters as key value pairs passed in the request

Example of Response Body

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

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