テンプレート変数(テンプレートセット起点)

GET /user/:user_code/template/:id/variable

テンプレート変数の一覧情報を取得する

詳細

リクエスト

パラメータ無し

レスポンス

Body

Key

Type

Value

results

Array

変数の一覧

name String

変数名

defaultValue String

変数のデフォルト値

dispName String

変数ラベル

editFormat Object
入力フォーマット
type String

入力タイプ (text or select)

options Array
入力タイプが選択式のオプション
label String

プルダウンのラベル

value String

プルダウンの変数値

liteEditEnabled boolean

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

サンプル

リクエスト

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

レスポンス

Body
{
  "results": [
    {
      "name": "HOSTNAME",
      "defaultValue": "",
      "dispName": "ホスト名",
      "editFormat": {
          "type": "text",
          "options": []
      }
      "liteEditEnabled": false
    },
    {
      "name": "LAN0PREFIX",
      "defaultValue": "24",
      "dispName": "LAN0 プレフィックス",
      "editFormat": {
          "type": "select",
          "options": [
              {
                  "label": "23",
                  "value": "23"
              },
              {
                  "label": "24",
                  "value": "24"
              }
          ]
      },
      "liteEditEnabled": false
    },
    {
      "name": "LAN0ADDRESS",
      "defaultValue": "192.168.0.1"
      "dispName": null,
      "editFormat": {
          "type": null,
          "options": null
      },
      "liteEditEnabled": false
    }
  ]
}

POST /user/:user_code/template/:id/variable

テンプレート変数を追加する

詳細

リクエスト

Header
Content-Type: application/json
Body

Key

Type

Value

name

String

変数名 (1 - 40文字) (必須)

defaultValue

String

変数のデフォルト値 (0 - 500文字) (オプション)

dispName

String

変数ラベル (0 - 40文字) (オプション)

editFormat

Object

入力フォーマット (オプション)

type String

入力タイプ(text or select)

options Array (最大 10件)

入力タイプがselect時のオプション

label String (1 - 40文字)

プルダウンのラベル

value String (0 - 500文字)

プルダウンの変数値

liteEditEnabled

boolean

エンドユーザ向け変更許可の有無 (オプション)

レスポンス

Status Code
201
Body

Key

Type

Value

name

String

変数名

defaultValue

String

変数のデフォルト値

values

Array

変数値一覧

dispName

String

変数ラベル

editFormat

Object

入力フォーマット

type String

入力タイプ(text or select)

options Array

入力タイプがselect時のオプション

label String

プルダウンのラベル

value String

プルダウンの変数値

liteEditEnabled

boolean

エンドユーザ向け変更許可の有無

サンプル

リクエスト

URL
POST https://*.sacm.jp/public-api/v1/user/tsa99990001/template/1/variable
Header
Content-Type: application/json
Body
{
  "name": "LAN1ADDRESS",
  "defaultValue": "10.0.0.1"
}

レスポンス

Header
Content-Type: application/json
Body
{
  "name": "LAN1ADDRESS",
  "defaultValue": "10.0.0.1",
  "values": [
  ],
  "dispName": null,
  "editFormat": null,
  "liteEditEnabled": false
}

備考

  • 追加できる変数の数は最大 200 件です

GET /user/:user_code/template/:id/variable/:name

指定した変数名の詳細情報を取得する

詳細

リクエスト

パラメータ無し

レスポンス

Body

Key

Type

Value

name

String

変数名

defaultValue

String

変数のデフォルト値

values

Array

変数値一覧

code String

SAコード

value String

変数値

dispName

String

変数ラベル

editFormat

Object

入力フォーマット

type String

入力タイプ(text or select)

options Array

入力タイプがselect時のオプション

label String

プルダウンのラベル

value String

プルダウンの変数値

liteEditEnabled

boolean

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

サンプル

リクエスト

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

レスポンス

Header
Content-Type: application/json
Body
{
  "name": "LAN1ADDRESS",
  "defaultValue": "172.0.0.1",
  "values": [
    {
      "code": "tss99990001",
      "value": "10.0.0.1"
    },
    {
      "code": "tss99990002",
      "value": "10.0.0.2"
    }
  ],
  "editFormat": {
    "type": "select",
    "options": [
      {
        "label": "設定 1",
        "value": "10.0.0.1"
      },
      {
        "label": "設定 2",
        "value": "10.0.0.2"
      }
    ]
  },
  "liteEditEnabled": false
}

PUT /user/:user_code/template/:id/variable/:name

指定した変数名の詳細情報を変更する

詳細

リクエスト

Header
Content-Type: application/json
Body

Key

Type

Value

defaultValue

String

変数のデフォルト値 (0 - 500文字) (オプション)

values

Array

変数値一覧 (オプション)

code String

SAコード

value String

変数値

dispName

String

変数ラベル (オプション)

editFormat

Object

入力フォーマット (オプション)

type String

入力タイプ(text or select)

options Array

入力タイプがselect時のオプション

label String

プルダウンのラベル

value String

プルダウンの変数値

liteEditEnabled

boolean

エンドユーザ向け変更許可の有無 (オプション)

レスポンス

Body

Key

Type

Value

name

String

変数名

defaultValue

String

変数のデフォルト値

values

Array

変数値一覧

code String

SAコード

value String

変数値

dispName

String

変数ラベル

editFormat

Object

入力フォーマット

type String

入力タイプ(text or select)

options Array

入力タイプがselect時のオプション

label String

プルダウンのラベル

value String

プルダウンの変数値

liteEditEnabled

boolean

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

サンプル

リクエスト

URL
PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/template/1/variable/LAN1ADDRESS
Header
Content-Type: application/json
Body
{
  "defaultValue": "172.0.1.1",
  "values": [
    {
      "code": "tss99990001",
      "value": "10.0.0.1"
    },
    {
      "code": "tss99990002",
      "value": "10.0.0.3"
    }
  ],
  "editFormat": {
    "type": "select",
    "options": [
      {
        "label": "設定 1",
        "value": "10.0.0.1"
      },
      {
        "label": "設定 2",
        "value": "10.0.0.2"
      },
      {
        "label": "設定 3",
        "value": "10.0.0.3"
      }
    ]
  },
  "liteEditEnabled": false
}

レスポンス

Header
Content-Type: application/json
Body
{
  "name": "LAN1ADDRESS",
  "defaultValue": "172.0.1.1",
  "values": [
    {
      "code": "tss99990001",
      "value": "10.0.0.1"
    },
    {
      "code": "tss99990002",
      "value": "10.0.0.3"
    }
  ],
  "editFormat": {
    "type": "select",
    "options": [
      {
        "label": "設定 1",
        "value": "10.0.0.1"
      },
      {
        "label": "設定 2",
        "value": "10.0.0.2"
      },
      {
        "label": "設定 3",
        "value": "10.0.0.3"
      }
    ]
  },
  "liteEditEnabled": false
}

DELETE /user/:user_code/template/:id/variable/:name

指定したテンプレート変数を削除する

詳細

リクエスト

パラメータ無し

レスポンス

Status Code
204
Header
Content-Type: text/plain
Body

ボディ無し

サンプル

リクエスト

URL
DELETE https://*.sacm.jp/public-api/v1/user/tsa99990001/template/1/variable/LAN1ADDRESS

レスポンス

Header
Content-Type: text/plain
Body

ボディ無し