フォルダ¶

GET /user/:user_code/sagroup¶

フォルダの一覧情報を取得する

詳細¶

リクエスト¶

パラメータ無し

レスポンス¶

Body¶

Key

Type

Value

results

Array

フォルダの一覧

id int
フォルダのID。デフォルト(未所属)の場合は null

name String
フォルダの名前

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

サンプル¶

リクエスト¶

URL¶

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

レスポンス¶

Body¶

{
  "results": [
    {
      "id": null,
      "name": null,
      "member": 3
    },
    {
      "id": 1535,
      "name":" folder1",
      "member": 2
    }
  ]
}

POST /user/:user_code/sagroup¶

フォルダを追加する

詳細¶

リクエスト¶

Header¶

Content-Type: application/json

Body¶

Key	Type	Value
name	String	フォルダの名前 (1 - 40文字) (必須)

レスポンス¶

Status Code¶

Body¶

Key

Type

Value

id

int

フォルダのID

name

String

フォルダの名前

sa

Array

所属しているサービスアダプタの一覧

サービスアダプタの情報を参照

サンプル¶

追加できるフォルダ数は最大 100 件です

リクエスト¶

URL¶

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

Header¶

Content-Type: application/json

Body¶

{
  "name": "Folder1"
}

レスポンス¶

Header¶

Content-Type: application/json

Body¶

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

GET /user/:user_code/sagroup/:id¶

フォルダの詳細情報を取得する

詳細¶

リクエスト¶

パラメータ無し

レスポンス¶

Body¶

Key

Type

Value

id

int

フォルダのID。デフォルト(未所属)の場合は null

name

String

フォルダの名前

sa

Array

所属しているサービスアダプタの一覧

サービスアダプタの情報を参照

サンプル¶

リクエスト¶

URL¶

GET https://*.sacm.jp/public-api/v1/user/tsa99990001/sagroup/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": "Folder1"
}

PUT /user/:user_code/sagroup/:id¶

フォルダの詳細情報を変更する

詳細¶

リクエスト¶

Header¶

Content-Type: application/json

Body¶

Key

Type

Value

name

String

フォルダの名前 (1 - 40文字) (オプション)

sa

Array

所属させるサービスアダプタの一覧 (オプション)

updateMode

String

サービスアダプタの割当方法 (オプション)

"overwrite": 上書き (省略時は "overwrite" となる)
"insert" : 追加
"remove" : 削除

オプション¶

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

例

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

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

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

レスポンス¶

Body¶

Key

Type

Value

id

int

フォルダのID。デフォルト(未所属)の場合は null

name

String

フォルダの名前

sa

Array

所属しているサービスアダプタの一覧

サービスアダプタの情報を参照

サンプル¶

リクエスト¶

URL¶

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

Header¶

Content-Type: application/json

Body¶

{
  "sa":[
    {
      "code": "tss99990001"
    }
  ],
  "name": "Folder2"
}

レスポンス¶

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": "Folder2"
}

DELETE /user/:user_code/sagroup/:id¶

フォルダを削除する

詳細¶

リクエスト¶

パラメータ無し

レスポンス¶

Status Code¶

Header¶

Content-Type: text/plain

Body¶

ボディ無し

サンプル¶

リクエスト¶

URL¶

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

レスポンス¶

Header¶

Content-Type: text/plain

Body¶

ボディ無し

SACM service manual

フォルダ¶

GET /user/:user_code/sagroup¶

詳細¶

リクエスト¶

レスポンス¶

Body¶

サンプル¶

リクエスト¶

URL¶

レスポンス¶

Header¶

Body¶

POST /user/:user_code/sagroup¶

詳細¶

リクエスト¶

Header¶

Body¶

レスポンス¶

Status Code¶

Body¶

サンプル¶

リクエスト¶

URL¶

Header¶

Body¶

レスポンス¶

Header¶

Body¶

GET /user/:user_code/sagroup/:id¶

詳細¶

リクエスト¶

レスポンス¶

Body¶

サンプル¶

リクエスト¶

URL¶

レスポンス¶

Header¶

Body¶

PUT /user/:user_code/sagroup/:id¶

詳細¶

リクエスト¶

Header¶

Body¶

オプション¶

レスポンス¶

Body¶

サンプル¶

リクエスト¶

URL¶

Header¶

Body¶

レスポンス¶

Header¶

Body¶

DELETE /user/:user_code/sagroup/:id¶

詳細¶

リクエスト¶

レスポンス¶

Status Code¶

Header¶

Body¶

サンプル¶

リクエスト¶

URL¶

レスポンス¶

Header¶

Body¶

目次

前のトピックへ

次のトピックへ