ログイン(パスワード認証)

ユーザー名/パスワードでログインします。

Examples

REQUEST EXAMPLE

サンプルは以下となります。

{
  "user_id": "admin_user",
  "password": "password"
}

Request Interface

https://ControlURL/api/login

REQUEST BODY SCHEMA : application/json

user_id : string

ユーザーID (必須)

password : string

パスワード (必須)

Response Interface

200 OK

RESPONSE HEADERS

Set-Cookie : string

セッションID

X-Request-ID : string

WebAPI履歴のレコードID

RESPONSE SCHEMA : application/json

user_id : string

ユーザーID

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)) or (Error3(object or null))

"Error1"、"Error2"、"Error3"のいずれかが設定されます。

Error1:
message : string

エラーメッセージ

tables : Array of strings

テーブル情報

query : string

クエリ情報

Error2:
hulft_id : string

HULFT ID

code : integer

実行結果

detail : integer

詳細コード

message : string

エラーメッセージ

Error3:
message : string

エラーメッセージ

fields : string

クエリ情報

]

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