スパイラル サポートサイト

powered by SPIRAL PLACE®

HOME > 機能 > ハイレベルAPI>table(一覧表)

table(一覧表)


一覧表は、データーベースのレコードを、一覧形式でウェブページに表示する機能です。 単票は、一覧表に含まれる1件を選択し、詳細情報をウェブページに表示する機能です。APIを利用することで、アクセス権限をマイエリア内に設定された一覧表のデータや単票のURLを取得することが可能です。詳しくは一覧表・単票を参照して下さい。

table/data

 
一覧表のデータを取得します。
○:必須、△:選択必須
 

リクエストパラメータ

 

パラメータ1パラメータ2必須説明文字種長
spiral_api_tokenAPIトークン半角英数字
passkeyepoch秒。APIトークンシークレットとpasskeyで署名を作成する。
署名の有効期限チェックにも使用する。
有効期限は作成してから30分。
int
signature署名半角英数字
jsessionidマイエリアにログインした際のセッションID半角英数大文字
auto_login_cookieマイエリアにログインした際のaluto_login_cookieの値半角英数字記号
my_area_titleマイエリアのタイトル半角英数字, アンスコ, ハイフン 16文字以内
search_title一覧表検索フォームタイトル半角英数字, アンスコ, ハイフン
lines_per_pageページ毎のデータ行数。1〜1000。省略時 = 10int (1以上1000以下)
pageページ番号。省略時 = 1int (1以上)
sortソート条件(省略時は、一覧表のソート条件に準ずる)複数行
nameソート対象フィールドのフィールドタイトルフィールドタイトル
orderソート順序。desc = 降順, asc = 昇順。指定なしで昇順。desc or asc
search_condition検索条件(省略時は、検索条件無し)複数行
name検索条件名。フィールドタイトル(“id”指定可)。
範囲検索の場合は複数行指定する。
フィールドタイトル or “id”
value条件値
exists値の有無。検索フォームに表示した場合のみ有効。
範囲検索などで同一フィールドに複数のオプションが指定された場合、1つ目のみを採用する。
0=全て、2=値なし、3=値あり。
他の検索条件とANDで結び付く(ex.「hogeに完全一致以外」かつ「値あり」)
ex_typevalueに対する一致条件(AND/OR/完全一致、など)
検索フォームに表示した場合のみ有効。
範囲検索などで同一フィールドに複数のオプションが指定された場合、1つ目のみを採用する。
actionvalueおよびex_typeに対する、条件検索か条件以外を検索か。
検索フォームに表示した場合のみ有効。
範囲検索などで同一フィールドに複数のオプションが指定された場合、
1つ目のみを採用する
0=指定条件で検索、1=条件以外を検索
mst_filter_titleマスタとしてフィルターしたい一覧表検索フォームタイトル半角英数字, アンスコ, ハイフン 16文字以内
mst_filter_valueマスタフィルターで使用するマスタDBのidint
terminal_ip_addressエンドユーザ(末端)のIPアドレス。指定したIPアドレスのみアクセスを許可する。IPアドレス仕様

※スパイラルAPIは検索フォームの「複数フィールドの検索」に対応していません。
※一覧表にIPアドレスによるアクセス権限を設定している場合、接続元IPアドレスを指定する必要があります。  

レスポンス

 

パラメータ説明文字種長
code応答コードint
message応答メッセージ半角英数字記号
count全ページの全レコード数(絞り込み後)Int (0以上)
header一覧表ヘッダ。カラム名の配列(例: ['カラム1','カラム2'])
dataデータ本体。2次元配列(データレコード×各フィールド値)。
画像型フィールドのデータは、サムネイル画像のbase64データを返す。
改行は<br/>、<は&lt; >は&gt;、"は\" へエスケープしたJSONデータを返す。
jsessionid有効なセッションのID半角英数字
auto_login_cookie"sessionidが送信されない、もしくは無効なjsessionidが送信された場合で
自動ログインが成功した場合、有効な自動ログイン用のCookieが返される。
半角英数字記号
auto_login_limitauto_login_cookieにより自動ロクインできる有効期限のエポック秒int

table/card


指定したレコードの単票URLを取得する。ただし、レコードの存在を確認しないため、取得したURLが有効なものかは保証されません。
○:必須、△:選択必須

リクエストパラメータ


パラメータ必須説明文字種長
spiral_api_tokenAPIトークン半角英数字
passkeyepoch秒。APIトークンシークレットとpasskeyで署名を作成する。
署名の有効期限チェックにも使用する。有効期限は作成してから30分。
int
signature署名半角英数字
jsessionidマイエリアにログインした際のセッションID半角英数大文字
auto_login_cookieマイエリアにログインした際のaluto_login_cookieの値半角英数字記号
my_area_titleマイエリアのタイトル半角英数字, アンスコ, ハイフン 16文字以内
card_title単票のタイトル半角英数字, アンスコ, ハイフン
ids表示するレコードのレコードID。最大1000件まで。配列。int
terminal_ip_addressエンドユーザ(末端)のIPアドレス。指定したIPアドレスのみアクセスを許可する。IPアドレス仕様
url_typeurlsで返されるurlにjsessionidを含むかどうか選択できる。
0:通常のurl
2:レスポンスのurlにjsessionidが付かない。
指定がない場合や、上記以外の値が指定された場合は、0が使用される。
int (0 or 2)

※一覧表にIPアドレスによるアクセス権限を設定している場合、接続元IPアドレスを指定する必要があります。 

レスポンス


パラメータ説明文字種長
code応答コードint
message応答メッセージ半角英数字記号
urls単票のURL(https://FQDN/area/card/・・・/・・・/M?S=・・・)配列URL仕様
jsessionid有効なセッションのID半角英数字
auto_login_cookiejsessionidが送信されない、もしくは無効なjsessionidが送信された場合で
自動ログインが成功した場合、有効な自動ログイン用のCookieが返される。
半角英数字記号
auto_login_limitauto_login_cookieにより自動ロクインできる有効期限のエポック秒int

フロー・操作画面と各パラメータの関連性


以下はフローにおいて各パラメータが何を指すのかを示しています。

フローとの関連性

以下は操作画面において各パラメータが何を指すのかを示しています。

操作画面との関連性


サンプルプログラム



最終更新日:2019/6/4