View
概要¶
APIやサーバスクリプトでレコードを操作する際に、フィルタやソートを指定するJSON形式のデータレイアウトです。
データレイアウト¶
| 項目名/種類 | プロパティ名 | データ型 | 備考 |
|---|---|---|---|
| 未完了 | Incomplete | 真偽値 | |
| 自分 | Own | 真偽値 | |
| 期限が近い | NearCompletionTime | 真偽値 | |
| 遅延 | Delay | 真偽値 | |
| 期限超過 | Overdue | 真偽値 | |
| 検索 | Search | 文字列 | |
| 列フィルタ | ColumnFilterHash | オブジェクト(文字列) | |
| 列フィルタ検索タイプ | ColumnFilterSearchTypes | 列挙型 | |
| 否定 | ColumnFilterNegatives | 配列(文字列) | 本プロパティを使用する場合は否定フィルタを使用するを有効化する必要があります。また、ユーザ、グループ、組織を選択肢に設定している項目には使用できません。 |
| ソート | ColumnSorterHash | オブジェクト(文字列) | |
| - | ApiDataType | 列挙型 | |
| - | ApiColumnKeyDisplayType | 列挙型 | 本プロパティは、ApiDataTypeが"KeyValues"の場合のみ有効になります。 |
| - | ApiColumnValueDisplayType | 列挙型 | 本プロパティは、ApiDataTypeが"KeyValues"の場合のみ有効になります。 |
| - | ApiColumnHash | オブジェクト(文字列) | 本プロパティは、ApiDataTypeが"KeyValues"の場合のみ有効になります。 |
| - | GridColumns | 配列(文字列) | 本プロパティは、ApiDataTypeが"KeyValues"の場合のみ有効になります。 |
| - | MergeSessionViewFilters | 真偽値 | 値が真の場合、APIで指定したフィルタ条件とセッションに存在するフィルタ条件をマージします。同じフィルタ条件が存在する場合APIで指定したフィルタ条件を優先します。 値が偽の場合、セッションに存在するフィルタ条件はマージしません。 本プロパティの省略時の初期設定値は偽です。 |
| - | MergeSessionViewSorters | 真偽値 | 値が真の場合、APIで指定したソート条件とセッションに存在するソート条件をマージします。同じソート条件が存在する場合APIで指定したソート条件を優先します。 値が偽の場合、セッションに存在するソート条件はマージしません。 本プロパティの省略時の初期設定値は偽です。 |
利用方法¶
ColumnFilterおよびApiDataTypeの利用方法は、下記を参照してください。
開発者ガイド：JSONデータレイアウト：View：ColumnFilterの指定方法
開発者ガイド：JSONデータレイアウト：View：ApiDataTypeの指定方法
一覧画面で指定したフィルタをそのまま使う¶
一覧画面で指定したフィルタやソートの条件は、「共通機能：フィルタ付きURLのコピー」でコピーしたURLの「View」に、本ページのデータレイアウトと同じJSON形式で含まれています。このJSONは、API・スクリプト・サーバスクリプトの「View」にそのまま指定できます。
- 一覧画面で「フィルタ」や「ビュー」を指定します。
- 「URLコピー」ボタンをクリックします。
- コピーしたURLから「View=」以降の値を取り出し、URLデコードします。
- デコードしたJSONを、リクエストの「View」に指定します。
URL内の「View」の値はパーセントエンコードされています。デコードせずに貼り付けると、正しく解釈されません。
また、値を設定していないプロパティはURLに出力されません。URLに現れないプロパティは、リクエスト側で必要に応じて追加してください。
制限事項¶
使用するデータベースによって検索結果が異なる場合があります。
- SQL Server：LIKE句またはフルテキスト検索が使用されます。
- PostgreSQL：ILIKE句またはpg_trgmによるフルテキスト検索が使用されます。