Home

GET /home

Read list of available Management codes and Management labels

Detail

Request

No Parameters

Response

Body

Key	Type	Value
results	Array	List of available Management codes code String Management code name String Management label

Sample

Request

URL

GET https://*.sacm.jp/public-api/v1/home

Response

Header

Content-Type: application/json

Body

{
  "results": [
    {
      "code": "tsa99990001",
      "name": "API Sample inc."
    },
    {
      "code": "tsa99990002",
      "name": "Example API.com"
    }
  ]
}

GET /home/module

Read information for available Modules

Detail

Request

Body

Key	Type	Value
vendor	int	Vendor No.
satype	int	Service adaptor type
modulua	int	Module ID

Response

Body

Key	Type	Value
results	Array	List of available Modules moduleName String Module name venderId int Vendor No. saType int Service adaptor type moduleId int Module ID version String Version binary boolean Config format

Sample

Request

URL

GET https://*.sacm.jp/public-api/v1/home/module?vendor=0&satype=11&module=0

Response

Header

Content-Type: application/json

Body

{
  "results": [
    {
      "moduleName": "SEIL/X 3.75 (ArmBar)",
      "vendorId": 0,
      "saType": 11,
      "moduleId": 0,
      "version": "3.75.0-0",
      "binary": false
    },
    {
      "moduleName": "SEIL/X 3.90 (HurricaneMixer)",
      "vendorId": 0,
      "saType": 11,
      "moduleId": 0,
      "version": "3.90.0-0",
      "binary": false
    },
    {
      "moduleName": "SEIL/X 3.91 (Alcatraz)",
      "vendorId": 0,
      "saType": 11,
      "moduleId":0,
      "version": "3.91.0-0",
      "binary": false
    }
  ]
}

GET /home/permission

Read rights allocation status

Detail

Request

No Parameters

Response

Key	Type	Value
bilatu	Object	Control rights related to searches read boolean Whether or not it can be read
user	Object	Control rights related to user update boolean Whether or not it can be updated read boolean Whether or not it can be read
sa	Object	Control rights related to service adaptor distid Object Right to update service adaptor Distribution ID update boolean Whether or not it can be updated config Object Right to edit service adaptor config update boolean Whether or not it can be updated read boolean Whether or not it can be read read boolean Whether or not it can be read update boolean Whether or not it can be updated
sagroup	Object	Control rights related to folder create boolean Whether or not it can be created remove boolean Whether or not it can be deleted update boolean Whether or not it can be updated read boolean Whether or not it can be read
template	Object	Control rights related to templates config Object Control rights related to template config remove boolean Whether or not it can be deleted update boolean Whether or not it can be updated read boolean Whether or not it can be read variable Object Control rights related to Template Variables create boolean Whether or not it can be created remove boolean Whether or not it can be deleted update boolean Whether or not it can be updated read boolean Whether or not it can be read pack Object Control rights related to Template CSV update boolean Whether or not it can be updated read boolean Whether or not it can be read create boolean Whether or not it can be created remove boolean Whether or not it can be deleted update boolean Whether or not it can be updated read boolean Whether or not it can be read
monitor	Object	Control rights related to monitor settings create boolean Whether or not it can be created remove boolean Whether or not it can be deleted update boolean Whether or not it can be updated read boolean Whether or not it can be read
request	Object	Control rights related to requests check Object Control rights with no side effects on service adaptor create boolean Whether or not task can be registered update boolean Whether or not it can be updated control Object Control rights with side effects on service adaptor create boolean Whether or not task can be registered update boolean Whether or not it can be updated debug Object Control rights related to service adaptor debug create boolean Whether or not task can be registered update boolean Whether or not it can be updated read boolean Whether or not it can be read
event	Object	Control rights related to events read boolean Whether or not it can be read
modulua	Object	Control rights related to modules create boolean Whether or not it can be created remove boolean Whether or not it can be deleted update boolean Whether or not it can be updated read boolean Whether or not it can be read
announce	Object	Control rights related to announcements update boolean Whether or not it can be updated read boolean Whether or not it can be read
accesskey	Object	Control rights related to API access key create boolean Whether or not it can be created remove boolean Whether or not it can be deleted read boolean Whether or not it can be read

Sample

Request

URL

GET https://*.sacm.jp/public-api/v1/home/permission

Response

Header

Content-Type: application/json

Body

{
  "search": {
    "read": true
  },
  "user": {
    "update": true,
    "read": true
  },
  "sa": {
    "distId": {
      "update": false
    },
    "config": {
      "update": true,
      "read": true
    },
    "update": true,
    "read": true
  },
  "sagroup": {
    "create": true,
    "remove": true,
    "update": true,
    "read": true
  },
  "template": {
    "config": {
      "remove": true,
      "update": true,
      "read": true
    },
    "variable": {
      "create": true,
      "remove": true,
      "update": true,
      "read": true
    },
    "pack": {
      "update": true,
      "read": true
    },
    "create": true,
    "remove": true,
    "update": true,
    "read": true
  },
  "monitor": {
    "create": true,
    "remove": true,
    "update": true,
    "read": true
  },
  "request": {
    "check": {
      "create": true,
      "update": true
    },
    "control": {
      "create": true,
      "update": true
    },
    "debug": {
      "create": false,
      "update": false
    },
    "read": true
  },
  "event": {
    "read": true
  },
  "module": {
    "create": false,
    "remove": false,
    "update": false,
    "read": false
  },
  "announce": {
    "update": true,
    "read": true
  },
  "accesskey": {
    "create": true,
    "remove": true,
    "read": true
  }
}