Back to top

DataOcean Web-API

DataOceanのWeb-API 仕様

OAuth2認証

OAuth2認証

OAuth2認証
POST/oauth/token

処理概要

OAuth2のアクセストークンを取得する。

取得方法としては、ブラウザから行う方法とAPIで直接行う方法があるが、ここではAPIで直接行う方法を示す。認証が成功すればResponse 200、失敗した場合はResponse 401が返る。

Example URI

POST /oauth/token
URI Parameters
HideShow
client_id
string (required) Example: client1

ユーザAP名。

grant_type
string (required) Example: password

"password"で固定。

username
string (required) Example: user1

ユーザー名

password
string (required) Example: ******

パスワード

tenantId
string (required) Example: tenant1

テナントID

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "access_token": "46014172-da31-4860-b312-5cbd0a64a5fcc",
  "token_type": "bearer",
  "refresh_token": "bc8dbe4b-d090-4cb9-8971-8bf1c0dc387c",
  "expires_in": 36883,
  "scope": "public"
}
Schema
{
  "type": "object",
  "properties": {
    "access_token": {
      "type": "string",
      "description": "アクセストークン"
    },
    "token_type": {
      "type": "string",
      "description": "アクセストークンの種類"
    },
    "refresh_token": {
      "type": "string",
      "description": "リフレッシュトークン"
    },
    "expires_in": {
      "type": "number",
      "description": "トークンの有効期限"
    },
    "scope": {
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow
Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

トークン更新
POST/oauth/token

処理概要

OAuth2のアクセストークンを更新する。

更新が成功すればResponse 200、失敗した場合はResponse 401が返る。

Example URI

POST /oauth/token
URI Parameters
HideShow
client_id
string (required) Example: client1

ユーザAP名。

grant_type
string (required) Example: refresh_token

"refresh_token"で固定。

refresh_token
string (required) Example: bc8dbe4b-d090-4cb9-8971-8bf1c0dc387c

トークン取得時得られた"refresh_token"の値

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "access_token": "46014172-da31-4860-b312-5cbd0a64a5fcc",
  "token_type": "bearer",
  "refresh_token": "bc8dbe4b-d090-4cb9-8971-8bf1c0dc387c",
  "expires_in": 36883,
  "scope": "public"
}
Schema
{
  "type": "object",
  "properties": {
    "access_token": {
      "type": "string",
      "description": "新しいアクセストークン"
    },
    "token_type": {
      "type": "string",
      "description": "アクセストークンの種類"
    },
    "refresh_token": {
      "type": "string",
      "description": "新しいリフレッシュトークン"
    },
    "expires_in": {
      "type": "number",
      "description": "トークンの有効期限"
    },
    "scope": {
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow
Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

テナント

テナント情報

テナント情報一覧取得
GET/oauth2/tenant/index

処理概要

  • テナント情報の一覧を取得する。

    • ルートテナント管理権限が必須である。権限がない場合はResponse 403が返る。
  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

Example URI

GET /oauth2/tenant/index
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": [
    {
      "id": 1,
      "name": "RootTenant",
      "tenantId": "platform"
    }
  ],
  "permissions": {
    "create": true,
    "delete": true,
    "edit": true,
    "execute": true,
    "show": true
  },
  "status": 200,
  "total": 1
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "テナントのid"
          },
          "name": {
            "type": "string",
            "description": "テナントの名前"
          },
          "tenantId": {
            "type": "string",
            "description": "テナントID"
          }
        }
      },
      "description": "テナント"
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create": {
          "type": "boolean",
          "description": "子要素作成可能権限"
        },
        "delete": {
          "type": "boolean",
          "description": "削除権限"
        },
        "edit": {
          "type": "boolean",
          "description": "編集権限"
        },
        "execute": {
          "type": "boolean",
          "description": "実行権限"
        },
        "show": {
          "type": "boolean",
          "description": "表示権限"
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "total": {
      "type": "number",
      "description": "テナントの数"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

テナント詳細

テナント詳細取得
GET/oauth2/tenant/show/{id}

処理概要

  • 指定したテナントの詳細情報を取得する。
    • ルートテナント以外の場合は、自分自身の所属するテナントの情報だけを取得することが可能である。
  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。
  • 権限上不可視なテナントを指定した場合はResponse 403が返る。
  • 存在しないテナントを指定した場合はResponse 404が返る。

Example URI

GET /oauth2/tenant/show/mine
URI Parameters
HideShow
id
string (required) Example: mine

テナントのIDまたは文字列"mine"。mineを指定したときは自身のテナントについての詳細を取得する。

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": {
    "acl": [
      {
        "inherit": false,
        "permission": {
          "id": 26,
          "accountId": "user0@example.com",
          "className": "TenantPermission",
          "rights": {
            "ShowTenant": 2,
            "EditTenant": 0,
            "ShowDesign": 2,
            "EditDesign": 0,
            "ShowOpLog": 2,
            "ShowFailedPubLog": 2,
            "ShowUsage": 2,
            "ShowRestriction": 2,
            "CreateTag": 2,
            "ShowTag": 2,
            "EditTag": 2,
            "DeleteTag": 0,
            "CreateCondition": 2,
            "ShowCondition": 2,
            "EditCondition": 0,
            "DeleteCondition": 0,
            "CreateEventType": 2,
            "ShowEventType": 2,
            "EditEventType": 0,
            "DeleteEventType": 0,
            "CreateAction": 2,
            "ShowAction": 2,
            "EditAction": 0,
            "DeleteAction": 0,
            "ShowEvent": 2,
            "ShowExecution": 2,
            "TerminateExecution": 0,
            "CreateAccount": 0,
            "ShowAccount": 2,
            "EditAccount": 0,
            "DeleteAccount": 0,
            "CreateUserAp": 0,
            "ShowUserAp": 2,
            "EditUserAp": 0,
            "DeleteUserAp": 0
          }
        }
      }
    ],
    "id": 110,
    "mail": {
      "otp": {
        "body": "平素より「DataOcean」をご利用いただきありがとうございます",
        "localPart": "info",
        "subjecct": "[DataOcean]ワンタイムパスワード発行"
      }
    },
    "name": "テナント1",
    "userLockedThreshold": 0,
    "saveDays": {
      "events": 1,
      "executions": 1,
      "measurements": 1
    },
    "isLazy": {
      "deviceTree": false,
      "commandTree": false
    },
    "needId": true,
    "needExcuteStatus": true,
    "needPlace": true,
    "needLatestValuee": false,
    "tenantId": "tenant1",
    "urls": {
      "dashboard": "http://test.com",
      "sysOpInfo": "http://test.com"
    }
  },
  "permissions": {
    "create": true,
    "delete": true,
    "edit": true,
    "execute": true,
    "show": true
  },
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "acl": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "inherit": {
                "type": "boolean",
                "description": "上位権限を継承したかどうか"
              },
              "permission": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "description": "権限のID"
                  },
                  "accountId": {
                    "type": "string",
                    "description": "アカウントID"
                  },
                  "className": {
                    "type": "string",
                    "description": "クラス名"
                  },
                  "rights": {
                    "type": "object",
                    "properties": {
                      "ShowTenant": {
                        "type": "number",
                        "description": "テナント情報表示権限"
                      },
                      "EditTenant": {
                        "type": "number",
                        "description": "テナント情報編集権限"
                      },
                      "ShowDesign": {
                        "type": "number",
                        "description": "デザイン情報表示権限"
                      },
                      "EditDesign": {
                        "type": "number",
                        "description": "デザイン情報編集権限"
                      },
                      "ShowOpLog": {
                        "type": "number",
                        "description": "操作ログ情報表示権限"
                      },
                      "ShowFailedPubLog": {
                        "type": "number",
                        "description": "送信失敗ログ情報表示権限"
                      },
                      "ShowUsage": {
                        "type": "number",
                        "description": "利用状況情報表示権限"
                      },
                      "ShowRestriction": {
                        "type": "number",
                        "description": "制限情報表示権限"
                      },
                      "CreateTag": {
                        "type": "number",
                        "description": "タグ作成権限"
                      },
                      "ShowTag": {
                        "type": "number",
                        "description": "タグ情報表示権限"
                      },
                      "EditTag": {
                        "type": "number",
                        "description": "タグ情報編集権限"
                      },
                      "DeleteTag": {
                        "type": "number",
                        "description": "タグ削除権限"
                      },
                      "CreateCondition": {
                        "type": "number",
                        "description": "監視条件作成権限"
                      },
                      "ShowCondition": {
                        "type": "number",
                        "description": "監視条件情報表示権限"
                      },
                      "EditCondition": {
                        "type": "number",
                        "description": "監視条件情報編集権限"
                      },
                      "DeleteCondition": {
                        "type": "number",
                        "description": "監視条件削除権限"
                      },
                      "CreateEventType": {
                        "type": "number",
                        "description": "イベント種別作成権限"
                      },
                      "ShowEventType": {
                        "type": "number",
                        "description": "イベント種別情報表示権限"
                      },
                      "EditEventType": {
                        "type": "number",
                        "description": "イベント種別情報編集権限"
                      },
                      "DeleteEventType": {
                        "type": "number",
                        "description": "イベント種別削除権限"
                      },
                      "CreateAction": {
                        "type": "number",
                        "description": "アクション作成権限"
                      },
                      "ShowAction": {
                        "type": "number",
                        "description": "アクション情報表示権限"
                      },
                      "EditAction": {
                        "type": "number",
                        "description": "アクション情報編集権限"
                      },
                      "DeleteAction": {
                        "type": "number",
                        "description": "アクション削除権限"
                      },
                      "ShowEvent": {
                        "type": "number",
                        "description": "イベント情報表示権限"
                      },
                      "ShowExecution": {
                        "type": "number",
                        "description": "実行情報表示権限"
                      },
                      "TerminateExecution": {
                        "type": "number",
                        "description": "強制停止権限"
                      },
                      "CreateAccount": {
                        "type": "number",
                        "description": "アカウント作成権限"
                      },
                      "ShowAccount": {
                        "type": "number",
                        "description": "アカウント情報表示権限"
                      },
                      "EditAccount": {
                        "type": "number",
                        "description": "アカウント情報編集権限"
                      },
                      "DeleteAccount": {
                        "type": "number",
                        "description": "アカウント削除権限"
                      },
                      "CreateUserAp": {
                        "type": "number",
                        "description": "ユーザAP作成権限"
                      },
                      "ShowUserAp": {
                        "type": "number",
                        "description": "ユーザAP情報表示権限"
                      },
                      "EditUserAp": {
                        "type": "number",
                        "description": "ユーザAP情報編集権限"
                      },
                      "DeleteUserAp": {
                        "type": "number",
                        "description": "ユーザAP削除権限"
                      }
                    }
                  }
                },
                "description": "権限"
              }
            }
          },
          "description": "権限情報"
        },
        "id": {
          "type": "number",
          "description": "テナントのid"
        },
        "mail": {
          "type": "object",
          "properties": {
            "otp": {
              "type": "object",
              "properties": {
                "body": {
                  "type": "string",
                  "description": "メール本文"
                },
                "localPart": {
                  "type": "string",
                  "description": "ローカルパート"
                },
                "subjecct": {
                  "type": "string",
                  "description": "件名"
                }
              },
              "description": "ワンタイムパスワード発行情報"
            }
          },
          "description": "メールフォーマット"
        },
        "name": {
          "type": "string",
          "description": "テナントの名前"
        },
        "userLockedThreshold": {
          "type": "number",
          "description": "テナントのアカウントロック閾値"
        },
        "saveDays": {
          "type": "object",
          "properties": {
            "events": {
              "type": "number",
              "description": "イベントデータ"
            },
            "executions": {
              "type": "number",
              "description": "コマンド実行情報"
            },
            "measurements": {
              "type": "number",
              "description": "センサーデータ"
            }
          },
          "description": "保存日数"
        },
        "isLazy": {
          "type": "object",
          "properties": {
            "deviceTree": {
              "type": "boolean",
              "description": "デバイスツリーのノード読み込み方法"
            },
            "commandTree": {
              "type": "boolean",
              "description": "コマンドツリーのノード読み込み方法"
            }
          },
          "description": "デバイス・コマンドツリーのノード読み込み方法"
        },
        "needId": {
          "type": "boolean",
          "description": "デバイスツリー表示時のIDの要否"
        },
        "needExcuteStatus": {
          "type": "boolean",
          "description": "デバイスツリー表示時の実行ステータスの要否"
        },
        "needPlace": {
          "type": "boolean",
          "description": "デバイスツリー表示時の場所の要否"
        },
        "needLatestValuee": {
          "type": "boolean",
          "description": "デバイスツリー表示時の最新値および計測日時の要否"
        },
        "tenantId": {
          "type": "string",
          "description": "テナントID"
        },
        "urls": {
          "type": "object",
          "properties": {
            "dashboard": {
              "type": "string"
            },
            "sysOpInfo": {
              "type": "string"
            }
          }
        }
      },
      "description": "テナント詳細情報"
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create": {
          "type": "boolean",
          "description": "子要素作成可能権限"
        },
        "delete": {
          "type": "boolean",
          "description": "削除権限"
        },
        "edit": {
          "type": "boolean",
          "description": "編集権限"
        },
        "execute": {
          "type": "boolean",
          "description": "実行権限"
        },
        "show": {
          "type": "boolean",
          "description": "表示権限"
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

テナント登録

テナント登録
POST/oauth2/tenant/save

処理概要

  • テナントを登録する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • バリデーションエラーのときはResponse 400が返る。

  • プラットフォーム管理者以外の場合はResponse 403が返る。

  • GETメソッドでリクエストした場合はResponse 405が返る。

Example URI

POST /oauth2/tenant/save
URI Parameters
HideShow
tenantId
string (optional) Example: tenant1

テナントID。未指定の場合、ランダムな英数字で登録。

name
string (required) Example: テナント1

テナントの名前。

userLockedThreshold
number (optional) Example: 0

テナントのアカウントロック閾値。未指定の場合、0となる。0の場合、アカウントロック機能は無効となる。

sysOpInfoUrl
string (optional) Example: http://test.com

システム運用情報URL。

dashboardUrl
string (optional) Example: http://test.com

ダッシュボードURL。

measurementsSaveDays
number (required) Example: 1

センサーデータ保存日数。

eventsSaveDays
number (required) Example: 1

イベントデータ保存日数。

executionsDataSaveDays
number (required) Example: 1

コマンド実行情報保存日数。

mailLocalpartOfOtp
string (required) Example: info

ワンタイムパスワード発行情報 ローカルパート。

mailSubjectOfOtp
string (required) Example: [DataOcean]ワンタイムパスワード発行

ワンタイムパスワード発行情報 件名。

mailBodyOfOtp
string (optional) Example: 平素より「DataOcean」をご利用いただきありがとうございます。

ワンタイムパスワード発行情報 メール本文。

deviceTreeIsLazy
boolean (optional) Example: false

デバイスツリーのノード読み込み方法 (false・・・一括、true・・・逐次)。

commandTreeIsLazy
boolean (optional) Example: false

コマンドツリーのノード読み込み方法 (false・・・一括、true・・・逐次)。

deviceTreeNeedId
boolean (optional) Example: true

デバイスツリー表示時のIDの有無 (false・・・非表示、true・・・表示)。

deviceTreeNeedExcuteStatus
boolean (optional) Example: true

デバイスツリー表示時の実行ステータスの有無 (false・・・非表示、true・・・表示)。

deviceTreeNeedPlace
boolean (optional) Example: true

デバイスツリー表示時の場所の有無 (false・・・非表示、true・・・表示)。

deviceTreeNeedLatestValue
boolean (optional) Example: false

デバイスツリー表示時の最新値の有無 (false・・・非表示、true・・・表示)。

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": {
    "id": 1
  },
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "テナントのid。"
        }
      }
    },
    "status": {
      "type": "number"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 400,
  "reason": "Bad Request",
  "detail": {
    "code": "error.validate_error",
    "message": "パラメータが不正です。",
    "errors": {
      "パラメータ名": [
        {
          "code": "nullable",
          "message": "空白は許可されません。"
        }
      ]
    }
  }
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    },
    "detail": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "エラーコード。"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ。"
        },
        "errors": {
          "type": "object",
          "properties": {
            "パラメータ名": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "エラーコード。"
                  },
                  "message": {
                    "type": "string",
                    "description": "エラーメッセージ。"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

テナント削除

テナント削除
GET/oauth2/tenant/delete/{id}

処理概要

  • IDで指定したテナントを削除する。削除対象のテナントに属する情報も削除する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • ルートテナントを指定した場合はResponse 403が返る。

  • プラットフォーム管理者以外の場合はResponse 404が返る。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/tenant/delete/1
URI Parameters
HideShow
id
string (required) Example: 1

テナントのID。

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

利用状況

利用状況一覧
GET/oauth2/usage/index

処理概要

  • 利用状況の一覧を取得する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 利用状況表示権限がないときはResponse 403が返る。

Example URI

GET /oauth2/usage/index
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": [
    {
      "daily": [
        {
          "date": "2016",
          "eventCount": 77003,
          "eventSize": 96345000000,
          "gatewayCount": 96,
          "measurementCount": 322671,
          "measurementSize": 90641000000000,
          "userCount": 78
        }
      ],
      "id": 1,
      "monthly": [
        {
          "date": "2016",
          "eventCount": 77003,
          "eventSize": 96345000000,
          "gatewayCount": 96,
          "measurementCount": 322671,
          "measurementSize": 90641000000000,
          "userCount": 78
        }
      ],
      "tenantId": "platform"
    }
  ],
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "daily": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "date": {
                  "type": "string",
                  "description": "11-11T00:00:00Z (string) - 日時"
                },
                "eventCount": {
                  "type": "number",
                  "description": "イベント件数(合計)"
                },
                "eventSize": {
                  "type": "number",
                  "description": "イベント容量(最大)"
                },
                "gatewayCount": {
                  "type": "number",
                  "description": "ゲートウェイ(最大)"
                },
                "measurementCount": {
                  "type": "number",
                  "description": "計測値件数(合計)"
                },
                "measurementSize": {
                  "type": "number",
                  "description": "計測値容量(合計)"
                },
                "userCount": {
                  "type": "number",
                  "description": "ユーザ(最大)"
                }
              }
            }
          },
          "id": {
            "type": "number",
            "description": "Usage の id"
          },
          "monthly": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "date": {
                  "type": "string",
                  "description": "11-11T00:00:00Z (string) - 日時"
                },
                "eventCount": {
                  "type": "number",
                  "description": "イベント件数(合計)"
                },
                "eventSize": {
                  "type": "number",
                  "description": "イベント容量(最大)"
                },
                "gatewayCount": {
                  "type": "number",
                  "description": "ゲートウェイ(最大)"
                },
                "measurementCount": {
                  "type": "number",
                  "description": "計測値件数(合計)"
                },
                "measurementSize": {
                  "type": "number",
                  "description": "計測値容量(合計)"
                },
                "userCount": {
                  "type": "number",
                  "description": "ユーザ(最大)"
                }
              }
            }
          },
          "tenantId": {
            "type": "string",
            "description": "テナントID"
          }
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

デバイス

デバイスツリー

デバイスツリー情報取得
GET/oauth2/device/index?showRight={showRight}

処理概要

  • デバイスツリー情報を取得する。

  • デバイスツリーはルートデバイスから、権限で可視なすべてのデバイスを一覧する。

  • isFolder項目がtrueで権限上子要素が可視の場合は子要素を持ち、それ以外では子要素を持たない。(Schema参照)

  • 権限上可視なデバイスがない場合は、ルートデバイスのみの情報を返す。ただし、ルートデバイスの表示権限がない場合はResponse 403を返す。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

Example URI

GET /oauth2/device/index?showRight=show
URI Parameters
HideShow
showRight
string (required) Example: show

デバイスツリー表示権限をshow/executeのどちらにするか。

isLazy
boolean (optional) Example: false

parent を指定した場合必須。parent で指定した要素直下の子要素のみ取得する場合 true を、配下全ノードを取得する場合 false を指定する。

parent
number (optional) Example: 111

isLazy を指定した場合必須。子要素取得対象の親要素の ID を指定する。

noSensor
boolean (optional) Example: false

ツリーからセンサーを除外する場合 true を指定する。

needLatestValue
boolean (optional) Example: false

センサーノードに最新値および計測日時が必要な場合 true を指定する。

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": {
    "children": [
      {
        "children": [
          {
            "children": [
              {
                "className": "Sensor",
                "id": 115,
                "name": "センサー0",
                "permissions": {
                  "canCreate": true,
                  "canDelete": true,
                  "canEdit": true,
                  "canShow": true,
                  "canMove": true
                },
                "place": "本社23F",
                "sensorId": "sensor0",
                "status": "Connected"
              }
            ],
            "className": "Gateway",
            "gatewayId": "gateway0",
            "id": 114,
            "name": "ゲートウェイ0",
            "permissions": {
              "canCreate": true,
              "canDelete": true,
              "canEdit": true,
              "canShow": true,
              "canMove": true
            },
            "place": "本社23F",
            "status": "Connected"
          }
        ],
        "className": "GatewayGroup",
        "id": 113,
        "name": "グループ0",
        "permissions": {
          "canCreate": true,
          "canDelete": true,
          "canEdit": true,
          "canShow": true,
          "canMove": true
        }
      }
    ],
    "className": "GatewayGroup",
    "id": 111,
    "name": "ルート",
    "permissions": {
      "canCreate": true,
      "canDelete": true,
      "canEdit": true,
      "canShow": true,
      "canMove": true
    }
  },
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "children": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "children": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "children": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "className": {
                            "type": "string",
                            "description": "クラス名"
                          },
                          "id": {
                            "type": "number",
                            "description": "デバイスのID"
                          },
                          "name": {
                            "type": "string",
                            "description": "センサーの表示名"
                          },
                          "permissions": {
                            "type": "object",
                            "properties": {
                              "canCreate": {
                                "type": "boolean",
                                "description": "子要素作成可能権限"
                              },
                              "canDelete": {
                                "type": "boolean",
                                "description": "削除権限"
                              },
                              "canEdit": {
                                "type": "boolean",
                                "description": "編集権限"
                              },
                              "canShow": {
                                "type": "boolean",
                                "description": "表示権限"
                              },
                              "canMove": {
                                "type": "boolean",
                                "description": "移動権限"
                              }
                            }
                          },
                          "place": {
                            "type": "string",
                            "description": "場所"
                          },
                          "sensorId": {
                            "type": "string",
                            "description": "センサーID"
                          },
                          "status": {
                            "type": "string",
                            "description": "状態"
                          }
                        }
                      },
                      "description": "子要素。"
                    },
                    "className": {
                      "type": "string",
                      "description": "クラス名"
                    },
                    "gatewayId": {
                      "type": "string",
                      "description": "ゲートウェイID"
                    },
                    "id": {
                      "type": "number",
                      "description": "デバイスのID"
                    },
                    "name": {
                      "type": "string",
                      "description": "ゲートウェイの表示名"
                    },
                    "permissions": {
                      "type": "object",
                      "properties": {
                        "canCreate": {
                          "type": "boolean",
                          "description": "子要素作成可能権限"
                        },
                        "canDelete": {
                          "type": "boolean",
                          "description": "削除権限"
                        },
                        "canEdit": {
                          "type": "boolean",
                          "description": "編集権限"
                        },
                        "canShow": {
                          "type": "boolean",
                          "description": "表示権限"
                        },
                        "canMove": {
                          "type": "boolean",
                          "description": "移動権限"
                        }
                      }
                    },
                    "place": {
                      "type": "string",
                      "description": "場所"
                    },
                    "status": {
                      "type": "string",
                      "description": "状態"
                    }
                  }
                },
                "description": "子要素。"
              },
              "className": {
                "type": "string",
                "description": "クラス名"
              },
              "id": {
                "type": "number",
                "description": "デバイスのID"
              },
              "name": {
                "type": "string",
                "description": "ゲートウェイグループの表示名"
              },
              "permissions": {
                "type": "object",
                "properties": {
                  "canCreate": {
                    "type": "boolean",
                    "description": "子要素作成可能権限"
                  },
                  "canDelete": {
                    "type": "boolean",
                    "description": "削除権限"
                  },
                  "canEdit": {
                    "type": "boolean",
                    "description": "編集権限"
                  },
                  "canShow": {
                    "type": "boolean",
                    "description": "表示権限"
                  },
                  "canMove": {
                    "type": "boolean",
                    "description": "移動権限"
                  }
                }
              }
            }
          },
          "description": "子要素。"
        },
        "className": {
          "type": "string",
          "description": "クラス名"
        },
        "id": {
          "type": "number",
          "description": "デバイスのID"
        },
        "name": {
          "type": "string",
          "description": "ルートデバイスの表示名"
        },
        "permissions": {
          "type": "object",
          "properties": {
            "canCreate": {
              "type": "boolean",
              "description": "子要素作成可能権限"
            },
            "canDelete": {
              "type": "boolean",
              "description": "削除権限"
            },
            "canEdit": {
              "type": "boolean",
              "description": "編集権限"
            },
            "canShow": {
              "type": "boolean",
              "description": "表示権限"
            },
            "canMove": {
              "type": "boolean",
              "description": "移動権限"
            }
          }
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow
Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

ゲートウェイグループ情報取得

ゲートウェイグループ情報取得
GET/oauth2/gatewayGroup/show/{id}

処理概要

  • idで指定されたゲートウェイグループの情報を返す。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視なゲートウェイグループを指定した場合はResponse 403が返る。

  • 存在しないゲートウェイグループを指定した場合(存在するゲートウェイのidやセンサーのidを指定した場合も含む)はResponse 404が返る。

Example URI

GET /oauth2/gatewayGroup/show/111
URI Parameters
HideShow
id
number (required) Example: 111

ゲートウェイグループのID

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": {
    "id": 113,
    "acl": [
      {
        "inherit": false,
        "permission": {
          "id": 26,
          "accountId": "user0@example.com",
          "className": "TreeablePermission",
          "rights": {
            "CreateChildren": 2,
            "Show": 0,
            "ShowChildren": 2,
            "Edit": 0,
            "EditChildren": 2,
            "Delete": 2,
            "DeleteChildren": 2,
            "Execute": 2,
            "ExecuteChildren": 2
          }
        }
      }
    ],
    "details": "サンプルグループ",
    "name": "グループ0",
    "place": "本社23階"
  },
  "permissions": {
    "create": true,
    "delete": true,
    "edit": true,
    "execute": true,
    "show": true
  },
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "ゲートウェイグループのID"
        },
        "acl": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "inherit": {
                "type": "boolean",
                "description": "上位権限を継承したかどうか"
              },
              "permission": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "description": "権限のID"
                  },
                  "accountId": {
                    "type": "string",
                    "description": "アカウントID"
                  },
                  "className": {
                    "type": "string",
                    "description": "クラス名"
                  },
                  "rights": {
                    "type": "object",
                    "properties": {
                      "CreateChildren": {
                        "type": "number",
                        "description": "子要素作成権限"
                      },
                      "Show": {
                        "type": "number",
                        "description": "表示権限"
                      },
                      "ShowChildren": {
                        "type": "number",
                        "description": "子要素表示権限"
                      },
                      "Edit": {
                        "type": "number",
                        "description": "編集権限"
                      },
                      "EditChildren": {
                        "type": "number",
                        "description": "子要素編集権限"
                      },
                      "Delete": {
                        "type": "number",
                        "description": "削除権限"
                      },
                      "DeleteChildren": {
                        "type": "number",
                        "description": "子要素削除権限"
                      },
                      "Execute": {
                        "type": "number",
                        "description": "実行権限"
                      },
                      "ExecuteChildren": {
                        "type": "number",
                        "description": "子要素実行権限"
                      }
                    }
                  }
                },
                "description": "権限"
              }
            }
          },
          "description": "権限情報"
        },
        "details": {
          "type": "string",
          "description": "詳細"
        },
        "name": {
          "type": "string",
          "description": "名前"
        },
        "place": {
          "type": "string",
          "description": "場所"
        }
      }
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create": {
          "type": "boolean",
          "description": "子要素作成可能権限"
        },
        "delete": {
          "type": "boolean",
          "description": "削除権限"
        },
        "edit": {
          "type": "boolean",
          "description": "編集権限"
        },
        "execute": {
          "type": "boolean",
          "description": "実行権限"
        },
        "show": {
          "type": "boolean",
          "description": "表示権限"
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

ゲートウェイグループ情報更新

ゲートウェイグループ情報更新
POST/oauth2/gatewayGroup/update

処理概要

  • idで指定されたゲートウェイグループの情報を更新する。

  • ルートゲートウェイグループは、必ず、inherit が false になる。

  • バリデーションエラーのときはResponse 400が返る。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視なゲートウェイグループを指定した場合はResponse 403が返る。

  • 存在しないゲートウェイグループを指定した場合(存在するゲートウェイのidやセンサーのidを指定した場合も含む)はResponse 404が返る。

  • GETメソッドでリクエストした場合はResponse 405が返る。

Example URI

POST /oauth2/gatewayGroup/update
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Body
{
  "id": 111,
  "name": "グループ0",
  "place": "本社23階",
  "details": "サンプルグループ",
  "inherit": false,
  "account": {
    "アカウントのID1": {
      "CreateChildren": 2,
      "Show": 2,
      "ShowChildren": 2,
      "Edit": 2,
      "EditChildren": 2,
      "Delete": 2,
      "DeleteChildren": 2,
      "Execute": 2
    },
    "アカウントのID2": {
      "CreateChildren": 0,
      "Show": 1,
      "ShowChildren": 2,
      "Edit": 0,
      "EditChildren": 1,
      "Delete": 2,
      "DeleteChildren": 0,
      "Execute": 1
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "ゲートウェイグループのID"
    },
    "name": {
      "type": "string",
      "description": "名前"
    },
    "place": {
      "type": "string",
      "description": "場所"
    },
    "details": {
      "type": "string",
      "description": "詳細"
    },
    "inherit": {
      "type": "boolean",
      "description": "上位権限を継承したかどうか"
    },
    "account": {
      "type": "object",
      "properties": {
        "アカウントのID1": {
          "type": "object",
          "properties": {
            "CreateChildren": {
              "type": "number",
              "description": "子要素作成権限。"
            },
            "Show": {
              "type": "number",
              "description": "表示権限。"
            },
            "ShowChildren": {
              "type": "number",
              "description": "子要素表示権限。"
            },
            "Edit": {
              "type": "number",
              "description": "詳細。"
            },
            "EditChildren": {
              "type": "number",
              "description": "詳細。"
            },
            "Delete": {
              "type": "number",
              "description": "詳細。"
            },
            "DeleteChildren": {
              "type": "number",
              "description": "詳細。"
            },
            "Execute": {
              "type": "number",
              "description": "詳細。"
            }
          }
        },
        "アカウントのID2": {
          "type": "object",
          "properties": {
            "CreateChildren": {
              "type": "number",
              "description": "子要素作成権限。"
            },
            "Show": {
              "type": "number",
              "description": "表示権限。"
            },
            "ShowChildren": {
              "type": "number",
              "description": "子要素表示権限。"
            },
            "Edit": {
              "type": "number",
              "description": "詳細。"
            },
            "EditChildren": {
              "type": "number",
              "description": "詳細。"
            },
            "Delete": {
              "type": "number",
              "description": "詳細。"
            },
            "DeleteChildren": {
              "type": "number",
              "description": "詳細。"
            },
            "Execute": {
              "type": "number",
              "description": "詳細。"
            }
          }
        }
      },
      "description": "1アカウントについての権限設定をアカウントのIDをキーとする連想配列。値は、各権限を示す文字をキーとする連想配列。値のキーはそれぞれ、CreateChilrenは子要素作成権限、Showは表示権限、ShowChildrenは子要素表示権限、Editは編集権限、EditChildrenは子要素編集権限、Deleteは削除権限、DeleteChildrenは子要素削除権限、Executeは実行権限、ExecuteChildrenは子要素実行権限を示す。各権限の値は、0:未設定、1:拒否、2:許可の内いずれかの数値を指定する。"
    }
  },
  "required": [
    "id",
    "inherit",
    "account"
  ]
}
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 400,
  "reason": "Bad Request",
  "detail": {
    "code": "error.validate_error",
    "message": "パラメータが不正です。",
    "errors": {
      "パラメータ名": [
        {
          "code": "nullable",
          "message": "空白は許可されません。"
        }
      ]
    }
  }
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    },
    "detail": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "エラーコード。"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ。"
        },
        "errors": {
          "type": "object",
          "properties": {
            "パラメータ名": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "エラーコード。"
                  },
                  "message": {
                    "type": "string",
                    "description": "エラーメッセージ。"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

ゲートウェイグループ情報削除

ゲートウェイグループ情報削除
GET/oauth2/gatewayGroup/delete/{id}

処理概要

  • IDで指定したゲートウェイグループを削除する。削除対象のゲートウェイグループの配下にあるゲートウェイなどの子要素も削除する。

  • ルートゲートウェイグループを指定したときはResponse 400が返る。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上削除できないゲートウェイグループを指定した場合はResponse 403が返る。

  • 存在しないゲートウェイグループを指定した場合(存在するゲートウェイのidやセンサーのidを指定した場合も含む)はResponse 404が返る。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/gatewayGroup/delete/1
URI Parameters
HideShow
id
string (required) Example: 1

ゲートウェイグループのID。

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application / json
Body
{
  "detail": {
    "code": "error.bad_request.delete.root.gatewaygroup",
    "message": "最上位のゲートウェイグループを削除することはできません。"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "detail": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "エラーコード。"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ。"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

ゲートウェイ情報取得

ゲートウェイ情報取得
GET/oauth2/gateway/show/{id}

処理概要

  • idで指定されたゲートウェイの情報を返す。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視なゲートウェイを指定した場合はResponse 403が返る。

  • 存在しないゲートウェイを指定した場合(存在するゲートウェイグループのidやセンサーのidを指定した場合も含む)はResponse 404が返る。

Example URI

GET /oauth2/gateway/show/111
URI Parameters
HideShow
id
number (required) Example: 111

ゲートウェイのID

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": {
    "id": 114,
    "acl": [
      {
        "inherit": false,
        "permission": {
          "id": 26,
          "accountId": "user0@example.com",
          "className": "TreeablePermission",
          "rights": {
            "CreateChildren": 2,
            "Show": 0,
            "ShowChildren": 2,
            "Edit": 0,
            "EditChildren": 2,
            "Delete": 2,
            "DeleteChildren": 2,
            "Execute": 2,
            "ExecuteChildren": 2
          }
        }
      }
    ],
    "details": "サンプルゲートウェイ",
    "gatewayId": "gateway_0-0",
    "name": "ゲートウェイ0-0",
    "place": "本社23階",
    "status": "Connected",
    "meta": "メタデータ",
    "updateStatusDate": "2016-12-14T07:28:12.175429Z[UTC]",
    "requestStatusDate": "2016-12-14T07:26:47.923790Z[UTC]"
  },
  "permissions": {
    "create": true,
    "delete": true,
    "edit": true,
    "execute": true,
    "show": true
  },
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "ゲートウェイのID"
        },
        "acl": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "inherit": {
                "type": "boolean",
                "description": "上位権限を継承したかどうか"
              },
              "permission": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "description": "権限のID"
                  },
                  "accountId": {
                    "type": "string",
                    "description": "アカウントID"
                  },
                  "className": {
                    "type": "string",
                    "description": "クラス名"
                  },
                  "rights": {
                    "type": "object",
                    "properties": {
                      "CreateChildren": {
                        "type": "number",
                        "description": "子要素作成権限"
                      },
                      "Show": {
                        "type": "number",
                        "description": "表示権限"
                      },
                      "ShowChildren": {
                        "type": "number",
                        "description": "子要素表示権限"
                      },
                      "Edit": {
                        "type": "number",
                        "description": "編集権限"
                      },
                      "EditChildren": {
                        "type": "number",
                        "description": "子要素編集権限"
                      },
                      "Delete": {
                        "type": "number",
                        "description": "削除権限"
                      },
                      "DeleteChildren": {
                        "type": "number",
                        "description": "子要素削除権限"
                      },
                      "Execute": {
                        "type": "number",
                        "description": "実行権限"
                      },
                      "ExecuteChildren": {
                        "type": "number",
                        "description": "子要素実行権限"
                      }
                    }
                  }
                },
                "description": "権限"
              }
            }
          },
          "description": "権限情報"
        },
        "details": {
          "type": "string",
          "description": "詳細"
        },
        "gatewayId": {
          "type": "string",
          "description": "ゲートウェイID"
        },
        "name": {
          "type": "string",
          "description": "名前"
        },
        "place": {
          "type": "string",
          "description": "場所"
        },
        "status": {
          "type": "string",
          "description": "ステータス"
        },
        "meta": {
          "type": "string",
          "description": "メタデータ。メタデータが存在した場合のみ。"
        },
        "updateStatusDate": {
          "type": "string",
          "description": "状態更新日時"
        },
        "requestStatusDate": {
          "type": "string",
          "description": "状態更新要求日時"
        }
      }
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create": {
          "type": "boolean",
          "description": "子要素作成可能権限"
        },
        "delete": {
          "type": "boolean",
          "description": "削除権限"
        },
        "edit": {
          "type": "boolean",
          "description": "編集権限"
        },
        "execute": {
          "type": "boolean",
          "description": "実行権限"
        },
        "show": {
          "type": "boolean",
          "description": "表示権限"
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

ゲートウェイ情報更新

ゲートウェイ情報更新
POST/oauth2/gateway/update

処理概要

  • idで指定されたゲートウェイの情報を更新する。

  • バリデーションエラーのときはResponse 400が返る。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視なゲートウェイを指定した場合はResponse 403が返る。

  • 存在しないゲートウェイを指定した場合(存在するゲートウェイグループのidやセンサーのidを指定した場合も含む)はResponse 404が返る。

  • GETメソッドでリクエストした場合はResponse 405が返る。

Example URI

POST /oauth2/gateway/update
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Body
{
  "id": 111,
  "gatewayId": "gateway_0-0",
  "name": "ゲートウェイ0-0",
  "place": "本社23階",
  "details": "サンプルグループ",
  "inherit": false,
  "account": {
    "アカウントのID1": {
      "CreateChildren": 2,
      "Show": 2,
      "ShowChildren": 2,
      "Edit": 2,
      "EditChildren": 2,
      "Delete": 2,
      "DeleteChildren": 2,
      "Execute": 2
    },
    "アカウントのID2": {
      "CreateChildren": 0,
      "Show": 1,
      "ShowChildren": 2,
      "Edit": 0,
      "EditChildren": 1,
      "Delete": 2,
      "DeleteChildren": 0,
      "Execute": 1
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "ゲートウェイのID"
    },
    "gatewayId": {
      "type": "string",
      "description": "ゲートウェイID"
    },
    "name": {
      "type": "string",
      "description": "名前"
    },
    "place": {
      "type": "string",
      "description": "場所"
    },
    "details": {
      "type": "string",
      "description": "詳細"
    },
    "inherit": {
      "type": "boolean",
      "description": "上位権限を継承したかどうか"
    },
    "account": {
      "type": "object",
      "properties": {
        "アカウントのID1": {
          "type": "object",
          "properties": {
            "CreateChildren": {
              "type": "number",
              "description": "子要素作成権限。"
            },
            "Show": {
              "type": "number",
              "description": "表示権限。"
            },
            "ShowChildren": {
              "type": "number",
              "description": "子要素表示権限。"
            },
            "Edit": {
              "type": "number",
              "description": "詳細。"
            },
            "EditChildren": {
              "type": "number",
              "description": "詳細。"
            },
            "Delete": {
              "type": "number",
              "description": "詳細。"
            },
            "DeleteChildren": {
              "type": "number",
              "description": "詳細。"
            },
            "Execute": {
              "type": "number",
              "description": "詳細。"
            }
          }
        },
        "アカウントのID2": {
          "type": "object",
          "properties": {
            "CreateChildren": {
              "type": "number",
              "description": "子要素作成権限。"
            },
            "Show": {
              "type": "number",
              "description": "表示権限。"
            },
            "ShowChildren": {
              "type": "number",
              "description": "子要素表示権限。"
            },
            "Edit": {
              "type": "number",
              "description": "詳細。"
            },
            "EditChildren": {
              "type": "number",
              "description": "詳細。"
            },
            "Delete": {
              "type": "number",
              "description": "詳細。"
            },
            "DeleteChildren": {
              "type": "number",
              "description": "詳細。"
            },
            "Execute": {
              "type": "number",
              "description": "詳細。"
            }
          }
        }
      },
      "description": "1アカウントについての権限設定をアカウントのIDをキーとする連想配列。値は、各権限を示す文字をキーとする連想配列。値のキーはそれぞれ、CreateChilrenは子要素作成権限、Showは表示権限、ShowChildrenは子要素表示権限、Editは編集権限、EditChildrenは子要素編集権限、Deleteは削除権限、DeleteChildrenは子要素削除権限、Executeは実行権限、ExecuteChildrenは子要素実行権限を示す。各権限の値は、0:未設定、1:拒否、2:許可の内いずれかの数値を指定する。"
    }
  },
  "required": [
    "id",
    "inherit",
    "account"
  ]
}
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 400,
  "reason": "Bad Request",
  "detail": {
    "code": "error.validate_error",
    "message": "パラメータが不正です。",
    "errors": {
      "パラメータ名": [
        {
          "code": "nullable",
          "message": "空白は許可されません。"
        }
      ]
    }
  }
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    },
    "detail": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "エラーコード。"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ。"
        },
        "errors": {
          "type": "object",
          "properties": {
            "パラメータ名": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "エラーコード。"
                  },
                  "message": {
                    "type": "string",
                    "description": "エラーメッセージ。"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

ゲートウェイ情報削除

ゲートウェイ情報削除
GET/oauth2/gateway/delete/{id}

処理概要

  • IDで指定したゲートウェイを削除する。削除対象のゲートウェイの配下にあるセンサーなどの子要素も削除する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上削除できないゲートウェイを指定した場合はResponse 403が返る。

  • 存在しないゲートウェイを指定した場合(存在するゲートウェイグループのidやセンサーのidを指定した場合も含む)はResponse 404が返る。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/gateway/delete/1
URI Parameters
HideShow
id
string (required) Example: 1

ゲートウェイのID。

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

センサー情報取得

センサー情報取得
GET/oauth2/sensor/show/{id}

処理概要

  • idで指定されたセンサーの情報を返す。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視なセンサーを指定した場合はResponse 403が返る。

  • 存在しないセンサーを指定した場合(存在するゲートウェイグループのidやゲートウェイのidを指定した場合も含む)はResponse 404が返る。

Example URI

GET /oauth2/sensor/show/111
URI Parameters
HideShow
id
number (required) Example: 111

センサーのID

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": {
    "id": 115,
    "acl": [
      {
        "inherit": false,
        "permission": {
          "id": 26,
          "accountId": "user0@example.com",
          "className": "TreeablePermission",
          "rights": {
            "CreateChildren": 2,
            "Show": 0,
            "ShowChildren": 2,
            "Edit": 0,
            "EditChildren": 2,
            "Delete": 2,
            "DeleteChildren": 2,
            "Execute": 2,
            "ExecuteChildren": 2
          }
        }
      }
    ],
    "details": "サンプルセンサー",
    "sensorId": "sensor_0-0",
    "name": "センサー0-0",
    "place": "本社23階",
    "status": "Connected",
    "meta": "メタデータ",
    "updateStatusDate": "2016-12-14T07:28:12.175429Z[UTC]",
    "requestStatusDate": "2016-12-14T07:26:47.923790Z[UTC]",
    "tags": [
      {
        "id": 171,
        "name": "タグ 0022",
        "tagCode": "t0022"
      }
    ],
    "yaxis": {
      "id": 116,
      "name": "縦軸1"
    }
  },
  "permissions": {
    "create": true,
    "delete": true,
    "edit": true,
    "execute": true,
    "show": true
  },
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "センサーのID"
        },
        "acl": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "inherit": {
                "type": "boolean",
                "description": "上位権限を継承したかどうか"
              },
              "permission": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "description": "権限のID"
                  },
                  "accountId": {
                    "type": "string",
                    "description": "アカウントID"
                  },
                  "className": {
                    "type": "string",
                    "description": "クラス名"
                  },
                  "rights": {
                    "type": "object",
                    "properties": {
                      "CreateChildren": {
                        "type": "number",
                        "description": "子要素作成権限"
                      },
                      "Show": {
                        "type": "number",
                        "description": "表示権限"
                      },
                      "ShowChildren": {
                        "type": "number",
                        "description": "子要素表示権限"
                      },
                      "Edit": {
                        "type": "number",
                        "description": "編集権限"
                      },
                      "EditChildren": {
                        "type": "number",
                        "description": "子要素編集権限"
                      },
                      "Delete": {
                        "type": "number",
                        "description": "削除権限"
                      },
                      "DeleteChildren": {
                        "type": "number",
                        "description": "子要素削除権限"
                      },
                      "Execute": {
                        "type": "number",
                        "description": "実行権限"
                      },
                      "ExecuteChildren": {
                        "type": "number",
                        "description": "子要素実行権限"
                      }
                    }
                  }
                },
                "description": "権限"
              }
            }
          },
          "description": "権限情報"
        },
        "details": {
          "type": "string",
          "description": "詳細"
        },
        "sensorId": {
          "type": "string",
          "description": "センサーID"
        },
        "name": {
          "type": "string",
          "description": "名前"
        },
        "place": {
          "type": "string",
          "description": "場所"
        },
        "status": {
          "type": "string",
          "description": "ステータス"
        },
        "meta": {
          "type": "string",
          "description": "メタデータ。メタデータが存在した場合のみ。"
        },
        "updateStatusDate": {
          "type": "string",
          "description": "所属するゲートウェイの状態更新日時"
        },
        "requestStatusDate": {
          "type": "string",
          "description": "所属するゲートウェイの状態更新要求日時"
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "タグID"
              },
              "name": {
                "type": "string",
                "description": "タグ名"
              },
              "tagCode": {
                "type": "string",
                "description": "タグコード"
              }
            }
          },
          "description": "タグ情報"
        },
        "yaxis": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "description": "グラフ縦軸定義のID"
            },
            "name": {
              "type": "string",
              "description": "グラフ縦軸定義の名前"
            }
          },
          "description": "グラフ縦軸定義。未設定の場合はNULL。"
        }
      }
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create": {
          "type": "boolean",
          "description": "子要素作成可能権限"
        },
        "delete": {
          "type": "boolean",
          "description": "削除権限"
        },
        "edit": {
          "type": "boolean",
          "description": "編集権限"
        },
        "execute": {
          "type": "boolean",
          "description": "実行権限"
        },
        "show": {
          "type": "boolean",
          "description": "表示権限"
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

センサー情報更新

センサー情報更新
POST/oauth2/sensor/update

処理概要

  • idで指定されたセンサーの情報を更新する。

  • バリデーションエラーのときはResponse 400が返る。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視なセンサーを指定した場合はResponse 403が返る。

  • 存在しないセンサーを指定した場合(存在するゲートウェイグループのidやゲートウェイのidを指定した場合も含む)はResponse 404が返る。

  • GETメソッドでリクエストした場合はResponse 405が返る。

Example URI

POST /oauth2/sensor/update
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Body
{
  "id": 111,
  "sensorId": "sensor_0-0",
  "name": "センサー0-0",
  "place": "本社23階",
  "details": "サンプルグループ",
  "inherit": false,
  "account": {
    "アカウントのID1": {
      "CreateChildren": 2,
      "Show": 2,
      "ShowChildren": 2,
      "Edit": 2,
      "EditChildren": 2,
      "Delete": 2,
      "DeleteChildren": 2,
      "Execute": 2
    },
    "アカウントのID2": {
      "CreateChildren": 0,
      "Show": 1,
      "ShowChildren": 2,
      "Edit": 0,
      "EditChildren": 1,
      "Delete": 2,
      "DeleteChildren": 0,
      "Execute": 1
    }
  },
  "tags": [
    1,
    2
  ],
  "yaxis": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "センサーのID"
    },
    "sensorId": {
      "type": "string",
      "description": "センサーID"
    },
    "name": {
      "type": "string",
      "description": "名前"
    },
    "place": {
      "type": "string",
      "description": "場所"
    },
    "details": {
      "type": "string",
      "description": "詳細"
    },
    "inherit": {
      "type": "boolean",
      "description": "上位権限を継承したかどうか"
    },
    "account": {
      "type": "object",
      "properties": {
        "アカウントのID1": {
          "type": "object",
          "properties": {
            "CreateChildren": {
              "type": "number",
              "description": "子要素作成権限。"
            },
            "Show": {
              "type": "number",
              "description": "表示権限。"
            },
            "ShowChildren": {
              "type": "number",
              "description": "子要素表示権限。"
            },
            "Edit": {
              "type": "number",
              "description": "詳細。"
            },
            "EditChildren": {
              "type": "number",
              "description": "詳細。"
            },
            "Delete": {
              "type": "number",
              "description": "詳細。"
            },
            "DeleteChildren": {
              "type": "number",
              "description": "詳細。"
            },
            "Execute": {
              "type": "number",
              "description": "詳細。"
            }
          }
        },
        "アカウントのID2": {
          "type": "object",
          "properties": {
            "CreateChildren": {
              "type": "number",
              "description": "子要素作成権限。"
            },
            "Show": {
              "type": "number",
              "description": "表示権限。"
            },
            "ShowChildren": {
              "type": "number",
              "description": "子要素表示権限。"
            },
            "Edit": {
              "type": "number",
              "description": "詳細。"
            },
            "EditChildren": {
              "type": "number",
              "description": "詳細。"
            },
            "Delete": {
              "type": "number",
              "description": "詳細。"
            },
            "DeleteChildren": {
              "type": "number",
              "description": "詳細。"
            },
            "Execute": {
              "type": "number",
              "description": "詳細。"
            }
          }
        }
      },
      "description": "1アカウントについての権限設定をアカウントのIDをキーとする連想配列。値は、各権限を示す文字をキーとする連想配列。値のキーはそれぞれ、CreateChilrenは子要素作成権限、Showは表示権限、ShowChildrenは子要素表示権限、Editは編集権限、EditChildrenは子要素編集権限、Deleteは削除権限、DeleteChildrenは子要素削除権限、Executeは実行権限、ExecuteChildrenは子要素実行権限を示す。各権限の値は、0:未設定、1:拒否、2:許可の内いずれかの数値を指定する。"
    },
    "tags": {
      "type": "array",
      "description": "タグのIDの配列"
    },
    "yaxis": {
      "type": "number",
      "description": "グラフ縦軸定義のID"
    }
  },
  "required": [
    "id",
    "inherit",
    "account"
  ]
}
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 400,
  "reason": "Bad Request",
  "detail": {
    "code": "error.validate_error",
    "message": "パラメータが不正です。",
    "errors": {
      "パラメータ名": [
        {
          "code": "nullable",
          "message": "空白は許可されません。"
        }
      ]
    }
  }
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    },
    "detail": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "エラーコード。"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ。"
        },
        "errors": {
          "type": "object",
          "properties": {
            "パラメータ名": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "エラーコード。"
                  },
                  "message": {
                    "type": "string",
                    "description": "エラーメッセージ。"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

センサー情報削除

センサー情報削除
GET/oauth2/sensor/delete/{id}

処理概要

  • IDで指定したセンサーを削除する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上削除できないセンサーを指定した場合はResponse 403が返る。

  • 存在しないセンサーを指定した場合(存在するゲートウェイグループのidやゲートウェイのidを指定した場合も含む)はResponse 404が返る。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/sensor/delete/1
URI Parameters
HideShow
id
string (required) Example: 1

センサーのID。

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

グラフ縦軸定義

グラフ縦軸定義取得
GET/oauth2/yaxis/list

処理概要

  • センサーのidで指定されたセンサーに関連するグラフ縦軸定義の情報を返す。

  • センサーのidは配列で指定し、返却するグラフ縦軸定義も配列となる。

  • 指定した複数のセンサーで同一のグラフ縦軸定義を設定している場合、返却するグラフ縦軸定義は重複しない。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • グラフ縦軸定義表示権限がない場合はResponse 403が返る。

  • GETメソッド以外でリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/yaxis/list
URI Parameters
HideShow
sensors
array[number] (required) Example: 111,222

センサーのIDの配列

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200,
  "data": [
    {
      "id": 1,
      "name": "温度A",
      "description": "軸の詳細内容",
      "prefix": "外",
      "suffix": "度",
      "useFixed": false,
      "totalDigits": 13,
      "decimalDigits": 3,
      "usePercent": false,
      "useComma": false,
      "maxValue": 10000,
      "minValue": 0,
      "sensors": [
        {
          "id": 1,
          "sensorId": "sensor0",
          "name": "センサー0-0"
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "グラフ縦軸定義のid"
          },
          "name": {
            "type": "string",
            "description": "名前"
          },
          "description": {
            "type": "string",
            "description": "説明"
          },
          "prefix": {
            "type": "string",
            "description": "単位表示(接頭文字)"
          },
          "suffix": {
            "type": "string",
            "description": "単位表示(接尾文字)"
          },
          "useFixed": {
            "type": "boolean",
            "description": "固定小数点の使用有無(true:使用する、false:使用しない)"
          },
          "totalDigits": {
            "type": "number",
            "description": "固定小数点の総桁数"
          },
          "decimalDigits": {
            "type": "number",
            "description": "固定小数点の小数部桁数"
          },
          "usePercent": {
            "type": "boolean",
            "description": "パーセント変換の有無(true:使用する、false:使用しない)"
          },
          "useComma": {
            "type": "boolean",
            "description": "カンマ区切りの使用有無(true:使用する、false:使用しない)"
          },
          "maxValue": {
            "type": "number",
            "description": "最大値"
          },
          "minValue": {
            "type": "number",
            "description": "最小値"
          },
          "sensors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "description": "デバイスのID"
                },
                "sensorId": {
                  "type": "string",
                  "description": "センサーID"
                },
                "name": {
                  "type": "string",
                  "description": "名前"
                }
              }
            },
            "description": "グラフ縦軸定義に関連するセンサー"
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

可視化

グラフ

グラフデータ取得
POST/oauth2/measurement/chart

処理概要

  • グラフ表示と同じ条件を指定して、グラフ作成のために使用するのと同じデータを取得する。

  • headerタグの値は文字型配列で、先頭の値は固定文字列"x"となっとており、それ以降に出力対象センサー名が列挙されている。

  • dataタグの値は数値の二次元配列になっている。

    • 二次元目の列数はheaderタグの配列と同数であり、先頭の値が時刻印、それ以降がheaderタグと同じ順に出力対象センサーのその時刻員のときの値が入る。
    • 複数の値を持つセンサーの場合、その先頭の値だけが入る。
  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 指定したセンサーが存在しない場合、特にエラーは発生せず、存在しないセンサーの情報がスキップされる。すべてのセンサーが存在しない場合は、空の情報が返る。

  • total には、センサー毎の指定期間におけるデータ件数が列挙される。 collecttype に COUNT を指定した場合、センサー毎の全期間のデータ件数が列挙される。

  • nullable に true を指定した場合、その時刻に値が無いセンサーの値は null となる。 未指定もしくは false を指定した場合は、値が無いセンサーの値は 0 となる。

例:

headerタグの情報

x,センサー0,センサー1,センサー2

dataタグの情報

1476169966960,7104,1894,31688

1476169968214,8063,32216,31971

の場合、

時刻印1476169966960 のときのセンサー0の値が7104、センサー1の値が1894、センサー2の値が31688 となり、 時刻印1476169968214 のときのセンサー0の値が8063、センサー1の値が32216、センサー2の値が31971 となる。

Example URI

POST /oauth2/measurement/chart
URI Parameters
HideShow
collecttype
enum (required) Example: COUNT,SPAN

データ取得件数か期間か。 COUNT/SPAN

count
number (optional) Example: 100

データ取得件数 (collecttype=COUNT時のみ[必須])

start
string (optional) Example: 2016/10/10 15:00

取得開始日時 (collecttype=SPAN時のみ[必須])

end
string (optional) Example: 2016/10/10 16:00

取得終了日時 (collecttype=SPAN時[必須])

range
number (optional) Example: 10

集約範囲 (collecttype=SPAN時のみ[任意])

units
enum (optional) Example: MIN,HOUR,DATE,WEEK,MONTH,QUARTER,YEAR

集約単位 (collecttype=SPAN時のみ[必須])MIN/HOUR/DATE/WEEK/MONTH/QUARTER/YEAR

max
boolean (optional) Example: false

集約種別:最大 (collecttype=SPAN時のみ[任意])

min
boolean (optional) Example: false

集約種別:最小 (collecttype=SPAN時のみ[任意])

avg
boolean (optional) Example: false

集約種別:平均 (collecttype=SPAN時のみ[任意])

cnt
boolean (optional) Example: false

集約種別:件数 (collecttype=SPAN時のみ[任意])

tzone
number (required) Example: -540

クライアントのTIMEZONE:分 (collecttype=SPAN時のみ[必須])

sensors
array[number] (required) Example: 111, 112

グラフ対象センサーのIDの配列

nullable
boolean (optional) Example: false

true の場合、その時刻に値が無いセンサーの値は null とする。それ以外の場合は 0 とする。

Request
HideShow
Headers
Content-Type: application / json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    [
      [
        1476169966960,
        12333,
        344444
      ]
    ]
  ],
  "total": [
    {
      "センサー名": 123
    }
  ],
  "header": [
    "x",
    "センサー1",
    "センサー 2"
  ],
  "status": 200
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "description": "時刻印,センサーの値,.."
    },
    "total": {
      "type": "array",
      "description": "センサー毎の指定期間におけるデータ件数 (collecttype が COUNT の場合、全期間における件数)"
    },
    "header": {
      "type": "array",
      "description": "固定値\"x\", センサーの値,..."
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

グラフ生データ取得

グラフ生データ取得
POST/oauth2/measurement/list

処理概要

  • センサーID、データ取得件数またはデータ取得範囲を指定して、センサーのデータそのものを取得する。データの集約は行わない。

  • グラフデータ取得と異なり、データはセンサー単位で、時刻印と値の組で取得される。複数の値を持つ場合にはそれらがすべて取得される。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 指定したセンサーが存在しない場合、特にエラーは発生せず、存在しないセンサーの情報がスキップされる。すべてのセンサーが存在しない場合は、空の情報が返る。

  • totalCount には、センサー毎の指定期間におけるデータ件数が列挙される。 collecttype に COUNT を指定した場合、センサー毎の全期間のデータ件数が列挙される。

Example URI

POST /oauth2/measurement/list
URI Parameters
HideShow
collecttype
enum (required) Example: COUNT,SPAN

データ取得件数か期間か。 COUNT/SPAN

count
number (optional) Example: 100

データ取得件数 (collecttype=COUNT時のみ[必須])

start
string (optional) Example: 2016/10/10 15:00

取得開始日時 (collecttype=SPAN時のみ[必須])

end
string (optional) Example: 2016/10/10 16:00

取得終了日時 (collecttype=SPAN時のみ[必須])

tzone
number (required) Example: -540

クライアントのTIMEZONE:分 (collecttype=SPAN時のみ[必須])

sensors
array[number] (required) Example: 111, 112

グラフ対象センサーのIDの配列

Request
HideShow
Headers
Content-Type: application / json
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": [
    {
      "sensor_id": "sensor0",
      "sensor_name": "センサー 0",
      "aggs_type": "",
      "data": [
        {
          "datetime": 1476432000460,
          "values": [
            1234,
            56789
          ]
        }
      ],
      "totalCount": 123
    }
  ],
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sensor_id": {
            "type": "string",
            "description": "センサーID"
          },
          "sensor_name": {
            "type": "string",
            "description": "名前"
          },
          "aggs_type": {
            "type": "string",
            "description": "未使用"
          },
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "datetime": {
                  "type": "number"
                },
                "values": {
                  "type": "array",
                  "items": {
                    "type": "number"
                  },
                  "description": "データの実測値"
                }
              }
            },
            "description": "該当センサーのデータ"
          },
          "totalCount": {
            "type": "number",
            "description": "センサー毎の指定期間におけるデータ件数 (collecttype が COUNT の場合、全期間における件数)"
          }
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow
Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

取得

長期間データダウンロード

長期間データダウンロード
POST/oauth2/measurement/download

処理概要

  • 長期間の計測データ(生データ)を取得する機能。長期間のデータが取得可能で、データの集約は行わない。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視なセンサーを指定した場合はResponse 403が返る。

  • 存在しないセンサーを指定した場合や、センサーを未指定の場合、空のデータが返る。

Example URI

POST /oauth2/measurement/download
URI Parameters
HideShow
sensors
array[number] (required) Example: 37

データ取得対象センサーの ID 配列

start
string (required) Example: 2016-12-14T15:00:00.000Z

データ取得期間開始日

end
string (required) Example: 2016-12-15T15:00:00.000Z

データ取得期間終了日

type
enum (required) Example: csv, json

取得データフォーマット

Request
HideShow
Headers
Content-Type: application / json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200,
  "data": {
    "url": "https://download-dev-dop.s3.amazonaws.com/ctesttenant00/0b798cc31f8747b6b68c43a586c89352/201612141500-201612151500.zip?AWSAccessKeyId=ASIAILT3K3H2IQOERKNA\\u0026Expires=1481791124\\u0026x-amz-security-token=FQoDYXdzENH%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDDuDJzM6MIKfQ%2B%2FgWyK3A9IvDwMEpyDTYsBjgWRobJldBDbRs26%2FZqXdSwikNvKvBdWKEYO4vI1O7h4IEdUN3HMxYeaJHvseSXX075LifOzjI3we4rny%2BM9W15JCDWDCmPXmIzDGx9ZK0n3SewR0SqbPWKEU3vB5dd47a%2BYwsTqg48HcdV5kwMHDlYb7agZonICp2EChRl0P3tSRFUA5f2%2FjvLspGkD7CtKqjs%2BthiZ2Nhsn2O3OWCJHrOb2%2B6z%2BKF9xCscPMg5WG6sL3cNlDLi06nvBIvd7vZi6%2BAF9EfeuCs5DmW35RjHdEyZjNTpYftdzCyGIAX%2BjuQPz9SDtrfnj39rmz1AWCvtqlfbyH%2BEj356fVjMSkqOBP4GzSZtT8gZiula66jcnh2u%2Fvji%2BwY6GOzW0Z4qL6sstb6n06i6iS2krhIXyaTAVpfw87Wj1H%2F8qqHYgmQbWrnQPYJHbZo2xlDamcc1Upy9xDglXS7EShm9k2RG4TW9RfYdxqLRyc4nHFvJlnS%2BjJq%2F%2BIRKitv%2F6H4iRzcEZz1A3%2FEEBt1olXGPazuHcCuCdXUN0fYacmYzNRPlbGO7iDCx%2FDE2wHAEbcjiuajQouJLJwgU%3D\\u0026Signature=fdlk%2BP49B0e2ksAgrZZA4mcoWuQ%3D"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "data": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string",
          "description": "ダウンロード URL"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow
Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

遠隔操作

コマンド実行情報詳細

コマンド実行情報詳細取得
GET/oauth2/execution/show/{id}

処理概要

  • idで指定されたコマンド実行情報の情報を返す。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視なコマンド実行情報を指定した場合はResponse 403が返る。

  • 存在しないコマンド実行情報を指定した場合はResponse 404が返る。

  • GETメソッド以外でリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/execution/show/111
URI Parameters
HideShow
id
number (required) Example: 111

コマンド実行情報のID

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": {
    "id": 114,
    "executionId": "EXE001",
    "name": "コマンド0-0",
    "command": "jp.co.uniadex.dataocean.remote.Command : 8",
    "parameter": "params0",
    "runas": "root",
    "workpath": "/opt/test/app",
    "stdin": "/opt/test/app/tmp/stdin",
    "stdout": "/opt/test/app/tmp/stdout",
    "stderr": "/opt/test/app/tmp/stderr",
    "timeout": 100,
    "normalRange": {
      "start": 0,
      "end": 0
    },
    "warningRange": {
      "start": 0,
      "end": 0
    },
    "targetType": "Gateway",
    "targetId": "gateway0",
    "executeBy": "user0@example.com",
    "terminateBy": "user0@example.com",
    "sendDate": "2017-01-12T02:17:54.488Z[UTC]",
    "acceptedDate": "2017-01-12T02:17:54.488Z[UTC]",
    "runDate": "2017-01-12T02:17:54.488Z[UTC]",
    "terminateSendDate": "2017-01-12T02:17:54.488Z[UTC]",
    "terminateAcceptedDate": "2017-01-12T02:17:54.488Z[UTC]",
    "finishedDate": "2017-01-12T02:17:54.488Z[UTC]",
    "flag": {
      "timeout": true,
      "terminate": true,
      "finish": true
    },
    "status": "Sending",
    "stdoutMsg": "success",
    "stderrorMsg": "error",
    "exitcode": 0
  },
  "permissions": {
    "terminate": true
  },
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "コマンド実行情報のID"
        },
        "executionId": {
          "type": "string",
          "description": "コマンド実行情報ID"
        },
        "name": {
          "type": "string",
          "description": "コマンド名"
        },
        "command": {
          "type": "string",
          "description": "コマンド"
        },
        "parameter": {
          "type": "string",
          "description": "パラメータ"
        },
        "runas": {
          "type": "string",
          "description": "OS実行ユーザ"
        },
        "workpath": {
          "type": "string",
          "description": "ワークパス"
        },
        "stdin": {
          "type": "string",
          "description": "標準入力元ファイル"
        },
        "stdout": {
          "type": "string",
          "description": "標準出力先ファイル"
        },
        "stderr": {
          "type": "string",
          "description": "標準エラー出力ファイル"
        },
        "timeout": {
          "type": "number",
          "description": "タイムアウト"
        },
        "normalRange": {
          "type": "object",
          "properties": {
            "start": {
              "type": "number",
              "description": "始点"
            },
            "end": {
              "type": "number",
              "description": "終点"
            }
          },
          "description": "正常終了範囲"
        },
        "warningRange": {
          "type": "object",
          "properties": {
            "start": {
              "type": "number",
              "description": "始点"
            },
            "end": {
              "type": "number",
              "description": "終点"
            }
          },
          "description": "警告終了範囲"
        },
        "targetType": {
          "type": "string",
          "description": "対象デバイス種別"
        },
        "targetId": {
          "type": "string",
          "description": "0(string) - 対象デバイスID"
        },
        "executeBy": {
          "type": "string",
          "description": "コマンド実行指示ユーザ名"
        },
        "terminateBy": {
          "type": "string",
          "description": "コマンド強制終了指示ユーザ"
        },
        "sendDate": {
          "type": "string",
          "description": "コマンド送信日時"
        },
        "acceptedDate": {
          "type": "string",
          "description": "コマンド受付日時"
        },
        "runDate": {
          "type": "string",
          "description": "コマンド実行日時"
        },
        "terminateSendDate": {
          "type": "string",
          "description": "強制終了送信日時"
        },
        "terminateAcceptedDate": {
          "type": "string",
          "description": "強制終了受付日時"
        },
        "finishedDate": {
          "type": "string",
          "description": "終了日時"
        },
        "flag": {
          "type": "object",
          "properties": {
            "timeout": {
              "type": "boolean",
              "description": "タイムアウトフラグ"
            },
            "terminate": {
              "type": "boolean",
              "description": "強制終了フラグ"
            },
            "finish": {
              "type": "boolean",
              "description": "終了フラグ"
            }
          },
          "description": "フラグ"
        },
        "status": {
          "type": "string",
          "description": "実行ステータス"
        },
        "stdoutMsg": {
          "type": "string",
          "description": "標準出力文字列"
        },
        "stderrorMsg": {
          "type": "string",
          "description": "標準エラー出力文字列"
        },
        "exitcode": {
          "type": "number",
          "description": "終了コード"
        }
      }
    },
    "permissions": {
      "type": "object",
      "properties": {
        "terminate": {
          "type": "boolean",
          "description": "強制停止権限"
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

コマンド実行

コマンド実行
POST/oauth2/command/execute

処理概要

  • idで指定されたコマンドをdeviceで指定されたデバイスに対して実行する。

  • 各パラメータについて、不正な値を指定した場合はResponse 400が返る。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視なコマンドを指定した場合はResponse 403が返る。

  • コマンド実行の権限のないコマンドを指定した場合もResponse 403が返る。

  • コマンド実行の権限のないデバイスを指定した場合もResponse 403が返る。

  • 存在しないコマンドを指定した場合はResponse 404が返る。

  • GETメソッドでリクエストした場合はResponse 405が返る。

Example URI

POST /oauth2/command/execute
URI Parameters
HideShow
id
number (required) Example: 111

コマンドのID。

command
string (optional) Example: execCommand

コマンド。
本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。

parameter
string (optional) Example: param0

パラメータ。
本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。

runas
string (optional) Example: root

OS実行ユーザ。
IDで指定されているコマンドの定義でOS実行ユーザ要否が「要」と設定されている場合のみ、本パラメータで指定された値でコマンドを実行する。
IDで指定されているコマンドの定義でOS実行ユーザ要否が「要」と設定されていて本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。

workpath
string (optional) Example: /opt/test/app

ワークパス。
IDで指定されているコマンドの定義でワークパス要否が「要」と設定されている場合のみ、本パラメータで指定された値でコマンドを実行する。
IDで指定されているコマンドの定義でワークパス要否が「要」と設定されていて本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。

stdin
string (optional) Example: /opt/test/app/tmp/stdin

標準入力ファイル。
IDで指定されているコマンドの定義で標準入力ファイル要否が「要」と設定されている場合のみ、本パラメータで指定された値でコマンドを実行する。
IDで指定されているコマンドの定義で標準入力ファイル要否が「要」と設定されていて本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。

stdout
string (optional) Example: /opt/test/app/tmp/stdout

標準出力ファイル。
IDで指定されているコマンドの定義で標準出力ファイル要否が「要」と設定されている場合のみ、本パラメータで指定された値でコマンドを実行する。
IDで指定されているコマンドの定義で標準出力ファイル要否が「要」と設定されていて本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。

stderr
string (optional) Example: /opt/test/app/tmp/stderr

標準エラー出力ファイル。
IDで指定されているコマンドの定義で標準エラー出力ファイル要否が「要」と設定されている場合のみ、本パラメータで指定された値でコマンドを実行する。
IDで指定されているコマンドの定義で標準エラー出力ファイル要否が「要」と設定されていて本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。

timeout
number (optional) Example: 100

タイムアウト。
本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。

normalRangeStart
number (optional) Example: 0

正常終了範囲 (始点)。
本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。

normalRangeEnd
number (optional) Example: 100

正常終了範囲 (終点)。
本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。

warningRangeStart
number (optional) Example: 0

警告終了範囲 (始点)。
本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。

warningRangeEnd
number (optional) Example: 100

警告終了範囲 (終点)。
本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。

device
array (optional) Example: [1, 2]

デバイスのID。
ゲートウェイID、または、センサーIDが指定される。
本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Body
{
  "id": 111,
  "command": "execCommand",
  "parameter": "param0",
  "runas": "root",
  "workpath": "/opt/test/app",
  "stdin": "/opt/test/app/tmp/stdin",
  "stdout": "/opt/test/app/tmp/stdout",
  "stderr": "/opt/test/app/tmp/stderr",
  "timeout": 100,
  "normalRangeStart": 0,
  "normalRangeEnd": 100,
  "warningRangeStart": 0,
  "warningRangeEnd": 100,
  "device": [
    1,
    2
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "コマンドのID。"
    },
    "command": {
      "type": "string",
      "description": "コマンド。<br>本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。"
    },
    "parameter": {
      "type": "string",
      "description": "パラメータ。<br>本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。"
    },
    "runas": {
      "type": "string",
      "description": "OS実行ユーザ。<br>IDで指定されているコマンドの定義でOS実行ユーザ要否が「要」と設定されている場合のみ、本パラメータで指定された値でコマンドを実行する。<br>IDで指定されているコマンドの定義でOS実行ユーザ要否が「要」と設定されていて本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。"
    },
    "workpath": {
      "type": "string",
      "description": "ワークパス。<br>IDで指定されているコマンドの定義でワークパス要否が「要」と設定されている場合のみ、本パラメータで指定された値でコマンドを実行する。<br>IDで指定されているコマンドの定義でワークパス要否が「要」と設定されていて本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。"
    },
    "stdin": {
      "type": "string",
      "description": "標準入力ファイル。<br>IDで指定されているコマンドの定義で標準入力ファイル要否が「要」と設定されている場合のみ、本パラメータで指定された値でコマンドを実行する。<br>IDで指定されているコマンドの定義で標準入力ファイル要否が「要」と設定されていて本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。"
    },
    "stdout": {
      "type": "string",
      "description": "標準出力ファイル。<br>IDで指定されているコマンドの定義で標準出力ファイル要否が「要」と設定されている場合のみ、本パラメータで指定された値でコマンドを実行する。<br>IDで指定されているコマンドの定義で標準出力ファイル要否が「要」と設定されていて本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。"
    },
    "stderr": {
      "type": "string",
      "description": "標準エラー出力ファイル。<br>IDで指定されているコマンドの定義で標準エラー出力ファイル要否が「要」と設定されている場合のみ、本パラメータで指定された値でコマンドを実行する。<br>IDで指定されているコマンドの定義で標準エラー出力ファイル要否が「要」と設定されていて本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。"
    },
    "timeout": {
      "type": "number",
      "description": "タイムアウト。<br>本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。"
    },
    "normalRangeStart": {
      "type": "number",
      "description": "正常終了範囲 (始点)。<br>本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。"
    },
    "normalRangeEnd": {
      "type": "number",
      "description": "正常終了範囲 (終点)。<br>本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。"
    },
    "warningRangeStart": {
      "type": "number",
      "description": "警告終了範囲 (始点)。<br>本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。"
    },
    "warningRangeEnd": {
      "type": "number",
      "description": "警告終了範囲 (終点)。<br>本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。"
    },
    "device": {
      "type": "array",
      "description": "デバイスのID。<br>ゲートウェイID、または、センサーIDが指定される。<br>本パラメータが指定されなかった場合、IDで指定されたコマンドで定義されている値でコマンドを実行する。"
    }
  },
  "required": [
    "id"
  ]
}
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": [
    {
      "id": 111,
      "executionId": "EXE001",
      "targetType": "Gateway",
      "targetId": "gateway0",
      "sendDate": "2017-01-12T02:17:54.488Z[UTC]"
    }
  ],
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "コマンド実行情報のID"
          },
          "executionId": {
            "type": "string",
            "description": "コマンド実行情報ID"
          },
          "targetType": {
            "type": "string",
            "description": "対象デバイス種別"
          },
          "targetId": {
            "type": "string",
            "description": "0 (string) - 対象デバイスID"
          },
          "sendDate": {
            "type": "string",
            "description": "コマンド送信日時"
          }
        }
      },
      "description": "デバイスごとのコマンド実行情報"
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

コマンド実行の権限のないコマンド

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

コマンド実行の権限のないデバイス

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

監視

イベント種別情報一覧取得

イベント種別情報一覧取得
GET/oauth2/eventType/index

処理概要

  • イベント種別情報の一覧を取得する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • イベント情報種別表示権限が必須である。権限がない場合はResponse 403が返る。

  • GETメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/eventType/index
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": [
    {
      "id": 1,
      "eventTypeId": "eventTypeId1",
      "name": "イベント種別1",
      "description": "説明"
    }
  ],
  "permissions": {
    "create": true,
    "delete": true,
    "edit": true,
    "show": true
  },
  "status": 200,
  "total": 1
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "イベント種別のid"
          },
          "eventTypeId": {
            "type": "string",
            "description": "イベント種別ID"
          },
          "name": {
            "type": "string",
            "description": "名前"
          },
          "description": {
            "type": "string",
            "description": "説明"
          }
        }
      }
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create": {
          "type": "boolean",
          "description": "作成権限"
        },
        "delete": {
          "type": "boolean",
          "description": "削除権限"
        },
        "edit": {
          "type": "boolean",
          "description": "編集権限"
        },
        "show": {
          "type": "boolean",
          "description": "表示権限"
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "total": {
      "type": "number",
      "description": "イベント種別の数"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

イベント種別詳細

イベント種別詳細取得
GET/oauth2/eventType/show/{id}

処理概要

  • 指定したイベント種別の詳細情報を取得する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視なイベント種別を指定した場合はResponse 403が返る。

  • 存在しないイベント種別を指定した場合はResponse 404が返る。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/eventType/show/111
URI Parameters
HideShow
id
number (required) Example: 111

イベント種別のID

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": {
    "id": 1,
    "eventTypeId": "eventType1",
    "name": "イベント種別1",
    "description": "説明"
  },
  "status": 200,
  "permissions": {
    "create": true,
    "delete": true,
    "edit": true,
    "show": true
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "イベント種別のid"
        },
        "eventTypeId": {
          "type": "string",
          "description": "イベント種別ID"
        },
        "name": {
          "type": "string",
          "description": "名前"
        },
        "description": {
          "type": "string",
          "description": "説明"
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create": {
          "type": "boolean",
          "description": "作成権限"
        },
        "delete": {
          "type": "boolean",
          "description": "削除権限"
        },
        "edit": {
          "type": "boolean",
          "description": "編集権限"
        },
        "show": {
          "type": "boolean",
          "description": "表示権限"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

イベント種別情報登録

イベント種別情報登録
POST/oauth2/eventType/save

処理概要

  • イベント種別の情報を登録する。

  • バリデーションエラーのときはResponse 400が返る。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • イベント種別作成権限がない場合はResponse 403が返る。

  • GETメソッドでリクエストした場合はResponse 405が返る。

Example URI

POST /oauth2/eventType/save
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Body
{
  "eventTypeId": "eventType1",
  "name": "イベント種別0",
  "description": "説明"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "eventTypeId": {
      "type": "string",
      "description": "イベント種別のID"
    },
    "name": {
      "type": "string",
      "description": "名前"
    },
    "description": {
      "type": "string",
      "description": "説明"
    }
  },
  "required": [
    "eventTypeId"
  ]
}
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200,
  "id": 111
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "id": {
      "type": "number",
      "description": "登録した情報のid"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 400,
  "reason": "Bad Request",
  "detail": {
    "code": "error.validate_error",
    "message": "パラメータが不正です。",
    "errors": {
      "パラメータ名": [
        {
          "code": "nullable",
          "message": "空白は許可されません。"
        }
      ]
    }
  }
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    },
    "detail": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "エラーコード。"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ。"
        },
        "errors": {
          "type": "object",
          "properties": {
            "パラメータ名": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "エラーコード。"
                  },
                  "message": {
                    "type": "string",
                    "description": "エラーメッセージ。"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

イベント種別情報更新

イベント種別情報更新
POST/oauth2/eventType/update

処理概要

  • idで指定したイベント種別情報情報を更新する。

  • バリデーションエラーのときはResponse 400が返る。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視なイベント種別を指定した場合やイベント種別情報編集権限がない場合はResponse 403が返る。

  • 存在しないユーザを指定した場合はResponse 404が返る。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

POST /oauth2/eventType/update
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Body
{
  "id": 111,
  "eventTypeId": "eventType1",
  "name": "イベント種別0",
  "description": "説明"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "イベント種別のid"
    },
    "eventTypeId": {
      "type": "string",
      "description": "イベント種別のID"
    },
    "name": {
      "type": "string",
      "description": "名前"
    },
    "description": {
      "type": "string",
      "description": "説明"
    }
  },
  "required": [
    "id"
  ]
}
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 400,
  "reason": "Bad Request",
  "detail": {
    "code": "error.validate_error",
    "message": "パラメータが不正です。",
    "errors": {
      "パラメータ名": [
        {
          "code": "nullable",
          "message": "空白は許可されません。"
        }
      ]
    }
  }
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    },
    "detail": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "エラーコード。"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ。"
        },
        "errors": {
          "type": "object",
          "properties": {
            "パラメータ名": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "エラーコード。"
                  },
                  "message": {
                    "type": "string",
                    "description": "エラーメッセージ。"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

イベント種別情報削除

イベント種別情報削除
GET/oauth2/eventType/delete/{id}

処理概要

  • idで指定したイベント種別を削除する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • イベント種別情報削除権限がない場合はResponse 403が返る。

  • 存在しないイベント種別を指定した場合はResponse 404が返る。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/eventType/delete/1
URI Parameters
HideShow
id
string (required) Example: 1

イベント種別のID。

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

エリア条件情報一覧取得

エリア条件情報一覧取得
GET/oauth2/areaCondition/index

処理概要

  • エリア条件情報の一覧を取得する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 監視条件情報表示権限が必須である。権限がない場合はResponse 403が返る。

  • GETメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/areaCondition/index
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": [
    {
      "id": 1,
      "name": "条件1",
      "description": "説明",
      "eventTypes": {
        "id": 1,
        "eventTypeId": "eventType01",
        "name": "イベント種別01"
      },
      "points": [
        1
      ],
      "disable": false
    }
  ],
  "permissions": {
    "create": true,
    "delete": true,
    "edit": true,
    "show": true
  },
  "status": 200,
  "total": 1
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "エリア条件のid"
          },
          "name": {
            "type": "string",
            "description": "名前"
          },
          "description": {
            "type": "string",
            "description": "説明"
          },
          "eventTypes": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "イベント種別のid"
              },
              "eventTypeId": {
                "type": "string",
                "description": "イベント種別ID"
              },
              "name": {
                "type": "string",
                "description": "イベント種別名"
              }
            },
            "description": "イベント種別"
          },
          "points": {
            "type": "array",
            "items": {
              "type": "number"
            },
            "description": "座標(x,y)"
          },
          "disable": {
            "type": "boolean",
            "description": "監視有効無効フラグ"
          }
        }
      }
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create": {
          "type": "boolean",
          "description": "作成権限"
        },
        "delete": {
          "type": "boolean",
          "description": "削除権限"
        },
        "edit": {
          "type": "boolean",
          "description": "編集権限"
        },
        "show": {
          "type": "boolean",
          "description": "表示権限"
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "total": {
      "type": "number",
      "description": "メールアクションの数"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

エリア条件詳細

エリア条件詳細取得
GET/oauth2/areaCondition/show/{id}

処理概要

  • 指定したエリア条件の詳細情報を取得する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視なエリア条件を指定した場合はResponse 403が返る。

  • 存在しないエリア条件を指定した場合はResponse 404が返る。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/areaCondition/show/111
URI Parameters
HideShow
id
number (required) Example: 111

エリア条件のID

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": {
    "id": 1,
    "name": "条件1",
    "description": "説明",
    "disable": false,
    "area": {
      "name": "エリア1",
      "points": [
        1
      ],
      "type": "Inside"
    },
    "eventTypes": {
      "id": 1,
      "eventTypeId": "eventType01",
      "name": "イベント種別01"
    },
    "suppress": {
      "id": 1,
      "name": "抑止1"
    },
    "sensors": [
      {
        "id": 1,
        "sensorId": "sensor1"
      }
    ]
  },
  "status": 200,
  "permissions": {
    "create": true,
    "delete": true,
    "edit": true,
    "show": true
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "エリア条件のid"
        },
        "name": {
          "type": "string",
          "description": "名前"
        },
        "description": {
          "type": "string",
          "description": "説明"
        },
        "disable": {
          "type": "boolean",
          "description": "監視有効無効フラグ"
        },
        "area": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "名前"
            },
            "points": {
              "type": "array",
              "items": {
                "type": "number"
              },
              "description": "座標(x,y)"
            },
            "type": {
              "type": "string",
              "description": "座標のタイプ。Inside or Outside。"
            }
          },
          "description": "エリア"
        },
        "eventTypes": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "description": "イベント種別のid"
            },
            "eventTypeId": {
              "type": "string",
              "description": "イベント種別ID"
            },
            "name": {
              "type": "string",
              "description": "イベント種別名"
            }
          },
          "description": "イベント種別"
        },
        "suppress": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "description": "イベント発生抑止のid"
            },
            "name": {
              "type": "string",
              "description": "名前"
            }
          },
          "description": "抑止設定"
        },
        "sensors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "センサーのid"
              },
              "sensorId": {
                "type": "string",
                "description": "センサーID"
              }
            }
          },
          "description": "対象センサー"
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create": {
          "type": "boolean",
          "description": "作成権限"
        },
        "delete": {
          "type": "boolean",
          "description": "削除権限"
        },
        "edit": {
          "type": "boolean",
          "description": "編集権限"
        },
        "show": {
          "type": "boolean",
          "description": "表示権限"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

エリア条件情報登録

エリア条件情報登録
POST/oauth2/areaCondition/save

処理概要

  • エリア条件の情報を登録する。

  • バリデーションエラーのときはResponse 400が返る。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 監視条件作成権限がない場合はResponse 403が返る。

  • GETメソッドでリクエストした場合はResponse 405が返る。

Example URI

POST /oauth2/areaCondition/save
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Body
{
  "name": "条件1",
  "description": "説明",
  "areaName": "エリア1",
  "points": "0,0,1,1",
  "type": "Inside",
  "disable": false,
  "eventType": 1,
  "suppress": 1,
  "sensorList": [
    1,
    2
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "名前"
    },
    "description": {
      "type": "string",
      "description": "説明"
    },
    "areaName": {
      "type": "string",
      "description": "エリア名"
    },
    "points": {
      "type": "string",
      "description": "座標文字列"
    },
    "type": {
      "type": "string",
      "description": "座標のタイプ"
    },
    "disable": {
      "type": "boolean",
      "description": "監視有効無効フラグ"
    },
    "eventType": {
      "type": "number",
      "description": "イベント種別のID"
    },
    "suppress": {
      "type": "number",
      "description": "イベント発生抑止のID"
    },
    "sensorList": {
      "type": "array",
      "description": "センサーIDの配列"
    }
  },
  "required": [
    "name",
    "areaName",
    "points",
    "type"
  ]
}
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200,
  "id": 111
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "id": {
      "type": "number",
      "description": "登録した情報のid"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 400,
  "reason": "Bad Request",
  "detail": {
    "code": "error.validate_error",
    "message": "パラメータが不正です。",
    "errors": {
      "パラメータ名": [
        {
          "code": "nullable",
          "message": "空白は許可されません。"
        }
      ]
    }
  }
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    },
    "detail": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "エラーコード。"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ。"
        },
        "errors": {
          "type": "object",
          "properties": {
            "パラメータ名": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "エラーコード。"
                  },
                  "message": {
                    "type": "string",
                    "description": "エラーメッセージ。"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

エリア条件情報更新

エリア条件情報更新
POST/oauth2/areaCondition/update

処理概要

  • idで指定したエリア条件情報情報を更新する。

  • バリデーションエラーのときはResponse 400が返る。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視なエリア条件を指定した場合や監視条件情報編集権限がない場合はResponse 403が返る。

  • 存在しないユーザを指定した場合はResponse 404が返る

  • sensors の省略は、空の状態を指定したと同等の扱いとなる。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

POST /oauth2/areaCondition/update
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Body
{
  "id": 111,
  "name": "条件1",
  "description": "説明",
  "areaName": "エリア1",
  "points": "0,0,1,1",
  "type": "Inside",
  "disable": false,
  "eventType": 1,
  "suppress": 1,
  "sensorList": [
    1,
    2
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "エリア条件のid"
    },
    "name": {
      "type": "string",
      "description": "名前"
    },
    "description": {
      "type": "string",
      "description": "説明"
    },
    "areaName": {
      "type": "string",
      "description": "エリア名"
    },
    "points": {
      "type": "string",
      "description": "座標文字列"
    },
    "type": {
      "type": "string",
      "description": "座標のタイプ"
    },
    "disable": {
      "type": "boolean",
      "description": "監視有効無効フラグ"
    },
    "eventType": {
      "type": "number",
      "description": "イベント種別のID"
    },
    "suppress": {
      "type": "number",
      "description": "イベント発生抑止のID"
    },
    "sensorList": {
      "type": "array",
      "description": "センサーIDの配列"
    }
  },
  "required": [
    "id",
    "name",
    "areaName",
    "points",
    "type"
  ]
}
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 400,
  "reason": "Bad Request",
  "detail": {
    "code": "error.validate_error",
    "message": "パラメータが不正です。",
    "errors": {
      "パラメータ名": [
        {
          "code": "nullable",
          "message": "空白は許可されません。"
        }
      ]
    }
  }
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    },
    "detail": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "エラーコード。"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ。"
        },
        "errors": {
          "type": "object",
          "properties": {
            "パラメータ名": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "エラーコード。"
                  },
                  "message": {
                    "type": "string",
                    "description": "エラーメッセージ。"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

エリア条件情報削除

エリア条件情報削除
GET/oauth2/areaCondition/delete/{id}

処理概要

  • idで指定したエリア条件を削除する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 監視条件削除権限がない場合はResponse 403が返る。

  • 存在しないエリア条件を指定した場合はResponse 404が返る。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/areaCondition/delete/1
URI Parameters
HideShow
id
string (required) Example: 1

エリア条件のID。

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

範囲条件情報一覧取得

範囲条件情報一覧取得
GET/oauth2/rangeCondition/index

処理概要

  • 範囲条件情報の一覧を取得する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 監視条件情報表示権限が必須である。権限がない場合はResponse 403が返る。

  • GETメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/rangeCondition/index
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": [
    {
      "id": 1,
      "name": "条件1",
      "description": "説明",
      "eventTypes": {
        "id": 1,
        "eventTypeId": "eventType01",
        "name": "イベント種別01"
      },
      "startPoint": 1,
      "endPoint": 1,
      "disable": false
    }
  ],
  "permissions": {
    "create": true,
    "delete": true,
    "edit": true,
    "show": true
  },
  "status": 200,
  "total": 1
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "エリア条件のid"
          },
          "name": {
            "type": "string",
            "description": "名前"
          },
          "description": {
            "type": "string",
            "description": "説明"
          },
          "eventTypes": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "イベント種別のid"
              },
              "eventTypeId": {
                "type": "string",
                "description": "イベント種別ID"
              },
              "name": {
                "type": "string",
                "description": "イベント種別名"
              }
            },
            "description": "イベント種別"
          },
          "startPoint": {
            "type": "number",
            "description": "始点"
          },
          "endPoint": {
            "type": "number",
            "description": "終点"
          },
          "disable": {
            "type": "boolean",
            "description": "監視有効無効フラグ"
          }
        }
      }
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create": {
          "type": "boolean",
          "description": "作成権限"
        },
        "delete": {
          "type": "boolean",
          "description": "削除権限"
        },
        "edit": {
          "type": "boolean",
          "description": "編集権限"
        },
        "show": {
          "type": "boolean",
          "description": "表示権限"
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "total": {
      "type": "number",
      "description": "メールアクションの数"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

範囲条件詳細

範囲条件詳細取得
GET/oauth2/rangeCondition/show/{id}

処理概要

  • 指定した範囲条件の詳細情報を取得する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視な範囲条件を指定した場合はResponse 403が返る。

  • 存在しない範囲条件を指定した場合はResponse 404が返る。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/rangeCondition/show/111
URI Parameters
HideShow
id
number (required) Example: 111

範囲条件のID

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": {
    "id": 1,
    "name": "条件1",
    "description": "説明",
    "disable": false,
    "area": {
      "start": 1,
      "ge": false,
      "end": 1,
      "le": false
    },
    "eventTypes": {
      "id": 1,
      "eventTypeId": "eventType01",
      "name": "イベント種別01"
    },
    "suppress": {
      "id": 1,
      "name": "抑止1"
    },
    "sensors": [
      {
        "id": 1,
        "sensorId": "sensor1"
      }
    ]
  },
  "status": 200,
  "permissions": {
    "create": true,
    "delete": true,
    "edit": true,
    "show": true
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "範囲条件のid"
        },
        "name": {
          "type": "string",
          "description": "名前"
        },
        "description": {
          "type": "string",
          "description": "説明"
        },
        "disable": {
          "type": "boolean",
          "description": "監視有効無効フラグ"
        },
        "area": {
          "type": "object",
          "properties": {
            "start": {
              "type": "number",
              "description": "始点"
            },
            "ge": {
              "type": "boolean",
              "description": "始点を含めるか否かフラグ"
            },
            "end": {
              "type": "number",
              "description": "終点"
            },
            "le": {
              "type": "boolean",
              "description": "終点を含めるか否かフラグ"
            }
          },
          "description": "エリア"
        },
        "eventTypes": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "description": "イベント種別のid"
            },
            "eventTypeId": {
              "type": "string",
              "description": "イベント種別ID"
            },
            "name": {
              "type": "string",
              "description": "イベント種別名"
            }
          },
          "description": "イベント種別"
        },
        "suppress": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "description": "イベント発生抑止のid"
            },
            "name": {
              "type": "string",
              "description": "名前"
            }
          },
          "description": "抑止設定"
        },
        "sensors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "センサーのid"
              },
              "sensorId": {
                "type": "string",
                "description": "センサーID"
              }
            }
          },
          "description": "対象センサー"
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create": {
          "type": "boolean",
          "description": "作成権限"
        },
        "delete": {
          "type": "boolean",
          "description": "削除権限"
        },
        "edit": {
          "type": "boolean",
          "description": "編集権限"
        },
        "show": {
          "type": "boolean",
          "description": "表示権限"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

範囲条件情報登録

範囲条件情報登録
POST/oauth2/rangeCondition/save

処理概要

  • 範囲条件の情報を登録する。

  • バリデーションエラーのときはResponse 400が返る。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 監視条件作成権限がない場合はResponse 403が返る。

  • GETメソッドでリクエストした場合はResponse 405が返る。

Example URI

POST /oauth2/rangeCondition/save
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Body
{
  "name": "条件1",
  "description": "説明",
  "startPoint": 1,
  "isIncludeStart": false,
  "endPoint": 1,
  "isIncludeEnd": false,
  "disable": false,
  "eventType": 1,
  "suppress": 1,
  "sensorList": [
    1,
    2
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "名前"
    },
    "description": {
      "type": "string",
      "description": "説明"
    },
    "startPoint": {
      "type": "number",
      "description": "始点"
    },
    "isIncludeStart": {
      "type": "boolean",
      "description": "始点を含めるか否か"
    },
    "endPoint": {
      "type": "number",
      "description": "終点"
    },
    "isIncludeEnd": {
      "type": "boolean",
      "description": "終点を含めるか否か"
    },
    "disable": {
      "type": "boolean",
      "description": "監視有効無効フラグ"
    },
    "eventType": {
      "type": "number",
      "description": "イベント種別のID"
    },
    "suppress": {
      "type": "number",
      "description": "イベント発生抑止のID"
    },
    "sensorList": {
      "type": "array",
      "description": "センサーIDの配列"
    }
  },
  "required": [
    "name"
  ]
}
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200,
  "id": 111
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "id": {
      "type": "number",
      "description": "登録した情報のid"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 400,
  "reason": "Bad Request",
  "detail": {
    "code": "error.validate_error",
    "message": "パラメータが不正です。",
    "errors": {
      "パラメータ名": [
        {
          "code": "nullable",
          "message": "空白は許可されません。"
        }
      ]
    }
  }
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    },
    "detail": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "エラーコード。"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ。"
        },
        "errors": {
          "type": "object",
          "properties": {
            "パラメータ名": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "エラーコード。"
                  },
                  "message": {
                    "type": "string",
                    "description": "エラーメッセージ。"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

範囲条件情報更新

範囲条件情報更新
POST/oauth2/rangeCondition/update

処理概要

  • idで指定した範囲条件情報情報を更新する。

  • バリデーションエラーのときはResponse 400が返る。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視な範囲条件を指定した場合や監視条件情報編集権限がない場合はResponse 403が返る。

  • 存在しないユーザを指定した場合はResponse 404が返る。

  • sensors の省略は、空の状態を指定したと同等の扱いとなる。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

POST /oauth2/rangeCondition/update
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Body
{
  "id": 111,
  "name": "条件1",
  "description": "説明",
  "startPoint": 1,
  "isIncludeStart": false,
  "endPoint": 1,
  "isIncludeEnd": false,
  "disable": false,
  "eventType": 1,
  "suppress": 1,
  "sensorList": [
    1,
    2
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "範囲条件のid"
    },
    "name": {
      "type": "string",
      "description": "名前"
    },
    "description": {
      "type": "string",
      "description": "説明"
    },
    "startPoint": {
      "type": "number",
      "description": "始点"
    },
    "isIncludeStart": {
      "type": "boolean",
      "description": "始点を含めるか否か"
    },
    "endPoint": {
      "type": "number",
      "description": "終点"
    },
    "isIncludeEnd": {
      "type": "boolean",
      "description": "終点を含めるか否か"
    },
    "disable": {
      "type": "boolean",
      "description": "監視有効無効フラグ"
    },
    "eventType": {
      "type": "number",
      "description": "イベント種別のID"
    },
    "suppress": {
      "type": "number",
      "description": "イベント発生抑止のID"
    },
    "sensorList": {
      "type": "array",
      "description": "センサーIDの配列"
    }
  },
  "required": [
    "id",
    "name"
  ]
}
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 400,
  "reason": "Bad Request",
  "detail": {
    "code": "error.validate_error",
    "message": "パラメータが不正です。",
    "errors": {
      "パラメータ名": [
        {
          "code": "nullable",
          "message": "空白は許可されません。"
        }
      ]
    }
  }
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    },
    "detail": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "エラーコード。"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ。"
        },
        "errors": {
          "type": "object",
          "properties": {
            "パラメータ名": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "エラーコード。"
                  },
                  "message": {
                    "type": "string",
                    "description": "エラーメッセージ。"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

範囲条件情報削除

範囲条件情報削除
GET/oauth2/rangeCondition/delete/{id}

処理概要

  • idで指定した範囲条件を削除する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 監視条件削除権限がない場合はResponse 403が返る。

  • 存在しない範囲条件を指定した場合はResponse 404が返る。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/rangeCondition/delete/1
URI Parameters
HideShow
id
string (required) Example: 1

範囲条件のID。

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

無送信時間条件情報一覧取得

無送信時間条件情報一覧取得
GET/oauth2/lastSendTimeCondition/index

処理概要

  • 無送信時間条件情報の一覧を取得する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 監視条件情報表示権限が必須である。権限がない場合はResponse 403が返る。

  • GETメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/lastSendTimeCondition/index
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": [
    {
      "id": 1,
      "name": "条件1",
      "description": "説明",
      "eventTypes": {
        "id": 1,
        "eventTypeId": "eventType01",
        "name": "イベント種別01"
      },
      "threshold": 1,
      "disable": false
    }
  ],
  "permissions": {
    "create": true,
    "delete": true,
    "edit": true,
    "show": true
  },
  "status": 200,
  "total": 1
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "無送信時間条件のid"
          },
          "name": {
            "type": "string",
            "description": "名前"
          },
          "description": {
            "type": "string",
            "description": "説明"
          },
          "eventTypes": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "イベント種別のid"
              },
              "eventTypeId": {
                "type": "string",
                "description": "イベント種別ID"
              },
              "name": {
                "type": "string",
                "description": "イベント種別名"
              }
            },
            "description": "イベント種別"
          },
          "threshold": {
            "type": "number",
            "description": "閾値"
          },
          "disable": {
            "type": "boolean",
            "description": "監視有効無効フラグ"
          }
        }
      }
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create": {
          "type": "boolean",
          "description": "作成権限"
        },
        "delete": {
          "type": "boolean",
          "description": "削除権限"
        },
        "edit": {
          "type": "boolean",
          "description": "編集権限"
        },
        "show": {
          "type": "boolean",
          "description": "表示権限"
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "total": {
      "type": "number",
      "description": "メールアクションの数"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

無送信時間条件詳細

無送信時間条件詳細取得
GET/oauth2/lastSendTimeCondition/show/{id}

処理概要

  • 指定した無送信時間条件の詳細情報を取得する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視な無送信時間条件を指定した場合はResponse 403が返る。

  • 存在しない無送信時間条件を指定した場合はResponse 404が返る。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/lastSendTimeCondition/show/111
URI Parameters
HideShow
id
number (required) Example: 111

無送信時間条件のID

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": {
    "id": 1,
    "name": "条件1",
    "description": "説明",
    "disable": false,
    "threshold": 1,
    "eventTypes": {
      "id": 1,
      "eventTypeId": "eventType01",
      "name": "イベント種別01"
    },
    "suppress": {
      "id": 1,
      "name": "抑止1"
    },
    "devices": [
      {
        "id": 1,
        "sensorId": "sensor1"
      }
    ]
  },
  "status": 200,
  "permissions": {
    "create": true,
    "delete": true,
    "edit": true,
    "show": true
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "無送信時間条件のid"
        },
        "name": {
          "type": "string",
          "description": "名前"
        },
        "description": {
          "type": "string",
          "description": "説明"
        },
        "disable": {
          "type": "boolean",
          "description": "監視有効無効フラグ"
        },
        "threshold": {
          "type": "number",
          "description": "閾値"
        },
        "eventTypes": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "description": "イベント種別のid"
            },
            "eventTypeId": {
              "type": "string",
              "description": "イベント種別ID"
            },
            "name": {
              "type": "string",
              "description": "イベント種別名"
            }
          },
          "description": "イベント種別"
        },
        "suppress": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "description": "イベント発生抑止のid"
            },
            "name": {
              "type": "string",
              "description": "名前"
            }
          },
          "description": "抑止設定"
        },
        "devices": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "センサーのid"
              },
              "sensorId": {
                "type": "string",
                "description": "センサーID"
              }
            }
          },
          "description": "対象センサー"
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create": {
          "type": "boolean",
          "description": "作成権限"
        },
        "delete": {
          "type": "boolean",
          "description": "削除権限"
        },
        "edit": {
          "type": "boolean",
          "description": "編集権限"
        },
        "show": {
          "type": "boolean",
          "description": "表示権限"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

無送信時間条件情報登録

無送信時間条件情報登録
POST/oauth2/lastSendTimeCondition/save

処理概要

  • 無送信時間条件の情報を登録する。

  • バリデーションエラーのときはResponse 400が返る。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 監視条件作成権限がない場合はResponse 403が返る。

  • GETメソッドでリクエストした場合はResponse 405が返る。

Example URI

POST /oauth2/lastSendTimeCondition/save
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Body
{
  "name": "条件1",
  "description": "説明",
  "threshold": 1,
  "disable": false,
  "eventType": 1,
  "suppress": 1,
  "devices": [
    1,
    2
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "名前"
    },
    "description": {
      "type": "string",
      "description": "説明"
    },
    "threshold": {
      "type": "number",
      "description": "閾値"
    },
    "disable": {
      "type": "boolean",
      "description": "監視有効無効フラグ"
    },
    "eventType": {
      "type": "number",
      "description": "イベント種別のID"
    },
    "suppress": {
      "type": "number",
      "description": "イベント発生抑止のID"
    },
    "devices": {
      "type": "array",
      "description": "センサーIDの配列"
    }
  },
  "required": [
    "name",
    "threshold"
  ]
}
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200,
  "id": 111
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "id": {
      "type": "number",
      "description": "登録した情報のid"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 400,
  "reason": "Bad Request",
  "detail": {
    "code": "error.validate_error",
    "message": "パラメータが不正です。",
    "errors": {
      "パラメータ名": [
        {
          "code": "nullable",
          "message": "空白は許可されません。"
        }
      ]
    }
  }
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    },
    "detail": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "エラーコード。"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ。"
        },
        "errors": {
          "type": "object",
          "properties": {
            "パラメータ名": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "エラーコード。"
                  },
                  "message": {
                    "type": "string",
                    "description": "エラーメッセージ。"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

無送信時間条件情報更新

無送信時間条件情報更新
POST/oauth2/lastSendTimeCondition/update

処理概要

  • idで指定した無送信時間条件情報情報を更新する。

  • バリデーションエラーのときはResponse 400が返る。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視な無送信時間条件を指定した場合や監視条件情報編集権限がない場合はResponse 403が返る。

  • 存在しないユーザを指定した場合はResponse 404が返る

  • sensors の省略は、空の状態を指定したと同等の扱いとなる。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

POST /oauth2/lastSendTimeCondition/update
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Body
{
  "id": 111,
  "name": "条件1",
  "description": "説明",
  "threshold": 1,
  "disable": false,
  "eventType": 1,
  "suppress": 1,
  "devices": [
    1,
    2
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "無送信時間条件のid"
    },
    "name": {
      "type": "string",
      "description": "名前"
    },
    "description": {
      "type": "string",
      "description": "説明"
    },
    "threshold": {
      "type": "number",
      "description": "閾値"
    },
    "disable": {
      "type": "boolean",
      "description": "監視有効無効フラグ"
    },
    "eventType": {
      "type": "number",
      "description": "イベント種別のID"
    },
    "suppress": {
      "type": "number",
      "description": "イベント発生抑止のID"
    },
    "devices": {
      "type": "array",
      "description": "センサーIDの配列"
    }
  },
  "required": [
    "id",
    "name",
    "threshold"
  ]
}
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 400,
  "reason": "Bad Request",
  "detail": {
    "code": "error.validate_error",
    "message": "パラメータが不正です。",
    "errors": {
      "パラメータ名": [
        {
          "code": "nullable",
          "message": "空白は許可されません。"
        }
      ]
    }
  }
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    },
    "detail": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "エラーコード。"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ。"
        },
        "errors": {
          "type": "object",
          "properties": {
            "パラメータ名": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "エラーコード。"
                  },
                  "message": {
                    "type": "string",
                    "description": "エラーメッセージ。"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

無送信時間条件情報削除

無送信時間条件情報削除
GET/oauth2/lastSendTimeCondition/delete/{id}

処理概要

  • idで指定した無送信時間条件を削除する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 監視条件削除権限がない場合はResponse 403が返る。

  • 存在しない無送信時間条件を指定した場合はResponse 404が返る。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/lastSendTimeCondition/delete/1
URI Parameters
HideShow
id
string (required) Example: 1

無送信時間条件のID。

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

メールアクション情報一覧取得

メールアクション情報一覧取得
GET/oauth2/mailAction/index

処理概要

  • メールアクション情報の一覧を取得する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • アクション情報表示権限が必須である。権限がない場合はResponse 403が返る。

  • GETメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/mailAction/index
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": [
    {
      "id": 1,
      "name": "アクション1",
      "eventTypes": [
        {
          "id": 1,
          "eventTypeId": "eventType01",
          "name": "イベント種別01"
        }
      ]
    }
  ],
  "permissions": {
    "create": true,
    "delete": true,
    "edit": true,
    "show": true
  },
  "status": 200,
  "total": 1
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "メールアクションのid"
          },
          "name": {
            "type": "string",
            "description": "名前"
          },
          "eventTypes": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "description": "イベント種別のid"
                },
                "eventTypeId": {
                  "type": "string",
                  "description": "イベント種別ID"
                },
                "name": {
                  "type": "string",
                  "description": "イベント種別名"
                }
              }
            },
            "description": "説明"
          }
        }
      }
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create": {
          "type": "boolean",
          "description": "作成権限"
        },
        "delete": {
          "type": "boolean",
          "description": "削除権限"
        },
        "edit": {
          "type": "boolean",
          "description": "編集権限"
        },
        "show": {
          "type": "boolean",
          "description": "表示権限"
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "total": {
      "type": "number",
      "description": "メールアクションの数"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

メールアクション詳細

メールアクション詳細取得
GET/oauth2/mailAction/show/{id}

処理概要

  • 指定したメールアクションの詳細情報を取得する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視なメールアクションを指定した場合はResponse 403が返る。

  • 存在しないメールアクションを指定した場合はResponse 404が返る。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/mailAction/show/111
URI Parameters
HideShow
id
number (required) Example: 111

メールアクションのID

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": {
    "id": 1,
    "name": "アクション1",
    "title": "タイトル",
    "body": "本文",
    "eventTypes": [
      {
        "id": 1,
        "eventTypeId": "eventType01",
        "name": "イベント種別01",
        "description": "説明"
      }
    ],
    "accounts": [
      {
        "id": 1,
        "accountId": "account1",
        "displayName": "名前"
      }
    ],
    "mailAddresses": [
      "test1@example.com",
      "test2@example.com"
    ]
  },
  "status": 200,
  "permissions": {
    "create": true,
    "delete": true,
    "edit": true,
    "show": true
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "メールアクションのid"
        },
        "name": {
          "type": "string",
          "description": "名前"
        },
        "title": {
          "type": "string",
          "description": "メールアクションタイトル"
        },
        "body": {
          "type": "string",
          "description": "メールアクション本文"
        },
        "eventTypes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "メールアクションのid"
              },
              "eventTypeId": {
                "type": "string",
                "description": "イベント種別ID"
              },
              "name": {
                "type": "string",
                "description": "イベント種別名"
              },
              "description": {
                "type": "string",
                "description": "説明"
              }
            }
          },
          "description": "イベント種別"
        },
        "accounts": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "アカウントのid"
              },
              "accountId": {
                "type": "string",
                "description": "アカウントID"
              },
              "displayName": {
                "type": "string",
                "description": "アカウントの表示名"
              }
            }
          },
          "description": "アカウント"
        },
        "mailAddresses": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "メールアドレスの配列"
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create": {
          "type": "boolean",
          "description": "作成権限"
        },
        "delete": {
          "type": "boolean",
          "description": "削除権限"
        },
        "edit": {
          "type": "boolean",
          "description": "編集権限"
        },
        "show": {
          "type": "boolean",
          "description": "表示権限"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

メールアクション情報登録

メールアクション情報登録
POST/oauth2/mailAction/save

処理概要

  • メールアクションの情報を登録する。

  • バリデーションエラーのときはResponse 400が返る。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • アクション作成権限がない場合はResponse 403が返る。

  • GETメソッドでリクエストした場合はResponse 405が返る。

Example URI

POST /oauth2/mailAction/save
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Body
{
  "name": "アクション1",
  "title": "タイトル1",
  "body": "イベント種別0",
  "eventTypes": [
    1
  ],
  "accounts": [
    1
  ],
  "mailAddresses": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "名前"
    },
    "title": {
      "type": "string",
      "description": "メールアクションタイトル"
    },
    "body": {
      "type": "string",
      "description": "名前"
    },
    "eventTypes": {
      "type": "array",
      "description": "イベント種別のIDの配列"
    },
    "accounts": {
      "type": "array",
      "description": "アカウントのIDの配列"
    },
    "mailAddresses": {
      "type": "array",
      "description": "メールアドレスの配列"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200,
  "id": 111
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "id": {
      "type": "number",
      "description": "登録した情報のid"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 400,
  "reason": "Bad Request",
  "detail": {
    "code": "error.validate_error",
    "message": "パラメータが不正です。",
    "errors": {
      "パラメータ名": [
        {
          "code": "nullable",
          "message": "空白は許可されません。"
        }
      ]
    }
  }
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    },
    "detail": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "エラーコード。"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ。"
        },
        "errors": {
          "type": "object",
          "properties": {
            "パラメータ名": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "エラーコード。"
                  },
                  "message": {
                    "type": "string",
                    "description": "エラーメッセージ。"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

メールアクション情報更新

メールアクション情報更新
POST/oauth2/mailAction/update

処理概要

  • idで指定したメールアクション情報情報を更新する。

  • バリデーションエラーのときはResponse 400が返る。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視なメールアクションを指定した場合やアクション情報編集権限がない場合はResponse 403が返る。

  • 存在しないユーザを指定した場合はResponse 404が返る。

  • eventTypes の省略は、空の状態を指定したと同等の扱いとなる。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

POST /oauth2/mailAction/update
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Body
{
  "id": 111,
  "name": "アクション1",
  "title": "タイトル1",
  "body": "イベント種別0",
  "eventTypes": [
    1
  ],
  "accounts": [
    1
  ],
  "mailAddresses": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "メールアクションのid"
    },
    "name": {
      "type": "string",
      "description": "名前"
    },
    "title": {
      "type": "string",
      "description": "メールアクションタイトル"
    },
    "body": {
      "type": "string",
      "description": "名前"
    },
    "eventTypes": {
      "type": "array",
      "description": "イベント種別のIDの配列"
    },
    "accounts": {
      "type": "array",
      "description": "アカウントのIDの配列"
    },
    "mailAddresses": {
      "type": "array",
      "description": "メールアドレスの配列"
    }
  },
  "required": [
    "id"
  ]
}
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 400,
  "reason": "Bad Request",
  "detail": {
    "code": "error.validate_error",
    "message": "パラメータが不正です。",
    "errors": {
      "パラメータ名": [
        {
          "code": "nullable",
          "message": "空白は許可されません。"
        }
      ]
    }
  }
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    },
    "detail": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "エラーコード。"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ。"
        },
        "errors": {
          "type": "object",
          "properties": {
            "パラメータ名": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "エラーコード。"
                  },
                  "message": {
                    "type": "string",
                    "description": "エラーメッセージ。"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

メールアクション情報削除

メールアクション情報削除
GET/oauth2/mailAction/delete/{id}

処理概要

  • idで指定したメールアクションを削除する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • アクション削除権限がない場合はResponse 403が返る。

  • 存在しないメールアクションを指定した場合はResponse 404が返る。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/mailAction/delete/1
URI Parameters
HideShow
id
string (required) Example: 1

メールアクションのID。

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

HTTPアクション情報一覧取得

HTTPアクション情報一覧取得
GET/oauth2/httpAction/index

処理概要

  • HTTPアクション情報の一覧を取得する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • アクション情報表示権限が必須である。権限がない場合はResponse 403が返る。

  • GETメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/httpAction/index
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": [
    {
      "id": 1,
      "name": "アクション1",
      "eventTypes": [
        {
          "id": 1,
          "eventTypeId": "eventType01",
          "name": "イベント種別01"
        }
      ]
    }
  ],
  "permissions": {
    "create": true,
    "delete": true,
    "edit": true,
    "show": true
  },
  "status": 200,
  "total": 1
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "HTTPアクションのid"
          },
          "name": {
            "type": "string",
            "description": "名前"
          },
          "eventTypes": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "description": "イベント種別のid"
                },
                "eventTypeId": {
                  "type": "string",
                  "description": "イベント種別ID"
                },
                "name": {
                  "type": "string",
                  "description": "イベント種別名"
                }
              }
            },
            "description": "説明"
          }
        }
      }
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create": {
          "type": "boolean",
          "description": "作成権限"
        },
        "delete": {
          "type": "boolean",
          "description": "削除権限"
        },
        "edit": {
          "type": "boolean",
          "description": "編集権限"
        },
        "show": {
          "type": "boolean",
          "description": "表示権限"
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "total": {
      "type": "number",
      "description": "HTTPアクションの数"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

HTTPアクション詳細

HTTPアクション詳細取得
GET/oauth2/httpAction/show/{id}

処理概要

  • 指定したHTTPアクションの詳細情報を取得する。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視なHTTPアクションを指定した場合はResponse 403が返る。

  • 存在しないHTTPアクションを指定した場合はResponse 404が返る。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

GET /oauth2/httpAction/show/111
URI Parameters
HideShow
id
number (required) Example: 111

HTTPアクションのID

Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "data": {
    "id": 1,
    "name": "アクション1",
    "url": "http://test.com",
    "method": "POST",
    "contenttype": "FORM",
    "headers": {
      "Allow": "aaaaa",
      "Authorization": "xxxxxx"
    },
    "httpbody": "key1=value1&key2=value2",
    "eventTypes": [
      {
        "id": 1,
        "eventTypeId": "eventType01",
        "name": "イベント種別01",
        "description": "説明"
      }
    ]
  },
  "status": 200,
  "permissions": {
    "create": true,
    "delete": true,
    "edit": true,
    "show": true
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "HTTPアクションのid"
        },
        "name": {
          "type": "string",
          "description": "名前"
        },
        "url": {
          "type": "string",
          "description": "通知先のURL"
        },
        "method": {
          "type": "string",
          "description": "HTTPメソッド"
        },
        "contenttype": {
          "type": "string",
          "description": "Conrent-type"
        },
        "headers": {
          "type": "object",
          "properties": {
            "Allow": {
              "type": "string",
              "description": "追加ヘッダー情報(キー名称は例。任意のヘッダー名称を指定可能。項目の個数も任意)"
            },
            "Authorization": {
              "type": "string",
              "description": "追加ヘッダー情報(キー名称は例。任意のヘッダー名称を指定可能。項目の個数も任意)"
            }
          },
          "description": "ヘッダー情報"
        },
        "httpbody": {
          "type": "string",
          "description": "HTTP BODY文字列"
        },
        "eventTypes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "HTTPアクションのid"
              },
              "eventTypeId": {
                "type": "string",
                "description": "イベント種別ID"
              },
              "name": {
                "type": "string",
                "description": "イベント種別名"
              },
              "description": {
                "type": "string",
                "description": "説明"
              }
            }
          },
          "description": "イベント種別"
        }
      }
    },
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "permissions": {
      "type": "object",
      "properties": {
        "create": {
          "type": "boolean",
          "description": "作成権限"
        },
        "delete": {
          "type": "boolean",
          "description": "削除権限"
        },
        "edit": {
          "type": "boolean",
          "description": "編集権限"
        },
        "show": {
          "type": "boolean",
          "description": "表示権限"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 404,
  "reason": "Not Found"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

HTTPアクション情報登録

HTTPアクション情報登録
POST/oauth2/httpAction/save

処理概要

  • HTTPアクションの情報を登録する。

  • バリデーションエラーのときはResponse 400が返る。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • アクション作成権限がない場合はResponse 403が返る。

  • GETメソッドでリクエストした場合はResponse 405が返る。

Example URI

POST /oauth2/httpAction/save
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Body
{
  "data": {
    "name": "アクション1",
    "url": "http://test.com",
    "method": "POST",
    "contenttype": "FORM",
    "headers": {
      "Allow": "aaaaa",
      "Authorization": "xxxxxx"
    },
    "httpbody": "key1=value1&key2=value2",
    "eventTypes": [
      1
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "名前"
        },
        "url": {
          "type": "string",
          "description": "通知先のURL"
        },
        "method": {
          "type": "string",
          "description": "HTTPメソッド"
        },
        "contenttype": {
          "type": "string",
          "description": "Conrent-type"
        },
        "headers": {
          "type": "object",
          "properties": {
            "Allow": {
              "type": "string",
              "description": "追加ヘッダー情報(キー名称は例。任意のヘッダー名称を指定可能。項目の個数も任意)"
            },
            "Authorization": {
              "type": "string",
              "description": "追加ヘッダー情報(キー名称は例。任意のヘッダー名称を指定可能。項目の個数も任意)"
            }
          },
          "description": "ヘッダー情報"
        },
        "httpbody": {
          "type": "string",
          "description": "HTTP BODY文字列"
        },
        "eventTypes": {
          "type": "array",
          "description": "イベント種別のIDの配列"
        }
      }
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200,
  "id": 111
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    },
    "id": {
      "type": "number",
      "description": "登録した情報のid"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 400,
  "reason": "Bad Request",
  "detail": {
    "code": "error.validate_error",
    "message": "パラメータが不正です。",
    "errors": {
      "パラメータ名": [
        {
          "code": "nullable",
          "message": "空白は許可されません。"
        }
      ]
    }
  }
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    },
    "detail": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "エラーコード。"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ。"
        },
        "errors": {
          "type": "object",
          "properties": {
            "パラメータ名": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "エラーコード。"
                  },
                  "message": {
                    "type": "string",
                    "description": "エラーメッセージ。"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

アクセストークン無効

Headers
Content-Type: application / json
Body
{
  "errror": "invalid_token",
  "error_description": "Invalid Access Token"
}
Schema
{
  "type": "object",
  "properties": {
    "errror": {
      "type": "string",
      "description": "認証エラーの種類。"
    },
    "error_description": {
      "type": "string",
      "description": "認証エラーの詳細"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

権限上不可視

Headers
Content-Type: application / json
Body
{
  "status": 403,
  "reason": "Forbidden"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  405
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 405,
  "reason": "Method Not Allowed"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status"
    },
    "reason": {
      "type": "string",
      "description": "statusのreason"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

HTTPアクション情報更新

HTTPアクション情報更新
POST/oauth2/httpAction/update

処理概要

  • idで指定したHTTPアクション情報情報を更新する。

  • バリデーションエラーのときはResponse 400が返る。

  • アクセストークンが有効でない、あるいはアクセストークンを指定しなかったときはResponse 401が返る。

  • 権限上不可視なHTTPアクションを指定した場合やアクション情報編集権限がない場合はResponse 403が返る。

  • 存在しないユーザを指定した場合はResponse 404が返る。

  • eventTypes の省略は、空の状態を指定したと同等の扱いとなる。

  • POSTメソッドでリクエストした場合はResponse 405が返る。

Example URI

POST /oauth2/httpAction/update
Request
HideShow
Headers
Content-Type: application/json
Authorization: bearer <アクセストークン>
Body
{
  "data": {
    "id": 1,
    "name": "アクション1",
    "url": "http://test.com",
    "method": "POST",
    "contenttype": "FORM",
    "headers": {
      "Allow": "aaaaa",
      "Authorization": "xxxxxx"
    },
    "httpbody": "key1=value1&key2=value2",
    "eventTypes": [
      1
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "HTTPアクションのid"
        },
        "name": {
          "type": "string",
          "description": "名前"
        },
        "url": {
          "type": "string",
          "description": "通知先のURL"
        },
        "method": {
          "type": "string",
          "description": "HTTPメソッド"
        },
        "contenttype": {
          "type": "string",
          "description": "Conrent-type"
        },
        "headers": {
          "type": "object",
          "properties": {
            "Allow": {
              "type": "string",
              "description": "追加ヘッダー情報(キー名称は例。任意のヘッダー名称を指定可能。項目の個数も任意)"
            },
            "Authorization": {
              "type": "string",
              "description": "追加ヘッダー情報(キー名称は例。任意のヘッダー名称を指定可能。項目の個数も任意)"
            }
          },
          "description": "ヘッダー情報"
        },
        "httpbody": {
          "type": "string",
          "description": "HTTP BODY文字列"
        },
        "eventTypes": {
          "type": "array",
          "description": "イベント種別のIDの配列"
        }
      }
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 200
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "number",
      "description": "http status の値"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application / json
Body
{
  "status": 400,
  "reason": "Bad Request",
  "detail": {
    "code": "error.validate_error",
    "message": "パラメータが不正です。",
    "errors": {
      "パラメータ名": [
        {
          "code": "nullable"<