Configure¶

GET /user/:user_code/request/configure/:id¶

Read information for requested reflect Running config

Detail¶

Request¶

No Parameters

Response¶

Body¶

Key

Type

Value

saError

boolean

Whether or not there is service adaptor error information

Always null

moduleError

Array

List of module errors

Always null

Other than the above

Shared parameters

See “ Request information “

Sample¶

Request¶

URL¶

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

Response¶

Body¶

{
  "id": "1:1",
  "sa":{
    "code": "tss99990001",
    "name": "Service adapter 001",
    "description": "MEMO",
    "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
    "up": true
  },
  "type": "configure",
  "targetTime": "2012/06/28 09:25:30",
  "status": "failed",
  "proxyStatus": "success",
  "resultCode": "config-validation-failure",
  "saError": false,
  "moduleError": [
    "id": 0,
    "result": 1,
    "binary": false
  ]
}

Description¶

When the reflect Running config operation is executed, the service adaptor may be rebooted to sync the module version. The response “status” and “resultCode” values are as follows.
```
"status": "failed"
"resultCode": "module-syncing"
```

PUT /user/:user_code/request/configure/:id¶

Update information of requested reflect running config (stop execution, update execution schedule date/time)

Detail¶

Request¶

Header¶

Content-Type: application/json

Body¶

Key

Type

Value

status

int

Request status

Use to stop execution

Can update only if status is “initial”

Only “3” (cancel) can be specified

targetTime

String

Execute schedule date/time

Use to update execution schedule date/time

Can update only if status is “initial”

Can specify up to one month ahead,

Response¶

Body¶

Key

Type

Value

saError

boolean

Whether or not there is service adaptor error information

Always null

moduleError

Array

List of module errors

Always null

Other than the above

Shared parameters

See “ Request information “

Sample (to stop execution)¶

Request¶

URL¶

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

Header¶

Content-Type: application/json

Body¶

{"status": 3}

Response¶

Header¶

Content-Type: application/json

Body¶

{
  "id": "1:1",
  "sa": {
    "code": "tss99990001",
    "name": "Service adapter 001",
    "description": "MEMO",
    "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
    "up": true
  },
  "type": "configure",
  "targetTime": "2012/06/27 15:00:00",
  "status": "canceled",
  "proxyStatus": "none",
  "resultCode": "none",
  "saError": null,
  "moduleError": null
}

Sample (to update execution schedule date/time)¶

Request¶

URL¶

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

Header¶

Content-Type: application/json

Body¶

{"targetTime": "2012/06/27 16:00:00"}

Response¶

Header¶

Content-Type: application/json

Body¶

{
  "id": "1:1",
  "sa": {
    "code": "tss99990001",
    "name": "Service adapter 001",
    "description": "MEMO",
    "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
    "up": true
  },
  "type": "configure",
  "targetTime": "2012/06/27 16:00:00",
  "status": "initial",
  "proxyStatus": "none",
  "resultCode": "none",
  "saError": null,
  "moduleError": null
}

Description¶

ID may be updated if the execution schedule date/time is updated
Simultaneous execution cancel and execution schedule date/time update not allowed

GET /user/:user_code/request/configure/:id/error/sa/binary¶

Read errors for requested reflect running config operation on a per equipment basis

Detail¶

Request¶

No Parameters

Response¶

Header¶

Content-Type: application/octet-stream

Body¶

Error content (binary)

Sample¶

Request¶

URL¶

GET https://*.sacm.jp/public-api/v1/user/tsa99990001/request/configure/1:1/error/sa/binary

Response¶

Header¶

Content-Type: application/octet-stream

Body¶

Error content (binary)

GET /user/:user_code/request/configure/:id/error/module/:module_id/plain¶

Read errors for requested reflect running config operation on a per equipment basis (text format)

Detail¶

Request¶

No Parameters

Response¶

Header¶

Content-Type: text/plain

Body¶

Error content (text)

Sample¶

Request¶

URL¶

GET https://*.sacm.jp/public-api/v1/user/tsa99990001/request/configure/1:1/error/module/0/plain

Response¶

Header¶

Content-Type: text/plain

Body¶

Syntax Error

GET /user/:user_code/request/configure/:id/error/module/:module_id/binary¶

Read errors for requested reflect running config operation on a per equipment basis (binary format)

Detail¶

Request¶

No Parameters

Response¶

Header¶

Content-Type: application/octet-stream

Body¶

Error content (binary)

Sample¶

Request¶

URL¶

GET https://*.sacm.jp/public-api/v1/user/tsa99990001/request/configure/1:1/error/module/0/binary

Response¶

Header¶

Content-Type: application/octet-stream

Body¶

Error content (binary)

SACM service manual

Configure¶

GET /user/:user_code/request/configure/:id¶

Detail¶

Request¶

Response¶

Body¶

Sample¶

Request¶

URL¶

Response¶

Header¶

Body¶

Description¶

PUT /user/:user_code/request/configure/:id¶

Detail¶

Request¶

Header¶

Body¶

Response¶

Body¶

Sample (to stop execution)¶

Request¶

URL¶

Header¶

Body¶

Response¶

Header¶

Body¶

Sample (to update execution schedule date/time)¶

Request¶

URL¶

Header¶

Body¶

Response¶

Header¶

Body¶

Description¶

GET /user/:user_code/request/configure/:id/error/sa/binary¶

Detail¶

Request¶

Response¶

Header¶

Body¶

Sample¶

Request¶

URL¶

Response¶

Header¶

Body¶

GET /user/:user_code/request/configure/:id/error/module/:module_id/plain¶

Detail¶

Request¶

Response¶

Header¶

Body¶

Sample¶

Request¶

URL¶

Response¶

Header¶

Body¶

GET /user/:user_code/request/configure/:id/error/module/:module_id/binary¶

Detail¶

Request¶

Response¶

Header¶

Body¶

Sample¶

Request¶

URL¶

Response¶

Header¶

Body¶

Table of Contents