タグ

GET /user/:user_code/tag

タグの一覧情報を取得する

詳細

リクエスト

パラメータ無し

レスポンス

Body

Key	Type	Value
results	Array	タグの一覧 id int タグのID name String タグの名前 colorCode String タグの背景色 member int タグに設定しているサービスアダプタの数

サンプル

リクエスト

URL

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

レスポンス

Header

Content-Type: application/json

Body

{
  "results": [
    {
      "id": 1,
      "name": "Tag1",
      "colorCode": "#000000",
      "member": 2
    }
  ]
}

POST /user/:user_code/tag

タグを追加する

詳細

リクエスト

Header

Content-Type: application/json

Body

Key	Type	Value
name	String	タグの名前 (1 - 40文字) (必須)
colorCode	String	タグの背景色 (7文字) (必須)

レスポンス

Status Code

201

Body

Key	Type	Value
id	int	タグのID
name	String	タグの名前
colorCode	String	タグの背景色
sa	Array	設定しているサービスアダプタの一覧 サービスアダプタの情報 を参照

サンプル

• 追加できるタグ数は最大 20 件です

リクエスト

URL

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

Header

Content-Type: application/json

Body

{
  "name": "Tag1",
  "colorCode": "#000000",
}

レスポンス

Header

Content-Type: application/json

Body

{
  "sa": [],
  "id": 1,
  "name": "Tag1"
}

GET /user/:user_code/tag/:id

タグの詳細情報を取得する

詳細

リクエスト

パラメータ無し

レスポンス

Body

Key	Type	Value
id	int	タグのID
name	String	タグの名前
sa	Array	設定しているサービスアダプタの一覧 サービスアダプタの情報 を参照

サンプル

リクエスト

URL

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

レスポンス

Header

Content-Type: application/json

Body

{
  "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": "Folder2"
      },
      "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
    }
  ],
  "id": 1,
  "name": "Tag1",
  "colorCode": "#000000"
}

PUT /user/:user_code/tag/:id

タグの詳細情報を変更する

詳細

リクエスト

Header

Content-Type: application/json

Body

Key	Type	Value
name	String	タグの名前 (1 - 40文字) (オプション)
colorCode	String	タグの背景色 (7文字) (オプション)
sa	Array	設定させるサービスアダプタの一覧 (オプション)

レスポンス

Body

Key	Type	Value
id	int	タグのID
name	String	タグの名前
colorCode	String	タグの背景色
sa	Array	設定しているサービスアダプタの一覧 サービスアダプタの情報 を参照

サンプル

リクエスト

URL

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

Header

Content-Type: application/json

Body

{
  "sa":[
    {
      "code": "tss99990001"
    }
  ],
  "name": "Tag2",
  "colorCode": "#000000",
}

レスポンス

Header

Content-Type: application/json

Body

{
  "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": "Folder2"
      },
      "template": {
        "id": 1,
        "name": "Template1",
        "label": "label1"
      },
      "monitor": {
        "id": 1,
        "name": "Monitor1"
      },
      "tag": [
        {
          "id": 1,
          "name": "Tag2",
          "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
    }
  ],
  "id": 1,
  "name": "Tag2",
  "colorCode": "#000000"
}

DELETE /user/:user_code/tag/:id

タグを削除する

詳細

リクエスト

パラメータ無し

レスポンス

Status Code

204

Header

Content-Type: text/plain

Body

ボディ無し

サンプル

リクエスト

URL

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

レスポンス

Header

Content-Type: text/plain

Body

ボディ無し