データ抽出

GET /home/extract/csv

抽出条件に一致するサービスアダプタの一覧を取得する

詳細

リクエスト

Body

共通リクエスト を参照

レスポンス

Header
Content-Type: text/csv
Body

テキスト(CSV)

サンプル

リクエスト

  • URL

    GET https://*.sacm.jp/public-api/v1/home/extract/csv?word=%E3%82%A8%E3%82%B9%E3%82%A8%E3%83%BC%E3%82%B7%E3%83%BC%E3%82%A8%E3%83%A0&target=sa_label,user_label,sa_code,user_code&status=up,down,not_mapped
    

レスポンス

Header
Content-Type: text/csv
Body
query: word=エスエーシーエム&target=sa_label,user_label,sa_code,user_code&status=up,down,not_mapped
[user_code],[user_label],[sa_code],[sa_label],[distribution_id],[recipe]
tsaXXXXXXXX,(株)エスエーシーエム,tssXXXXXXXX,SEIL/B1,,
tsaXXXXXXXX,(株)エスエーシーエム,tssXXXXXXXX,SEIL/X1,XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX,
tsaXXXXXXXX,(株)エスエーシーエム,tswXXXXXXXX,SA-W1-001,XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX,RXXXX
tsaXXXXXXXX,(株)エスエーシーエム,tswXXXXXXXX,SA-W1-002,XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX,RXXXX

備考

  • 抽出キーはURLエンコードする必要がある (例: “%E3%82%B5%E3%83%B3%E3%83%97%E3%83%AB” = “サンプル”)
  • CSV件数の上限は 10000 件までとなる

データ抽出のCSVの書式

ファイルの書式

1 行目

パラメータ

query: word=エスエーシーエム&target=sa_label,user_label,sa_code,user_code&status=up,down,not_mapped
1 列目

query: 抽出条件

2 行目

固定ヘッダ一覧

[user_code],[user_label],[sa_code],[sa_label],[distribution_id],[recipe]
1 列目

[user_code]

  • 固定ヘッダ
2 列目

[user_label]

  • 固定ヘッダ
3 列目

[sa_code]

  • 固定ヘッダ
4 列目

[sa_label]

  • 固定ヘッダ
5 列目

[distribution_id]

  • 固定ヘッダ
6 列目

[recipe]

  • 固定ヘッダ

3~n 行目

マネージメント情報 及び サービスアダプタ情報

tsaXXXXXXXX,(株)エスエーシーエム,tswXXXXXXXX,SA-W1-001 ,XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX,RXXXX
1 列目

マネージメントコード

tsaXXXXXXXX
2 列目

マネージメントラベル

(株)エスエーシーエム
3 列目

SAコード

tswXXXXXXXX
4 列目

SAラベル

SA-W1-001
5 列目

Distribution ID

XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
6 列目

レシピコード

RXXXX

CSVファイルのイメージ

query: word=エスエーシーエム&target=sa_label,user_label,sa_code,user_code&status=up,down,not_mapped
[user_code] [user_label] [sa_code] [sa_label] [distribution_id] [recipe]
tsaXXXXXXXX (株)エスエーシーエム tssXXXXXXXX SEIL/B1    
tsaXXXXXXXX (株)エスエーシーエム tssXXXXXXXX SEIL/X1 XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX  
tsaXXXXXXXX (株)エスエーシーエム tswXXXXXXXX SA-W1-001 XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX RXXXX
tsaXXXXXXXX (株)エスエーシーエム tswXXXXXXXX SA-W1-001 XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX RXXXX

共通パラメータ

共通リクエスト

Body

Key Type Value
word String 抽出キー (オプション)
target String
抽出キーの対象 (オプション) 複数指定可能
sa_coode String
SAコード(部分一致)
user_code String
マネージメントコード (部分一致)
sa_label String
SAラベル (部分一致)
user_label String
マネージメントラベル (部分一致)
status String
接続状態 (必須) 複数指定可能
up String
接続中
down String
切断中
not_mapped String
未割当
device_type String
抽出する機種のタイプ (オプション)
device String
機種別
module-version String
モジュールバージョン
device_code String
機種コード (device_type が device の場合必須) 複数指定可能
XXXX-XXXX-XXXX-XXXX String
Distribution ID の始めから16桁の16進数
vendor String
ベンダー (device_type が module-version の場合必須)
0 String
ベンダーコードの10進数の番号
satype String
SAタイプ (device_type が module-version の場合必須)
0 String
SAの10進数の番号
module String
モジュール (device_type が module-version の場合必須)
0 String
モジュールの番号
version String
バージョン (device_type が module-version の場合必須)
X.X.X-X String
バージョン
op String
オペレーション (device_type が module-version の場合必須)
eq String
指定されたバージョンと等しい
ge String
指定されたバージョン以上
le String
指定されたバージョン以下
config String
コンフィグ種別 (device_type が module-version の場合必須)
working String
作業コンフィグ
startup String
次回起動時コンフィグ
running String
動作コンフィグ