CSVファイルによるテンプレートセット操作

GET /user/:user_code/template/:id/pack/csv

テンプレートセットの情報をCSV形式で取得する

詳細

リクエスト

パラメータ無し

レスポンス

Body

テキスト(CSV)

サンプル

リクエスト

URL
GET https://*.sacm.jp/public-api/v1/user/tsa99990001/template/1/pack/csv

レスポンス

Header
Content-Type: text/csv
Body
[name],[sa_label],HOSTNAME,LAN0ADDRESS,LAN0PREFIX,LAN1ADDRESS
[label],,ホスト名,アドレス0,プレフィックス0,アドレス1
[edit_format],,"{""type"":""text"",""options"":[]}",,,
[edit_enabled],,false,false,false,
[default],,hostname,192.168.0.1,24,172.0.0.1
 tss99990001,拠点1,SEIL/B1 001,192.168.1.1,24,10.0.0.1
 tss99990002,拠点2,SEIL/B1 002,192.168.2.1,24,10.0.0.2
 tss99990003,拠点3,SEIL/B1 003,192.168.3.1,24,10.0.0.3

PUT /user/:user_code/template/:id/pack/csv

テンプレートセットの情報をCSVファイルの内容で変更する

詳細

リクエスト

Header
Content-Type: multipart/form-data
Body

CSVファイル

レスポンス

Header
Content-Type: text/plain
Body
true

サンプル

リクエスト

URL
PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/template/1/pack/csv
Header
Content-Type: multipart/form-data; boundary=----ZrY3KS4TWNvr1gNz
Body
------ZrY3KS4TWNvr1gNz
Content-Disposition: form-data; name="variable-csv-file"; filename="sample.csv"
Content-Type: text/csv

(Binary-data)
------ZrY3KS4TWNvr1gNz--

レスポンス

Header
Content-Type: text/plain
Body
true

テンプレートセットのCSVの書式

ファイルの書式

1 行目

変数定義

[name],[sa_label],connect,interface,ppp_acc,ppp_pass,lan0_addr
1 列目

[name]

  • 固定ヘッダ
2 列目

[sa_label]

  • 固定ヘッダ
  • 列ごと省略可
3~n 列目

変数名

  • 空欄不可
  • 重複不可
  • 上限は200列
  • 変数名の順序は保持される

2 行目

変数ラベル

[label],,表示A,表示B,,,
1 列目

[label]

  • 固定ヘッダ
2 列目

空文字

  • 固定ヘッダ
  • 列ごと省略可
3~n 列目

変数のラベル名

  • 任意の値
  • 空欄許可
  • 上限は200列

3 行目

入力フォーマット

[edit_format],,"{""type"":""text"",""options"":[]}",,,,
1 列目

[edit_format]

  • 固定ヘッダ
2 列目

空文字

  • 固定ヘッダ
  • 列ごと省略可
3~n 列目

変数の入力フォーマット

  • Json フォーマット
  • 空欄許可
  • 上限は200列

4 行目

エンドユーザ向け操作権限の有無

[edit_enabled],,true,false,false,false,false
1 列目

[edit_enabled]

  • 固定ヘッダ
2 列目

空文字

  • 固定ヘッダ
  • 列ごと省略可
3~n 列目

変数のエンドユーザ向け変更操作の有無

  • true or false
  • 空欄許可
  • 上限は200列

5 行目

デフォルト変数値

[default],,pppoe,pppoe0,,,
1 列目

[default]

  • 固定ヘッダ
2 列目

空文字

  • 固定ヘッダ
  • 列ごと省略可
3~n 列目

変数のデフォルト値

  • 任意の値
  • 空欄許可
  • 上限は200列

6~n 行目

サービスアダプタ割当情報 及び サービスアダプタ個別変数値

tss00000001,拠点1,,,,name@example.jp,username,192.168.0.1/24
1 列目

SAコード

  • 記述されていれば割当対象と見なす
  • 重複不可
2 列目

SAラベル

  • 空欄許可
  • 列ごと省略可
  • インポート時に値は無視される
3~n 列目

変数値

  • 任意の値
  • 空欄許可
  • 上限は200列

CSVファイルのイメージ

[name] [sa_label] HOSTNAME LAN0ADDRESS LAN0PREFIX LAN1ADDRESS
[label]   ホスト名 アドレス0 プレフィックス0 アドレス1
[edit_format]          
[edit_enabled]   false false false false
[default]   hostname 192.168.0.1 24 172.0.0.1
tss99990001 拠点1 SEIL/B1 001 192.168.1.1 24 10.0.0.1
tss99990002 拠点2 SEIL/B1 002 192.168.2.1 24 10.0.0.2
tss99990003 拠点3 SEIL/B1 003 192.168.3.1 24 10.0.0.3