データ抽出¶

GET /home/extract/search¶

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

詳細¶

リクエスト¶

クエリパラメータ¶

共通リクエストを参照

レスポンス¶

Body¶

Key

Type

Value

results

Array

検索結果の一覧

saCode String
SAコード

saName String
SAラベル

distributionId String
Distribution ID

up boolean
接続中かどうか

type int
サービスアダプタの種別

0
通常のサービスアダプタ(tss)

1
レシピ対応のサービスアダプタ(tsw)

mode String
レシピ対応のサービスアダプタのレシピコード (通常のサービスアダプタの場合は null)

userCode String
サービスアダプタを管理しているマネージメントコード

userName String
サービスアダプタを管理しているマネージメントラベル

startup Object

次回起動時コンフィグのモジュール一覧

コンフィグ毎のモジュール一覧を参照

running Object

動作コンフィグのモジュール一覧

コンフィグ毎のモジュール一覧を参照

コンフィグ毎のモジュール一覧¶

モジュールIDが0のみを返却する

Key

Type

Value

results

Array

モジュール一覧

moduleId int
モジュールID

moduleName String
モジュール名

version String
モジュールバージョン

サンプル¶

リクエスト¶

URL

GET https://*.sacm.jp/public-api/v1/home/extract/search?status=up,down&target=sa_code&word=tss99990001

レスポンス¶

Header¶

Content-Type: application/json

Body¶

{
  "results": [
    {
      "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
      "saCode": "tss99990001",
      "saName": "SEIL/B1 001",
      "up": true,
      "type": 0,
      "mode": null,
      "userCode": "tsa99990001",
      "userName": "API Sample Inc.",
      "startup": {
        "results": [
          {
            "moduleId": 0,
            "version": "7.7.0-0",
            "moduleName": "SEIL/B1 7.70 (Release)"
          }
        ]
      },
      "running": {
        "results": [
          {
            "moduleId": 0,
            "version": "7.7.0-0",
            "moduleName": "SEIL/B1 7.70 (Release)"
          }
        ]
      }
    }
  ],
  "totalCount": 1,
  "offset": 0,
  "limit": 1000
}

備考¶

一致する内容が存在しない場合はレスポンスとして空の配列(Array)が返却される
抽出キーはURLエンコードする必要がある (例: "%E3%82%B5%E3%83%B3%E3%83%97%E3%83%AB" = "サンプル")
抽出結果の件数の上限は 1000 件までとなる
totalCount, offset, limit はクエリパラメータに offset または limit が指定された場合に返却される

GET /home/extract/csv¶

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

詳細¶

リクエスト¶

クエリパラメータ¶

Key	Type	Value
url	String	「データ抽出」タブの URL (オプション)

他は共通リクエストを参照

レスポンス¶

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¶

URL の指定なし

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],[startup_module],[running_module]
tsaXXXXXXXX,(株)エスエーシーエム,tssXXXXXXXX,SEIL/B1,,SEIL/B1 X.XX (Release),SEIL/B1 X.XX (Release)
tsaXXXXXXXX,(株)エスエーシーエム,tssXXXXXXXX,SEIL/X1,XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX,,SEIL/X1 X.XX (Release),SEIL/X1 X.XX (Release)
tsaXXXXXXXX,(株)エスエーシーエム,tswXXXXXXXX,SA-W1-001,XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX,RXXXX,SA-W1 X.XX (Release),SA-W1 X.XX (Release)
tsaXXXXXXXX,(株)エスエーシーエム,tswXXXXXXXX,SA-W1-002,XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX,RXXXX,SA-W1 X.XX (Release),SA-W1 X.XX (Release)

URL の指定あり

https://*.sacm.jp/**/ui/#partner/extract/?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],[startup_module],[running_module]
tsaXXXXXXXX,(株)エスエーシーエム,tssXXXXXXXX,SEIL/B1,,SEIL/B1 X.XX (Release),SEIL/B1 X.XX (Release)
tsaXXXXXXXX,(株)エスエーシーエム,tssXXXXXXXX,SEIL/X1,XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX,,SEIL/X1 X.XX (Release),SEIL/X1 X.XX (Release)
tsaXXXXXXXX,(株)エスエーシーエム,tswXXXXXXXX,SA-W1-001,XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX,RXXXX,SA-W1 X.XX (Release),SA-W1 X.XX (Release)
tsaXXXXXXXX,(株)エスエーシーエム,tswXXXXXXXX,SA-W1-002,XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX,RXXXX,SA-W1 X.XX (Release),SA-W1 X.XX (Release)

備考¶

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

データ抽出のCSVの書式¶

ファイルの書式¶

1 行目¶

パラメータ (URL の指定なし)

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

パラメータ (URL の指定あり)

https://*.sacm.jp/**/ui/#partner/extract/?word=エスエーシーエム&target=sa_label,user_label,sa_code,user_code&status=up,down,not_mapped

1 列目¶

URL の指定なし
- query: 抽出条件
  - query: は固定文字
  - パラメータは「共通リクエスト」を参照
URL の指定あり
- https://*.sacm.jp/**/ui/#partner/extract/?抽出条件
  - https://*.sacm.jp/**/ui/#partner/extract/ は「データ抽出」タブの URL
  - パラメータは「共通リクエスト」を参照

2 行目¶

固定ヘッダ一覧

[user_code],[user_label],[sa_code],[sa_label],[distribution_id],[recipe],[startup_module],[running_module]

1 列目¶

[user_code]

固定ヘッダ

2 列目¶

[user_label]

固定ヘッダ

3 列目¶

[sa_code]

固定ヘッダ

4 列目¶

[sa_label]

固定ヘッダ

5 列目¶

[distribution_id]

固定ヘッダ

6 列目¶

[recipe]

固定ヘッダ

7 列目¶

[startup_module]

固定ヘッダ

8 列目¶

[running_module]

固定ヘッダ

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

7 列目¶

次回起動時コンフィグのモジュールバージョン

SA-W1 X.XX (Release)

8 列目¶

動作コンフィグのモジュールバージョン

SA-W1 X.XX (Release)

CSVファイルのイメージ¶

URL の指定なし

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]	[startup_module]	[running_module]
tsaXXXXXXXX	(株)エスエーシーエム	tssXXXXXXXX	SEIL/B1			SEIL/B1 X.XX(Release)	SEIL/B1 X.XX(Release)
tsaXXXXXXXX	(株)エスエーシーエム	tssXXXXXXXX	SEIL/X1	XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX		SEIL/X1 X.XX(Release)	SEIL/X1 X.XX(Release)
tsaXXXXXXXX	(株)エスエーシーエム	tswXXXXXXXX	SA-W1-001	XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX	RXXXX	SA-W1 X.XX(Release)	SA-W1 X.XX(Release)
tsaXXXXXXXX	(株)エスエーシーエム	tswXXXXXXXX	SA-W1-001	XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX	RXXXX	SA-W1 X.XX(Release)	SA-W1 X.XX(Release)

URL の指定あり

https://.sacm.jp/*/ui/#partner/extract/?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]	[startup_module]	[running_module]
tsaXXXXXXXX	(株)エスエーシーエム	tssXXXXXXXX	SEIL/B1			SEIL/B1 X.XX(Release)	SEIL/B1 X.XX(Release)
tsaXXXXXXXX	(株)エスエーシーエム	tssXXXXXXXX	SEIL/X1	XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX		SEIL/X1 X.XX(Release)	SEIL/X1 X.XX(Release)
tsaXXXXXXXX	(株)エスエーシーエム	tswXXXXXXXX	SA-W1-001	XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX	RXXXX	SA-W1 X.XX(Release)	SA-W1 X.XX(Release)
tsaXXXXXXXX	(株)エスエーシーエム	tswXXXXXXXX	SA-W1-001	XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX	RXXXX	SA-W1 X.XX(Release)	SA-W1 X.XX(Release)

共通パラメータ¶

共通リクエスト¶

クエリパラメータ¶

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 動作コンフィグ
sort	String	並び順 (オプション) user_code_asc String マネージメントコード順 (昇順) user_code_desc String マネージメントコード順 (降順) sa_code_asc String SAコード順 (昇順) sa_code_desc String SAコード順 (降順) sa_id_asc String SA作成順 (昇順) sa_id_desc String SA作成順 (降順)
limit	String	抽出結果の取得件数 (オプション) 抽出は最大 1000 CSVは最大 10000
offset	String	抽出結果の開始位置 (オプション) 最小 0

SACM service manual

データ抽出¶

GET /home/extract/search¶

詳細¶

リクエスト¶

クエリパラメータ¶

レスポンス¶

Header¶

Body¶

コンフィグ毎のモジュール一覧¶

サンプル¶

リクエスト¶

レスポンス¶

Header¶

Body¶

備考¶

GET /home/extract/csv¶

詳細¶

リクエスト¶

クエリパラメータ¶

レスポンス¶

Header¶

Body¶

サンプル¶

リクエスト¶

レスポンス¶

Header¶

Body¶

備考¶

データ抽出のCSVの書式¶

ファイルの書式¶

1 行目¶

1 列目¶

2 行目¶

1 列目¶

2 列目¶

3 列目¶

4 列目¶

5 列目¶

6 列目¶

7 列目¶

8 列目¶

3～n 行目¶

1 列目¶

2 列目¶

3 列目¶

4 列目¶

5 列目¶

6 列目¶

7 列目¶

8 列目¶

CSVファイルのイメージ¶

共通パラメータ¶

共通リクエスト¶

クエリパラメータ¶

目次

前のトピックへ

次のトピックへ