検索

GET /home/search/usercode

マネージメントコードが完全一致するサービスアダプタの一覧を取得する

詳細

リクエスト

Body

Key

Type

Value

q

String

検索キー (必須)

  • マネージメントコード(完全一致)

レスポンス

検索結果一覧 を参照

サンプル

リクエスト

  • URL

    GET https://*.sacm.jp/public-api/v1/home/search/usercode?q=tsa99990001
    

レスポンス

  • Response Header

    Content-Type: application/json
    
  • Response Body

    {
      "results": [
        {
          "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
          "saCode": "tss99990001",
          "saName": "SEIL/B1 001",
          "up": true,
          "userCode": "tsa99990001",
          "userName": "API Sample Inc."
        }
      ]
    }
    

備考

  • 一致する内容が存在しない場合はレスポンスとして空の配列(Array)が返却される

GET /home/search/username

マネージメントラベルが部分一致するサービスアダプタの一覧を取得する

詳細

リクエスト

Body

Key

Type

Value

q

String

検索キー (必須)

  • マネージメントラベル(部分一致)

レスポンス

検索結果一覧 を参照

サンプル

リクエスト

URL
GET https://*.sacm.jp/public-api/v1/home/search/username?q=%E3%82%B5%E3%83%B3%E3%83%97%E3%83%AB

レスポンス

Body
{
  "results": [
    {
      "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
      "saCode": "tss99990001",
      "saName": "SEIL/B1 001",
      "up": true,
      "userCode": "tsa99990001",
      "userName": "API Sample Inc."
    }
  ]
}

備考

  • 一致する内容が存在しない場合はレスポンスとして空の配列(Array)が返却される

  • 検索キーはURLエンコードする必要がある (例: "%E3%82%B5%E3%83%B3%E3%83%97%E3%83%AB" = "サンプル")

  • 検索結果の件数の上限は 1000 件までとなる

GET /home/search/sacode

SAコードが完全一致するサービスアダプタを取得する

詳細

リクエスト

Body

Key

Type

Value

q

String

検索キー (必須)

  • SAコード(完全一致)

レスポンス

検索結果一覧 を参照

リクエスト

URL
GET https://*.sacm.jp/public-api/v1/home/search/sacode?q=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,
      "userCode": "tsa99990001",
      "userName": "API Sample Inc."
    }
  ]
}

備考

  • 一致する内容が存在しない場合はレスポンスとして空の配列(Array)が返却される

GET /home/search/saname

SAラベルが部分一致するサービスアダプタの一覧を取得する

詳細

リクエスト

Body

Key

Type

Value

q

String

検索キー (必須)

  • SAラベル(部分一致)

レスポンス

検索結果一覧 を参照

サンプル

リクエスト

URL
GET https://*.sacm.jp/public-api/v1/home/search/saname?q=SEIL%2FB1+001

レスポンス

Header
Content-Type: application/json
Body
{
  "results": [
    {
      "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
      "saCode": "tss99990001",
      "saName": "SEIL/B1 001",
      "up": true,
      "userCode": "tsa99990001",
      "userName": "API Sample Inc."
    }
  ]
}

備考

  • 一致する内容が存在しない場合はレスポンスとして空の配列(Array)が返却される

  • 検索キーはURLエンコードする必要がある (例: "SEIL%2FB1+001" = "SEIL/B1 001")

  • 検索結果の件数の上限は 1000 件までとなる

GET /home/search/distid

Distribution IDが完全一致、または下 16 桁ブロックで部分一致するサービスアダプタの一覧を取得する

詳細

リクエスト

Body

Key

Type

Value

q

String

検索キー (必須)

  • Distribution ID(完全一致)

レスポンス

検索結果一覧 を参照

サンプル

リクエスト

URL
GET https://*.sacm.jp/public-api/v1/home/search/distid?q=0001-0000-0101-0000-0000-0000-1234-5678

レスポンス

Header
Content-Type: application/json
Body
{
  "results": [
    {
      "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
      "saCode": "tss99990001",
      "saName": "SEIL/B1 001",
      "up": true,
      "userCode": "tsa99990001",
      "userName": "API Sample Inc."
    }
  ]
}

備考

  • 一致する内容が存在しない場合はレスポンスとして空の配列(Array)が返却される

  • 部分一致での検索の場合、検索結果の件数の上限は 1000 件までとなる

GET /home/search/report-status

接続状態が一致するサービスアダプタの一覧を取得する

詳細

リクエスト

Body

Key

Type

Value

q

String

接続状態 (必須)

up

接続中

down

切断中

レスポンス

検索結果一覧 を参照

サンプル

リクエスト

URL
GET https://*.sacm.jp/public-api/v1/home/search/report-status?q=up

レスポンス

Header
Content-Type: application/json
Body
{
  "results": [
    {
      "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
      "saCode": "tss99990001",
      "saName": "SEIL/B1 001",
      "up": true,
      "userCode": "tsa99990001",
      "userName": "API Sample Inc."
    }
  ]
}

備考

  • 一致する内容が存在しない場合はレスポンスとして空の配列(Array)が返却される

  • Distribution ID が未割当の SA は検索の対象外となる

  • 検索結果の件数の上限は 1000 件までとなる

GET /home/search/module-version

モジュールバージョンが一致するサービスアダプタの一覧を取得する

詳細

リクエスト

Body

Key

Type

Value

vendor

String

ベンダー (必須)

ベンダーコードの10進数の番号

satype

String

SA タイプ (必須)

SAの10進数の番号

module

String

モジュール (必須)

モジュールの番号

version

String

バージョン (必須)

モジュールのバージョン (X.X.X-X)

op

String

比較演算子 (必須)
eq

指定されたバージョンと等しい

ge

指定されたバージョン以上

le

指定されたバージョン以下

config

String

コンフィグ種別 (必須) (カンマ区切りで複数選択可能)
working

作業コンフィグ

startup

次回起動時コンフィグ

running

動作コンフィグ

レスポンス

Key

Type

Value

results

Array

検索結果の一覧

saCode String

SAコード

saName String

SAラベル

distributionId String

Distribution ID

configState String

コンフィグ反映状態

initial

コンフィグ未取得または同期無し

pulled

コンフィグ取得済み

pushready

操作・コンフィグ有効

pushed

コンフィグ操作中

pushconfirming

操作用接続確認中

up boolean

接続中かどうか

userCode String

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

userName String

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

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

サンプル

リクエスト

URL
GET https://*.sacm.jp/public-api/v1/home/search/module-version?vendor=0&module=0&satype=15&version=7.7.0-0&op=eq&config=startup,working,running

レスポンス

Header
Content-Type: application/json
Body
{
  "results": [
    {
      "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
      "saCode": "tss99990001",
      "saName": "SEIL/B1 001",
      "up": true,
      "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)"
          }
        ]
      }
    }
  ]
}

備考

  • 一致する内容が存在しない場合はレスポンスとして空の配列(Array)が返却される

  • 検索結果の件数の上限は 1000 件までとなる

共通パラメータ

検索結果一覧

Key

Type

Value

results

Array

検索結果の一覧

saCode String

SAコード

saName String

SAラベル

distributionId String

Distribution ID

configState String

コンフィグ反映状態

initial

コンフィグ未取得または同期無し

pulled

コンフィグ取得済み

pushready

操作・コンフィグ有効

pushed

コンフィグ操作中

pushconfirming

操作用接続確認中

up boolean

接続中かどうか

userCode String

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

userName String

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

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

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

Key

Type

Value

results

Array

モジュール一覧

moduleId int

モジュールID

moduleName String

モジュール名

version String

モジュールバージョン