« 元帳更新履歴の削除   |   元帳行データのロード »

不要データの整理

機能概要

不要データを整理します。

リクエストの記述方法

「不要データの整理」のリクエスト記述例を以下に示します。

<request type="SWEEP_GARBAGE" desc="不要データ削除">
  <parameters>
    <parameter name="LIMIT" value="2000"/> (1)
  </parameters>
  <contents> (2)
  </contents>
</request>
1 「上限件数」パラメタ
2 リクエスト内容

パラメタ

対象アプリケーションと対象元帳版を指定します。

パラメタ 必須 キー 指定内容

LIMIT

No

なし

整理する不要データの上限件数を指定します。当パラメータを省略した場合、上限件数は 1000 とされます。

リクエスト内容

「リクエスト内容」はありません。

レスポンスの内容

「世代別元帳行データの圧縮」のレスポンス例を以下に示します。

<response type="SWEEP_GARBAGE" desc="不要データ削除">
  <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 返却内容
2 処理結果コード
3 メッセージ

処理結果コード

リクエストの処理によりすべての不要データが整理された場合、SUCCESSFUL が返されます。リクエストで指定された上限件数分の不要データを整理しても、まだ不要データが残っている場合には、WARNED が返されます。処理結果が SUCCESSFUL となるまで繰り返し当リクエストを要求することによって、すべての不要データを削除することができます。

なお、リクエスタを使用している場合、処理結果コードが WARNED ならば、リクエスタの終了コードが 2 となるため、バッチファイル上でそれを判定して繰り返し処理を記述することができます。

返却内容

返却内容はありません。

メッセージ

処理結果コードが「SUCCESSFUL」の場合、メッセージ欄には何もが表示されません。

処理結果コードが「WARNED」の場合、未整理の不要データがある旨のメッセージが表示されます。

処理結果コードが「FAILED」の場合、メッセージ欄には、処理が失敗した原因を表すメッセージが表示されます。

上記以外の処理結果コードは使用されません。