テンプレートセット¶

GET /user/:user_code/template¶

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

詳細¶

リクエスト¶

パラメータ無し

レスポンス¶

Body¶

Key

Type

Value

results

Array

テンプレートセットの一覧

id int
テンプレートセットのID。デフォルト(未所属)の場合は null

name String
テンプレートセットの名前

label String
テンプレートセットのラベル

moduleId Array
登録されているテンプレートコンフィグのモジュールIDの一覧

member int
所属しているサービスアダプタの数

lastModified String
最終変更日時

サンプル¶

リクエスト¶

URL¶

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

レスポンス¶

Body¶

{
  "results":[
    {
      "id": null,
      "name": null,
      "member": 0,
      "moduleId": [],
      "lastModified": null,
      "label": null
    },
    {
      "id": 1,
      "name": "Template1",
      "member": 0,
      "moduleId": [
        0,
        1
      ],
      "lastModified": "2012/06/25 13:06:40",
      "label": "label1"
    }
  ]
}

POST /user/:user_code/template¶

テンプレートセットを追加する

詳細¶

リクエスト¶

Header¶

Content-Type: application/json

Body¶

Key	Type	Value
name	String	テンプレートセットの名前 (1 - 40文字) (必須)
label	String	テンプレートセットのラベル (0 - 255文字) (オプション)

レスポンス¶

Status Code¶

Body¶

Key	Type	Value
id	int	テンプレートセットのID。デフォルト(未所属)の場合は null
name	String	テンプレートセットの名前
moduleId	Array	登録されているテンプレートコンフィグのモジュールIDの一覧
sa	Array	所属しているサービスアダプタの一覧サービスアダプタの情報を参照
lastModified	String	最終変更日時
label	String	テンプレートセットのラベル

サンプル¶

リクエスト¶

URL¶

POST https://*.sacm.jp/public-api/v1/user/tsa99990001/template

Header¶

Content-Type: application/json

Body¶

{
  "name": "Template1",
  "label": "label1"
}

レスポンス¶

Header¶

Content-Type: application/json

Body¶

{
  "id": 1,
  "name": "Template1",
  "moduleId": [],
  "sa": [],
  "lastModified": "2012/06/25 13:06:40",
  "label": "label1"
}

GET /user/:user_code/template/:id¶

テンプレートセットの詳細情報を取得する

詳細¶

リクエスト¶

パラメータ無し

レスポンス¶

Body¶

Key	Type	Value
id	int	テンプレートセットのID。デフォルト(未所属)の場合は null
name	String	テンプレートセットの名前
moduleId	Array	登録されているテンプレートコンフィグのモジュールIDの一覧
sa	Array	所属しているサービスアダプタの一覧サービスアダプタの情報を参照
lastModified	String	最終変更日時
label	String	テンプレートセットのラベル

サンプル¶

リクエスト¶

URL¶

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

レスポンス¶

Header¶

Content-Type: application/json

Body¶

{
  "id": 1,
  "name": "Template1",
  "moduleId": [
    0,
    1
  ],
  "sa": [
    {
      "code": "tss99990001",
      "name": "SEIL/B1 001",
      "description": "MEMO",
      "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
      "up": true,
      "configState": "pushready",
      "group": {
        "id": 1,
        "name": "Folder1"
      },
      "template": {
        "id": 1,
        "name": "Template1",
        "label": "label1"
      },
      "monitor": {
        "id": 1,
        "name": "Monitor1"
      },
      "tag": [
        {
          "id": 1,
          "name": "Tag1",
          "colorCode": "#000000"
        }
      ],
      "date": {
        "lastPushReady": "2012/06/05 16:00:09",
        "lastHeartbeatReport": "2012/05/11 17:10:02",
        "lastPulled": "2012/05/11 17:06:22",
        "firstPulled": "2012/04/11 17:07:00"
      },
      "type": 0,
      "mode": null
    }
  ],
  "lastModified":"2012/06/25 13:28:50",
  "label": "label1"
}

PUT /user/:user_code/template/:id¶

テンプレートセットの詳細情報を変更する

詳細¶

リクエスト¶

Header¶

Content-Type: application/json

Body¶

Key	Type	Value
name	String	テンプレートセットの名前 (1 - 40文字) (オプション)
sa	Array	所属させるサービスアダプタの一覧 (オプション) code: String SAコード
updateMode	String	サービスアダプタの割当方法 (オプション) "overwrite": 上書き (省略時は "overwrite" となる) "insert" : 追加 "remove" : 削除
label	String	テンプレートセットのラベル (0 - 255文字) (オプション)

オプション¶

API コール時に特定のパラメータ option を Query String として付加すると、同時に所定の処理が実行されます。 option パラメータは省略可能です。

例

PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/template/1?option=no-content

指定可能なパラメータは以下の通りです。

Key	Type	Value
option	String	no-content クライアント側でレスポンスの body の内容が不要な場合に、body を空にした状態でレスポンスを返します。処理の内容自体に本オプション指定の有無による差異はありません。正常系の場合のみ有効になります。異常系の場合は本オプションを指定しても body にエラーメッセージは含まれます。

レスポンス¶

Body¶

Key	Type	Value
id	int	テンプレートセットのID。デフォルト(未所属)の場合は null
name	String	テンプレートセットの名前
moduleId	Array	登録されているテンプレートコンフィグのモジュールIDの一覧
sa	Array	所属しているサービスアダプタの一覧サービスアダプタの情報を参照
lastModified	String	最終変更日時
label	String	テンプレートセットのラベル

サンプル¶

リクエスト¶

URL¶

PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/template/1

Header¶

Content-Type: application/json

Body¶

{
  "name": "Template2",
  "sa": [
    {
      "code": "tss99990001"
    },
    {
      "code": "tss99990002"
    }
  ],
  "label": "label2"
}

レスポンス¶

Header¶

Content-Type: application/json

Body¶

{
  "id": 1,
  "name": "Template2",
  "moduleId": [
    0,
    1
  ],
  "sa": [
    {
      "code": "tss99990001",
      "name": "SEIL/B1 001",
      "description": "MEMO",
      "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
      "up": true,
      "configState": "pushready",
      "group": {
        "id": 1,
        "name": "Folder1"
      },
      "template": {
        "id": 1,
        "name": "Template2",
        "label": "label2"
      },
      "monitor": {
        "id": 1,
        "name": "Monitor1"
      },
      "tag": [
        {
          "id": 1,
          "name": "Tag1",
          "colorCode": "#000000"
        }
      ],
      "date": {
        "lastPushReady": "2012/06/05 16:00:09",
        "lastHeartbeatReport": "2012/05/11 17:10:02",
        "lastPulled": "2012/05/11 17:06:22",
        "firstPulled": "2012/04/11 17:07:00"
      },
      "type": 0,
      "mode": null
    },
    {
      "code": "tss99990002",
      "name": "SEIL/B1 002",
      "description": "MEMO",
      "distributionId": "0001-0000-0101-0000-0000-0000-5678-1234",
      "up": true,
      "configState": "pushready",
      "group": {
        "id": 1,
        "name": "Folder1"
      },
      "template": {
        "id": 1,
        "name": "Template2"
        "label": "label2"
      },
      "monitor": {
        "id": 1,
        "name": "Monitor1"
      },
      "tag": [
        {
          "id": 1,
          "name": "Tag1",
          "colorCode": "#000000"
        }
      ],
      "date": {
        "lastPushReady": "2012/06/05 16:00:09",
        "lastHeartbeatReport": "2012/05/11 17:10:02",
        "lastPulled": "2012/05/11 17:06:22",
        "firstPulled": "2012/04/11 17:07:00"
      },
      "type": 0,
      "mode": null
    }
  ],
  "lastModified":"2012/06/25 13:28:50",
  "label": "label2"
}

DELETE /user/:user_code/template/:id¶

テンプレートセットを削除する

詳細¶

リクエスト¶

パラメータ無し

レスポンス¶

Status Code¶

Header¶

Content-Type: text/plain

Body¶

ボディ無し

サンプル¶

リクエスト¶

URL¶

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

レスポンス¶

Header¶

Content-Type: text/plain

Body¶

ボディ無し

SACM service manual

テンプレートセット¶

GET /user/:user_code/template¶

詳細¶

リクエスト¶

レスポンス¶

Body¶

サンプル¶

リクエスト¶

URL¶

レスポンス¶

Header¶

Body¶

POST /user/:user_code/template¶

詳細¶

リクエスト¶

Header¶

Body¶

レスポンス¶

Status Code¶

Body¶

サンプル¶

リクエスト¶

URL¶

Header¶

Body¶

レスポンス¶

Header¶

Body¶

GET /user/:user_code/template/:id¶

詳細¶

リクエスト¶

レスポンス¶

Body¶

サンプル¶

リクエスト¶

URL¶

レスポンス¶

Header¶

Body¶

PUT /user/:user_code/template/:id¶

詳細¶

リクエスト¶

Header¶

Body¶

オプション¶

レスポンス¶

Body¶

サンプル¶

リクエスト¶

URL¶

Header¶

Body¶

レスポンス¶

Header¶

Body¶

DELETE /user/:user_code/template/:id¶

詳細¶

リクエスト¶

レスポンス¶

Status Code¶

Header¶

Body¶

サンプル¶

リクエスト¶

URL¶

レスポンス¶

Header¶

Body¶

テンプレート構成種別リファレンス¶

目次

前のトピックへ

次のトピックへ