Folder

GET /user/:user_code/sagroup

Read folder informatio

Detail

Request

No Parameters

Response

Body

Key

Type

Value

results

Array

Folder list

id int

Folder ID. null in case of default (unassigned)

name String

Folder name

member int

Number of service adaptors assigned to the folder

Sample

Request

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

Response

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

POST /user/:user_code/sagroup

Add folder

Detail

Request

Header
Content-Type: application/json
Body

Key

Type

Value

name

String

Folder name (1-40 characters) (required)

Request

Status Code
201
Body

Key

Type

Value

id

int

Folder ID

name

String

Folder name

sa

Array

Assigned service adaptor list

Sample

  • Up to 20 folders can be added

Request

URL
POST https://*.sacm.jp/public-api/v1/user/tsa99990001/sagroup
Header
Content-Type: application/json
Body
{
  "name": "Folder1"
}

Response

Header
Content-Type: application/json
Body
{
  "sa": [],
  "id": 1,
  "name": "Folder1"
}

GET /user/:user_code/sagroup/:id

Read folder details

Detail

Request

No Parameters

Response

Body

Key

Type

Value

id

int

Folder ID. null in case of default (unassigned)

name

String

Folder name

sa

Array

Assigned service adaptor list

Sample

Request

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

Response

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"
      },
      "monitor": {
        "id": 1,
        "name": "Monitor1"
      },
      "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

Update folder details

Detail

Request

Header
Content-Type: application/json
Body

Key

Type

Value

name

String

Folder name (1-40 characters) (option)

sa

Array

List of assigned service adaptors (option)

Response

Body

Key

Type

Value

id

int

Folder ID. null in case of default (unassigned)

name

String

Folder name

sa

Array

Assigned service adaptor list

Sample

Request

URL
PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/sagroup/1
Header
Content-Type: application/json
Body
{
  "sa":[
    {
      "code": "tss99990001"
    }
  ],
  "name": "Folder2"
}

Response

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"
      },
      "monitor": {
        "id": 1,
        "name": "Monitor1"
      },
      "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

Delete folder

Detail

Request

No Parameters

Response

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

No Body

Sample

Request

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

Response

Header
Content-Type: text/plain
Body

No Body