Configure¶

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

リクエストした動作コンフィグ反映の情報を取得する

詳細¶

リクエスト¶

パラメータ無し

レスポンス¶

Body¶

Key

Type

Value

saError

boolean

サービスアダプタのエラー情報があるか否か

常にnullとなる

moduleError

Array

モジュールの持つエラー一覧

常にnullとなる

上記以外

共通パラメータ

レスポンス情報を参照

サンプル¶

リクエスト¶

URL¶

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

レスポンス¶

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",
  "requestCommands": [],
  "saError": false,
  "moduleError": [
    "id": 0,
    "result": 1,
    "binary": false
  ]
}

備考¶

動作コンフィグ反映を行った際にサービスアダプタがモジュールバージョンの同期のため再起動する場合があります。この時レスポンスの "status" と "resultCode" は下記の値となります。
```
"status": "failed"
"resultCode": "module-syncing"
```

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

リクエストされた動作コンフィグ反映の情報を変更する (実行の中止、実行予定日時の変更)

詳細¶

リクエスト¶

Header¶

Content-Type: application/json

Body¶

Key

Type

Value

status

int

リクエストの状態

実行を中止する場合に使用する

status が "initial" の場合のみ変更可能

"3" (キャンセル)のみ指定可能

targetTime

String

実行予定日時

実行予定日時を変更する場合に使用する

status が "initial" の場合のみ変更可能

翌月末まで指定可能、

レスポンス¶

Body¶

Key

Type

Value

saError

boolean

サービスアダプタのエラー情報があるか否か

常にnullとなる

moduleError

Array

モジュールの持つエラー一覧

常にnullとなる

上記以外

共通パラメータ

レスポンス情報を参照

サンプル(実行を中止する時)¶

リクエスト¶

URL¶

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

Header¶

Content-Type: application/json

Body¶

{"status": 3}

レスポンス¶

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",
  "requestCommands": [],
  "saError": null,
  "moduleError": null
}

サンプル(実行予定日時を変更する時)¶

リクエスト¶

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

レスポンス¶

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",
  "requestCommands": [],
  "saError": null,
  "moduleError": null
}

備考¶

実行予定日時を変更すると id が変更される可能性がある
実行の中止と実行予定日時の変更の同時実行は不可

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

リクエストした動作コンフィグ反映のエラーを機種単位で取得する

詳細¶

リクエスト¶

パラメータ無し

レスポンス¶

Header¶

Content-Type: application/octet-stream

Body¶

エラー内容(バイナリ)

サンプル¶

リクエスト¶

URL¶

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

レスポンス¶

Header¶

Content-Type: application/octet-stream

Body¶

エラー内容(バイナリ)

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

リクエストした動作コンフィグ反映のエラーをモジュール単位で取得する (テキスト形式)

詳細¶

リクエスト¶

パラメータ無し

レスポンス¶

Header¶

Content-Type: text/plain

Body¶

エラー内容(テキスト)

サンプル¶

リクエスト¶

URL¶

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

レスポンス¶

Header¶

Content-Type: text/plain

Body¶

Syntax Error

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

リクエストした動作コンフィグ反映のエラーをモジュール単位で取得する (バイナリ形式)

詳細¶

リクエスト¶

パラメータ無し

レスポンス¶

Header¶

Content-Type: application/octet-stream

Body¶

エラー内容(バイナリ)

サンプル¶

リクエスト¶

URL¶

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

レスポンス¶

Header¶

Content-Type: application/octet-stream

Body¶

エラー内容(バイナリ)

SACM service manual

Configure¶

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

詳細¶

リクエスト¶

レスポンス¶

Body¶

サンプル¶

リクエスト¶

URL¶

レスポンス¶

Header¶

Body¶

備考¶

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

詳細¶

リクエスト¶

Header¶

Body¶

レスポンス¶

Body¶

サンプル(実行を中止する時)¶

リクエスト¶

URL¶

Header¶

Body¶

レスポンス¶

Header¶

Body¶

サンプル(実行予定日時を変更する時)¶

リクエスト¶

URL¶

Header¶

Body¶

レスポンス¶

Header¶

Body¶

備考¶

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

詳細¶

リクエスト¶

レスポンス¶

Header¶

Body¶

サンプル¶

リクエスト¶

URL¶

レスポンス¶

Header¶

Body¶

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

詳細¶

リクエスト¶

レスポンス¶

Header¶

Body¶

サンプル¶

リクエスト¶

URL¶

レスポンス¶

Header¶

Body¶

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

詳細¶

リクエスト¶

レスポンス¶

Header¶

Body¶

サンプル¶

リクエスト¶

URL¶

レスポンス¶

Header¶

Body¶

目次

前のトピックへ

次のトピックへ