« Deleting Ledger Update History   |   Loading Ledger Line Data »

Sweeping Garbage

This manual is in pilot operation.

Overview

This function performs the task of sweeping unnecessary data.

How to Write a Request

Below is an example request for "Sweeping Garbage":

<request type="SWEEP_GARBAGE" desc="Sweep Garbage">
  <parameters>
    <parameter name="LIMIT" value="2000"/> (1)
  </parameters>
  <contents> (2)
  </contents>
</request>
1 "Limit Count" parameter
2 Request Content

Parameters

Specify the maximum number of unnecessary data entries to be swept.

Parameter Required Key Description

LIMIT

No

None

Specifies the maximum number of unnecessary data entries to sweep. If this parameter is omitted, the default limit is 1000.

Request Content

There is no "Request Content."

Response Content

Below is an example response for "Sweeping Garbage":

<response type="SWEEP_GARBAGE" desc="Sweep Garbage">
  <returned-contents> (1)
  </returned-contents>
  <result>
    <code>SUCCESSFUL</code> (2)
    <started-at time-zone="Asia/Tokyo">2015/02/28 09:50:04.227</started-at>
    <ended-at time-zone="Asia/Tokyo">2015/02/28 09:50:07.827</ended-at>
    <messages>
      ... (3)
    </messages>
  </result>
</response>
1 Returned Content
2 Processing Result Code
3 Message

Processing Result Code

If all unnecessary data is swept by the request, SUCCESSFUL is returned. If unnecessary data remains after sweeping up to the specified limit, WARNED is returned. By repeatedly issuing this request until the result is SUCCESSFUL, all unnecessary data can be deleted.

When using the Requester, if the result code is WARNED, the Requester’s exit code becomes 2, which allows batch files to loop based on that result.

Returned Content

There is no returned content.

Message

If the result code is SUCCESSFUL, nothing is displayed in the message field.

If the result code is WARNED, a message is displayed indicating that some unnecessary data remains.

If the result code is FAILED, the message field shows the reason for the failure.

No other result codes are used.