5.2.3 リクエスト形式
APIでインテリジェント統合管理基盤が提供する機能を利用するためのリクエスト形式を次に示します。
method△/application/component/apiVersion/resourceId?query△httpVersion requestHeader messageBody
- （凡例）
-
△：半角スペース
リクエスト形式の構成内容について，次の表で説明します。
|
項目 |
説明 |
|---|---|
|
method |
リソースに対する操作を指定します。APIの処理に応じて，メソッドを指定してください。APIがサポートするメソッドを次に示します。
指定するメソッドについては，各APIの「リクエスト形式」を参照してください。 |
|
application |
APIを提供するアプリケーション名称です。固定値として「im」指定します。 |
|
component |
APIのコンポーネント名です。固定値として「api」指定します。 |
|
apiVersion |
APIのバージョンです。固定値として「v1」指定します。 |
|
resourceId |
インテリジェント統合管理基盤が提供する機能をAPIのリソース識別子として提供しています。実行したい処理に応じて指定します。詳細は「表5-3 リソース識別子」を参照してください。 |
|
query |
クエリ文字列です。リクエストに検索条件を付加することで，レスポンスの出力内容をフィルタリングしたり，ソートしたりすることができます |
|
httpVersion |
APIが使用する通信プロトコルのバージョンです。固定値として「HTTP/1.1」を指定します。 |
|
requestHeader |
レスポンスのデータ形式およびレスポンスの言語コードなどを指定します。詳細は「表5-4 リクエストヘッダー」を参照してください。 |
|
messageBody |
メッセージボディーのデータ形式を指定します。 JSON形式を利用できます。文字コードは，UTF-8を使用します。 |
|
リソース識別子 |
アクセスするリソース |
|---|---|
|
nodes |
管理ノード |
|
status |
ステータス情報 |
|
links |
リンク情報（ジョブネットのつながりなど） |
|
events |
JP1イベント |
|
actions |
プラグインのアクション（性能情報取得など） |
|
login |
ログイントークンや権限 |
|
proxyUsers |
プロキシユーザー情報 |
|
ヘッダー |
説明 |
デフォルト値 |
指定の要否 |
|---|---|---|---|
|
Authorization |
APIの認証情報を設定します。呼び出しに権限が必要なAPIでは必ず指定してください。 認証情報の詳細，および認証情報を設定してREST APIを呼び出す方法については「5.2.8 REST APIの認証方法」を参照してください。 |
なし |
必須 |
|
Accept-Language |
レスポンスデータに指定したい言語の言語コードを，次のどちらかの値で指定します。
指定を省略した場合，指定できる値以外を指定した場合は，enが仮定されます。 指定した値に関わらず，ステータスコード200が返却されます。 |
en |
任意 |
|
Content-Type |
リクエストのメッセージボディーのデータ形式です。固定値として「application/json」を指定します。 POSTメソッドを使用する場合に指定を省略したり，不正な値を指定したりした場合は，ステータスコード415が返却されます。 POSTメソッドを使用する場合でメッセージボディーが無いとき，またはGETメソッドを使用する場合で「application/json」以外の値を指定したときは，ステータスコード200が返却されます。 |
なし |
必須 |
|
Content-Length |
リクエストのメッセージボディーの長さを指定します。
POSTメソッドを使用する場合で指定を省略した場合は，ステータスコード411が返却されます。 POSTメソッドを使用する場合に指定したサイズ以上のリクエストボディーを指定した場合，ステータスコード500が返却されます。 POSTメソッドを使用する場合でメッセージボディーが無いとき，またはGETメソッドを使用する場合は，ステータスコード200が返却されます。 |
なし |
|
|
Accept |
レスポンスのメッセージボディーのデータ形式です。固定値として「application/json」を指定します。 POSTメソッドを使用する場合で「application/json」以外の値を指定したときは，ステータスコード406を返却します。 POSTメソッドを使用する場合でメッセージボディーが無いとき，またはGETメソッドを使用する場合で「application/json」以外の値を指定したときは，ステータスコード200が返却されます。 |
application/json |
任意 |
|
Cookie |
再ログインしないで連続してREST APIを発行する場合，ログインAPIのレスポンスのCookie情報を指定します。 Cookieを指定するとセッションを維持できるようになり，REST APIを発行するたびにログイン/ログアウトをする必要がなくなります。REST APIの発行から3分を超えると，自動的にセッションは破棄されます。 セッションを維持しない場合は，指定する必要はありません。 また，REST APIに付加したログイン情報による認証（Basic認証）を使用する場合は，指定しないでください。 |
なし |
任意 |
上記の表に示す以外のプロパティが指定された場合，そのプロパティは無視されます。