テーブルエクスポートAPIの機能仕様です。
APIを使用して指定したテーブルのエクスポートを行うことができます。
■事前準備
APIの操作を行う前にAPIキーの作成を実施してください。
■URL
下記のURLを使用します。
{SiteId}はレコードを作成するテーブルのサイトIDに置換してください。
https://ks01.shelterdb.net/api/items/{SiteId}/export
■リクエスト(標準のエクスポート設定でテーブルをエクスポートする)
HTTP POSTで下記の形式のjsonデータを送信してください。
Content-Type は'application/json'、文字コードはUTF-8を使用してください。
{
"ApiVersion": 1.1,
"ApiKey": "XXXXXXXXXX..."
}
■リクエスト(Shelterで作成済みのエクスポート設定を使用してテーブルをエクスポートする)
「テーブルの管理」の「エクスポート」タブにて作成したエクスポート設定を使用してエクスポートを
行うことができます。
設定ファイルのJSONにて、APIキーの他に作成したエクスポート設定のIDを指定します。
{
"ApiVersion": 1.1,
"ApiKey": "XXXXXXXXXX...",
"ExportId": 1
}
■リクエスト(エクスポートの設定を設定ファイルに直接記述してテーブルをエクスポートする)
{
"ApiVersion": 1.1,
"ApiKey": "XXXXXXXXXX...",
"Export": {
"Name": "テストA-1",
"Columns": [
{
"ColumnName": "ResultId"
},
{
"ColumnName": "Title"
}
],
"Header": false,
"Type": "csv"
}
}
- Name: エクスポート設定の名前
- Columns: 出力対象となる項目の項目名
- Header: 出力するCSVにヘッダ行を追加するか否かの設定です
- Type: 出力するファイルの種類を指定します。指定できるのは「csv」と「json」の2種類です。
■リクエスト(取得するレコードの絞り込みや並び順を指定してエクスポートする)
{
"ApiVersion": 1.1,
"ApiKey": "XXXXXXXXXX...",
"ExportId": 1,
"View": {
"ColumnSorterHash": {
"Title": "Desc"
},
"ColumnFilterHash": {
"Owner" : "[1]"
}
}
}
■レスポンス
下記の形式のjsonデータが返却されます。
{
"StatusCode": 200,
"LimitPerDate":10000,
"LimitRemaining": 9990,
"Response": {
"Name": "期限付きテーブル_20xx_xx_xx xx_xx_xx.Csv",
"Content": "\"ID\",\"タイトル\",\"内容\",\"タイトル/内容\",\"コメント\"....
}
}
※"Content"内の\
表記はバックスラッシュです。