PlatioDelete - Platioレコードの削除
Platioアプリケーションのコレクションからレコードを削除します。
Platioビルダーを使ってコレクション プロパティやフィールド定義を取得します。詳細についてはPlatioDleteコンポーネント「Platioビルダーの使い方」を参照してください。
■ストリーム情報
| 入力 | フォーマット | すべて | |||||
|---|---|---|---|---|---|---|---|
| 接続数 | 1 | ||||||
| 説明 | 削除方法 が「キーを指定」の場合はRecordのみ連結できます。入力ストリームのフィールド定義は、Platioビルダーで行います。
このフィールド定義は直前に連結したマッパーの出力ストリームのフィールド定義にコピーされ、そこに対して値のマッピングを行います。そのため、削除方法 が「キーを指定」の場合に連結できるコンポーネントはマッパーのみとなっています。 連結後に削除方法を「キーを指定」へと変更した場合、連結コンポーネントの変更、Platioビルダーによるフィールドの再定義が必要になる場合があります。 削除方法 が「全レコード」「クエリー」の場合には使用されません。 |
||||||
| 出力 | フォーマット | Record | |||||
| 説明 |
次のようなフィールド定義の固定のレコードが出力されます。
|
■コンポーネントプロパティ
| 名前 | プロパティ型 | マッピング | 説明 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| コネクションを使用 | boolean | - |
接続先に以下のコネクション名 を使用するかどうか選択します。
|
|||||||||
| コネクション名 | connection | - | コネクションを使用 が「はい」の場合に、Platioアプリケーションへの接続用コネクションを指定します。
コネクションペインまたは管理コンソールにて作成した接続名を選択します。 |
|||||||||
| コネクション情報 | group | - | コネクションを使用 プロパティが「いいえ」の場合に使用されるプロパティ群です。 | |||||||||
| アプリケーションベースURL | string | 入力＆出力 |
PlatioのアプリケーションベースURLを指定します。
指定するURLは「 https://api.plat.io/v1/[アプリケーションのID] 」の形式で指定します。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 |
|||||||||
| トークンID | string | 入力＆出力 |
Platioの開発者向け情報ページから取得したAPIトークンのトークンIDを指定します。
詳細については下記トピック「APIトークンの取得方法」を参照してください。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 |
|||||||||
| 秘密トークン | password | 入力＆出力 |
Platioの開発者向け情報ページから取得したAPIトークンの秘密トークンを指定します。
詳細については下記トピック「APIトークンの取得方法」を参照してください。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 |
|||||||||
| タイムアウト | int | 入力＆出力 |
Platioアプリケーションへの接続時のタイムアウト値を指定します。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 |
|||||||||
| プロキシ設定を使用 | boolean | - |
管理コンソールで設定したプロキシ設定を使用するかどうかを指定します。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
|
|||||||||
| コレクション | string | 入力＆出力 |
コレクションのIDかコレクションの名前を指定します。
Platioビルダーで選択することができます。 |
|||||||||
| 削除方法 | choice | - | 削除方法を選択します。
|
|||||||||
| 検索条件 | string | 入力＆出力 |
検索条件を指定します。
削除方法 が「クエリー」の場合にこの設定が参照されます。 指定する「レコード検索書式」については、Platioのヘルプを参照してください。 Platioビルダーで「検索可能」なカラムを指定して検索条件を作成することができます。 |
|||||||||
| 検索条件内タイムゾーン | choice | 入力＆出力 | 検索条件 プロパティで指定された$from、$to、$fromTimestamp、$toTimestampの検索条件で使用するタイムゾーンを指定します。
選択項目に無い場合タイムゾーンを入力することも可能です。 削除方法 が「クエリー」の場合にこの設定が参照されます。 |
|||||||||
| 一括削除 | boolean | - |
削除方法を指定します。
「はい」を選択した場合、APIのリクエスト回数を削減できますが、削除したレコードのIDは出力ストリームへと渡されません。
|
|||||||||
| 削除する最大数 | int | 入力＆出力 | 一括削除 で「はい」を選択した場合に、APIのリクエスト１回で削除するレコードの最大数を指定します。
デフォルト値は指定可能な最大値の100,000です。 |
|||||||||
| パラメーター | category | 入力＆出力 |
Platioアプリケーションへの接続時などに使用されるパラメーターを指定します。本プロパティは将来の拡張用のために存在し、基本的に使用することはありません。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 |
■ループ処理
なし。
■トランザクション処理
| コミット | 何もしません。 |
|---|---|
| ロールバック | 何もしません。 |
■エラー処理
| タイプ | パラメーター | エラー処理フロー
へのストリーム | エラー
コード | 説明 |
|---|---|---|---|---|
| APIエラー | 「APIエラーのパラメーター
」
を参照してください。 | コンポーネントの入力ストリーム | 1 |
Platio APIがエラーを返した場合
|
| 接続エラー | なし | コンポーネントの入力ストリーム | 2 | Platioとの通信中にエラーが発生した場合 |
| 3 | Platioとの通信中、もしくは通信前処理でエラーが発生した場合 | |||
| 汎用 | なし | コンポーネントの入力ストリーム | 5 | コネクション名 に指定したコネクションが見つからない場合 |
| 9 | Platioに関連するその他のエラーが発生した場合 |
■「APIエラー」のパラメーター
| No. | 名前 | 説明 |
|---|---|---|
| 1 | ErrorCode | Platio APIのエラーコードが返されます。 |
| 2 | StatusCode | HTTPのステータスコードが返されます。 |
| 3 | ErrorResponse | エラーレスポンスのJSONが返されます。 |
■APIトークンの取得方法
Platio APIを使用するためにはAPIトークンを生成する必要があり、PlatioDeleteコンポーネントは生成したAPIトークンを指定する必要があります。
APIトークンには「トークンID」と「秘密トークン」がありPlatioの「開発者向け情報」ページで生成することができます。
「トークンID」はAPIトークンを生成後、Platioの「開発者向け情報」ページよりいつでも確認することができますが、「秘密トークン」はAPIトークン生成時のみ表示され、その後、値を確認することはできません。
「秘密トークン」はAPIトークン生成時に「クリップボードにコピー」アイコンをクリックしてコピーし保存してください。
■Platio APIリクエスト回数
PlatioDeleteコンポーネントのPlatio APIリスエスト回数は以下のようになります。
| API | 説明 | |
|---|---|---|
| レコードリスト・レコード・ユーザーリスト・アプリケーション定義の取得 |
削除対象のレコード件数、100レコード(*1)ごとにリクエスト回数が増加します。
(*1)Platioアプリケーションのデフォルトの最大値です。 |
|
| レコードの作成・更新・削除 |
削除するレコード数の回数リクエストします。
|
|
「レコードリスト・レコード・ユーザーリスト・アプリケーション定義の取得」：４回
「レコードの作成・更新・削除」：250回
一括削除 で「はい」を指定することでAPIリクエスト回数を劇的に減らすことができます。
例：250レコードのコレクションを全件削除する場合
「レコードリスト・レコード・ユーザーリスト・アプリケーション定義の取得」：１回
「レコードの作成・更新・削除」：１回
※Platio APIは、Platioビルダー使用時にも使用されます。
■Platioビルダーの使い方
Platioビルダーは、コネクション名 で接続できるPlatioアプリケーションからコレクション一覧を取得し、そのコレクションのカラムを入力ストリームのフィールドとして設定する専用ツールです。
●Platioビルダーを起動する
以下のいずれかの操作でPlatioビルダーを起動します。
- PlatioDeleteコンポーネントをダブルクリック
- PlatioDeleteコンポーネントを右クリックして表示されるメニューから「Platioビルダー」をクリック
●コネクションの選択
コネクションを使用 で「はい」を設定し、コネクション名 が設定されていない場合、Platioビルダー起動時にコネクションダイアログが表示されます。
新規にコネクションを作成する場合は「新規コネクション」を選択してください。
既存のコネクションを使用する場合は「名前」のプルダウンリストより使用するコネクション名を選択してください。選択したコネクションを使用してPlatioアプリケーションへ接続します。
●新規コネクションの作成
「新規コネクション」を選択した場合「コネクションの作成」ダイアログが表示されますので、作成するコネクション名を入力し「OK」ボタンをクリックしてください。
コネクションのプロパティ入力するダイアログが表示されますので、コネクションの各プロパティを設定し「保存」ボタンをクリックしてください。
注意
この時点で新規コネクションが保存されます。作成したコネクションでPlatioアプリケーションへ接続します。
１. Platioビルダーの画面（削除方法が「全レコード」の場合）
- (1)画面上部：アプリケーションへの接続情報と「削除方法」を表示する領域
- (2)画面下：コレクション一覧を表示する領域
●削除方法を指定する
(1)の削除方法プルダウンリストから「全レコード」を選択します。
●全レコードを削除するコレクションを指定する
(2)のコレクション一覧から全レコードを削除するコレクションを選択します。
●保存する
「保存」ボタンをクリックします。
２. Platioビルダーの画面（削除方法が「キーを指定」の場合）
- (1)画面上部：アプリケーションへの接続情報と「削除方法」を表示する領域
- (2)画面左：コレクション一覧を表示する領域
- (3)画面右：フィールド一覧を表示する領域
●削除方法を指定する
(1)の削除方法プルダウンリストから「キーを指定」を選択します。
●レコードを削除するコレクションを指定する
(2)のコレクション一覧からレコードを削除するコレクションを選択します。
●削除のキーにするフィールドを指定する
(2)のコレクション一覧からコレクションを選択すると(3)に選択されたコレクションのフィールド一覧が表示されます。フィールド一覧でキーチェックボックスをオンにします。指定したフィールドを取り消すには、チェックボックスをオフにします。
キーに指定されたフィールドの値で検索されたレコードを削除します。検索されたレコードが複数レコードの場合、それらすべてのレコードを削除します。
キーに指定できるフィールドには、Platioの「検索可能」なカラム以外に「_RecordId」「$from」「$to」「$fromTimestamp」「$toTimestamp」「$timezone」があります。キーに「$from」「$to」「$fromTimestamp」「$toTimestamp」を指定した場合、直前のマッパーでは検索で使用する日時の文字列をマッピングします。日時の文字列にミリ秒を含めたい場合は、YYYY-MM-DD'T'HH:mm:ss.SSS'Z'形式の日時の文字列をマッピングします。この場合、タイムゾーンはUTCとなります。
例：「$from」の値に「2017-01-13」を設定した場合
検索条件「$from:2017-01-13」でレコードの更新時刻による検索を指定することになります。
「$timezone」は「$from」「$to」「$fromTimestamp」「$toTimestamp」を指定した場合にUTC以外のタイムゾーンを指定したい場合に使用します。
キーに「_RecordId」を指定した場合、対象のレコードが１つ特定されますので、他のキーを指定したとしても使用されません。
●保存する
「保存」ボタンをクリックします。
３. Platioビルダーの画面（削除方法が「クエリー」の場合）
- (1)画面上部：アプリケーションへの接続情報と「削除方法」を表示する領域
- (2)画面左：コレクション一覧を表示する領域
- (3)画面中央：フィールド一覧を表示する領域
- (4)画面右上：検索条件を指定する領域
- (5)画面右下：取得条件のオプションとして設定するプロパティを表示する領域
●削除方法を指定する
(1)の削除方法プルダウンリストから「クエリー」を選択します。
●レコードを削除するコレクションを指定する
(2)のコレクション一覧からレコードを削除するコレクションを選択します。
●検索条件
検索条件を指定する
(3)のフィールド一覧でフィールドをクリックし、右クリックして表示されるメニューから「検索条件へ追加」を選択します。
(4)に指定したフィールドを選択した検索条件の行が追加されます。追加された行で演算子を選択し、値を入力します。
検索条件に指定できる名前は、「検索可能」なカラム名の他に「$from」「$to」「$fromTimestamp」「$toTimestamp」があります。これらの検索条件はレコードの更新時刻やレコードのタイムスタンプで検索する場合に使用します。
「$from」「$to」「$fromTimestamp」「$toTimestamp」で使用できる演算子は「:」のみとなります。
例：2017年1月13日の0時よりも新しい（この時刻を含む）レコード
$from:2017-01-13例：2016年10月3日の15時よりも古い（この時刻を含まない）レコード
$to:2016-10-03T15:00:00
検索条件を編集する
(4)の条件一覧で編集する条件を直接編集します。
検索条件を削除する
(4)の条件一覧で削除する条件をクリックし、右クリックして表示されるメニューから「検索条件削除」を選択します。 (4)から指定した条件が削除されます。
●取得条件オプション
タイムゾーンを指定する
(5)で、(4)の検索条件で日時を扱う場合に使用するタイムゾーンを選択します。
●保存する
「保存」ボタンをクリックします。