ログイン
ユーザー名/パスワードでログインします。
Examples
REQUEST EXAMPLE
サンプルは以下となります。
{
"user_id": "user1",
"password": "password"
}
Request Interface
http://ControlURL/api/login
上のRequest InterfaceのURLで、斜体の文字部分に指定するパスについては以下を参照してください。
HULFT10 API Gateway ガイド : Request Interfaceの指定
REQUEST BODY SCHEMA : application/json
- user_id : string
-
ユーザーID （必須）
- password : string
-
パスワード （必須）
Response Interface
200 OK
RESPONSE HEADERS
- Set-Cookie : string
-
セッション情報を持つクッキー
- X-Request-ID : string
-
WebAPIのリクエストID
RESPONSE SCHEMA : application/json
- user_id : string
-
ユーザーID
- user_role : string
-
ログインユーザーの権限
以下のいずれかが取得されます。
- admin
-
: ユーザーの管理や接続先HULFTの追加を行うことができる権限
- member
-
: 登録済みのHULFTへの接続を行うことができる権限
400 リクエストエラー
RESPONSE HEADERS
- X-Request-ID : string
-
WebAPIのリクエストID
RESPONSE SCHEMA : application/json
- request_id : string
-
リクエストID
- accept_datetime : string <date-time>
-
受付日時
- api_path : string
-
APIパス
- http_method : string
-
HTTPリクエストのメソッド形式
以下のいずれかが取得されます。
GET
HEAD
POST
OPTIONS
PUT
DELETE
TRACE
PATCH
LINK
UNLINK
- errors : Array of objects
-
エラー詳細情報
以下の構造の情報（Array[]）が複数取得されます。
Array[
- kind : string
-
エラー種別
- description : string
-
エラーの説明
- measure : string
-
対処方法
- detail : string
-
詳細エラー情報
- additional : (Error1(object or null)) or (Error2(object or null))
-
"Error1"、"Error2"のいずれかが取得されます。
- Error1
-
- message : string
-
バリデーションエラーメッセージ
- fields : string
-
バリデーションフィールド情報
- Error2
-
- code : integer
-
HULFT実行結果
- detail : string
-
HULFT詳細コード
- latest_process_id : string
-
最新処理ID
- message : string
-
HULFTエラーメッセージ
]
401 認証エラー
RESPONSE HEADERS
- X-Request-ID : string
-
WebAPIのリクエストID
RESPONSE SCHEMA : application/json
- request_id : string
-
リクエストID
- accept_datetime : string <date-time>
-
受付日時
- api_path : string
-
APIパス
- http_method : string
-
HTTPリクエストのメソッド形式
以下のいずれかが取得されます。
GET
HEAD
POST
OPTIONS
PUT
DELETE
TRACE
PATCH
LINK
UNLINK
500 サーバー内部エラー
RESPONSE HEADERS
- X-Request-ID : string
-
WebAPIのリクエストID
RESPONSE SCHEMA : application/json
- request_id : string
-
リクエストID
- accept_datetime : string <date-time>
-
受付日時
- api_path : string
-
APIパス
- http_method : string
-
HTTPリクエストのメソッド形式
以下のいずれかが取得されます。
GET
HEAD
POST
OPTIONS
PUT
DELETE
TRACE
PATCH
LINK
UNLINK
- errors : Array of objects
-
エラー詳細情報
以下の構造の情報（Array[]）が複数取得されます。
Array[
- kind : string
-
エラー種別
- description : string
-
エラーの説明
- measure : string
-
対処方法
- detail : string
-
詳細エラー情報
]