Service adaptor

GET /user/:user_code/sa

Read service adaptor information

Detail

Request

No Parameters

Response

Body

Key	Type	Value
results	Array	Service adaptor list See “ Service adaptor information “

Sample

Request

URL

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

Response

Header

Content-Type: application/json

Body

{
  "results": [
    {
      "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"
      },
      "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
    },
    {
      "code": "tsw99990002",
      "name": "SA-W1 001",
      "description": "MEMO",
      "distributionId": "0001-0000-0101-0000-0000-0000-5678-1234",
      "up": true,
      "configState": "pushready",
      "group": {
        "id": 2,
        "name": "Folder2"
      },
      "template": {
        "id": 2,
        "name": "Template2"
      },
      "monitor": {
        "id": 2,
        "name": "Monitor2"
      },
      "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": 1,
      "mode": "R0001"
    }
  ]
}

GET /user/:user_code/sa/:sa_code

Read service adaptor details

Detail

Request

No Parameters

Response

Body

Key	Type	Value
code	String	SA code
name	String	SA label
description	String	Memo
distributionId	String	Distribution ID
up	boolean	Connection status true Connected false Disconnected
ipAddress	String	Connection source IP address
port	int	Port used by the connection
pulledTrigger	String	Config Pull reason none N/A power-on-boot Power on boot user-reboot Rebooted by command failure-reboot Reboot due to failure timeout-occured Re-pulled due to timeout error-reported Re-pulled due to error report invalid-config Re-pulled due to config error invalid-message Re-pulled due to protocol message error fallbacked Re-pulled due to connection failure with RS config-expired Config expired module-sync-done Module sync succeeded module-sync-fail Module sync failed no-rs No RS rs-request-reboot Reboot requested by RS boot-failed Boot failed server-failure Error report from RS internal-error Service adaptor failure no-push-method Unknown push method no-push-server No push server out-of-service Out of service push-failed Push failed need-reboot Reboot retry-over Retry over rollback-failure Rollback failure no-tunnel-url Unknown tunnel URL
configState	String	Config status initial Config unpulled or not synced pulled Config pulled pushready RS control confirmed pushed Config being operated pushconfirming RS control being confirmed
pushMethod	String	Connection mode used by the service adaptor none N/A (default status) no-confirm Simple (no confirmation) simple Simple (with confirmation) tunnel Tunnel
preferredPushMethod	String	Connection mode proposed by RS none No proposal simple Simple (with confirmation) tunnel Tunnel
date	Object	Date/time information lastPushReady String Date/time of last available status notification lastHeartbeatReport String Date/time of last monitor notification lastPulled String Date/time of last read config by service adaptor firstPulled String Date/time of first read config by service adaptor
graph	Object	Information required to access graph uri String graph CGI path keyCode String graph CGI key
group	Object	Assigned folder (null if not assigned) id int ID of assigned folder name String Name of assigned folder
template	Object	Assigned Template (null if not assigned) id int Assigned Template ID name String Assigned Template name
monitor	Object	Assigned Monitor group (null if not assigned) id int Assigned Monitor group ID name String Assigned Monitor group name
type:	int	Service adaptor type 0 Standard service adaptor (tss) 1 Recipe-compatible service adaptor (tsw)
mode	String	Recipe-compatible service adaptor recipe code (null if not assigned)

Sample

Request

URL

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

Response

Header

Content-Type: application/json

Body

{
  "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"
  },
  "monitor": {
    "id": 1,
    "name": "Monitor1"
  },
  "ipAddress": "10.0.0.1",
  "port": 65525,
  "pulledTrigger": "power-on-boot",
  "pushMethod": "tunnel",
  "preferredPushMethod": "tunnel",
  "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"
  },
  "graph": {
    "uri": "hb500/grapher.cgi",
    "keyCode": "graphkeycodesample"
  },
  "type": 0,
  "mode": null
}

PUT /user/:user_code/sa/:sa_code

Update service adaptor details

Detail

Request

Header

Content-Type: application/json

Body

Key	Type	Value
name	String	SA level (1 - 100 characters) (option)
description	String	Memo (1 - 500 characters) (option)
distributionId	String	Distribution ID (39 characters) or null (option) Specify null to disable the Distribution ID assignment Distribution IDs for Recipe Framework compatible equipment cannot be assigned to a normal service adaptor (tss) Distribution IDs for normal equipment cannot be assigned to a Recipe Framework-compatible service adaptor
preferredPushMethod	String	Connection mode proposed by RS (option) none No Proposal simple Simple (confirmation) tunnel Tunnel

Response

Body

Key	Type	Value
code	String	SA code
name	String	SA label
description	String	Memo
distributionId	String	Distribution ID
up	boolean	Connection status true Connected false Disconnected
ipAddress	String	Connection source IP address
port	int	Port used by the connection
pulledTrigger	String	Config Pull reason none N/A power-on-boot Power on boot user-reboot Rebooted by command failure-reboot Reboot due to failure timeout-occured Re-pulled due to timeout error-reported Re-pulled due to error report invalid-config Re-pulled due to config error invalid-message Re-pulled due to protocol message error fallbacked Re-pulled due to connection failure with RS config-expired Config expired module-sync-done Module sync succeeded module-sync-fail Module sync failed no-rs No RS rs-request-reboot Reboot requested by RS boot-failed Boot failed server-failure Error report from RS internal-error Service adaptor failure no-push-method Unknown push method no-push-server No push server out-of-service Out of service push-failed Push failed need-reboot Reboot retry-over Retry over rollback-failure Rollback failure no-tunnel-url Unknown tunnel URL
configState	String	Config status initial Config unpulled or not synced pulled Config pulled pushready RS control confirmed pushed Config being operated pushconfirming RS control being confirmed
pushMethod	String	Connection mode used by the service adaptor none N/A (default status) no-confirm Simple (no confirmation) simple Simple (with confirmation) tunnel Tunnel
preferredPushMethod	String	Connection mode proposed by RS none No proposal simple Simple (with confirmation) tunnel Tunnel
date	Object	Date/time information lastPushReady String Date/time of last available status notification lastHeartbeatReport String Date/time of last monitor notification lastPulled String Date/time of last read config by service adaptor firstPulled String Date/time of first read config by service adaptor
graph	Object	Information required to access graph uri String graph CGI path keyCode String graph CGI key
group	Object	Assigned folder (null if not assigned) id int ID of assigned folder name String Name of assigned folder
template	Object	Assigned Template (null if not assigned) id int Assigned Template ID name String Assigned Template name
monitor	Object	Assigned Monitor group (null if not assigned) id int Assigned Monitor group ID name String Assigned Monitor group name
type:	int	Service adaptor type 0 Standard service adaptor (tss) 1 Recipe-compatible service adaptor (tsw)
mode	String	Recipe-compatible service adaptor recipe code (null if not assigned)

Sample

Request

URL

PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/sa/tss99990001

Header

Content-Type: application/json

Body

{
    "name": "SEIL/B1 002",
    "description": "MEMO-CHANGED",
    "distributionId": "0001-0000-0101-0000-0000-0000-5678-1234",
    "preferredPushMethod": "simple"
}

Response

Response Header

Content-Type: application/json

Response Body

{
  "code": "tss99990001",
  "name": "SEIL/B1 002",
  "description": "MEMO-CHANGED",
  "distributionId": "0001-0000-0101-0000-0000-0000-5678-1234",
  "up": true,
  "configState": "pushready",
  "group": {
    "id": 1,
    "name": "Folder1"
  },
  "template": {
    "id": 1,
    "name": "Template1"
  },
  "monitor": {
    "id": 1,
    "name": "Monitor1"
  },
  "ipAddress": "10.0.0.1",
  "port": 65525,
  "pulledTrigger": "power-on-boot",
  "pushMethod": "tunnel",
  "preferredPushMethod": "simple",
  "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"
  },
  "graph": {
    "uri": "hb500/grapher.cgi",
    "keyCode": "graphkeycodesample"
  },
  "type": 0,
  "mode": null
}

Shared parameters

Service adaptor information

Key	Type	Value
code	String	SA code
name	String	SA label
description	String	Memo
distributionId	String	Distribution ID
up	boolean	Connection status true Connected false Disconnected
configState	String	Config status initial Config unpulled or not synced pulled Config pulled pushready RS control confirmed pushed Config being operated pushconfirming RS control being confirmed
group	Object	Assigned folder (null if not assigned) id int ID of assigned folder name String Name of assigned folder
template	Object	Assigned Template (null if not assigned) id int Assigned Template ID name String Assigned Template name
monitor	Object	Assigned Monitor group (null if not assigned) id int Assigned Monitor group ID name String Assigned Monitor group name
date	Object	Date/time information lastPushReady String Date/time of last available status notification lastHeartbeatReport String Date/time of last monitor notification lastPulled String Date/time of last read config by service adaptor firstPulled String Date/time of first read config by service adaptor
type:	int	Service adaptor type 0 Standard service adaptor (tss) 1 Recipe-compatible service adaptor (tsw)
mode	String	Recipe-compatible service adaptor recipe code (null if not assigned)