4.5.1　jp1Imdd.callRest

REST APIを呼び出すメソッドです。jp1Imdd.callRestメソッドの詳細を次に示します。

メソッド名

Object jp1Imdd.callRest(String method, String url, Object headers, String body)

パラメーター

method

REST APIのメソッド

url

REST APIのURL

ホスト名を含むURLを指定する場合，ホスト名はhostsファイルやDNSに登録し，JP1/IM - ManagerホストのOS上で名前解決できるようにしてください。

jp1hostsファイルおよびjp1hosts2ファイルの設定は参照されません。

プロキシサーバを通して接続する場合は，インテリジェント統合管理基盤定義ファイル（imdd.properties）にプロキシ情報を定義してください。

詳細については，「インテリジェント統合管理基盤定義ファイル（imdd.properties）」（2. 定義ファイル）の「jp1.imdd.proxy.server[n].host」，「jp1.imdd.proxy.server[n].port」，「jp1.imdd.proxy.server[n].user」を参照してください。

_headers

REST APIのリクエストヘッダー

body

REST APIのリクエストのボディー

メソッドがGETで，ボディーが不要の場合は，bodyにnull，または空文字を設定します。

戻り値

REST APIのレスポンスを格納したオブジェクトを返却します。

オブジェクトに格納されているキーと値を次に示します。

項番	説明		キー	値
1	REST APIが正常に完了した場合		"`response`"	レスポンスオブジェクト
		レスポンスオブジェクトに格納されているキーと値	"`status`"	HTTPステータスコード
			"`headers`"	レスポンスヘッダー
			"`body`"	レスポンスボディー
2	URIの解析に失敗した場合		"`error`"	エラーオブジェクト
		エラーオブジェクトに格納されているキーと値	"`status`"	0
		エラーオブジェクトに格納されているキーと値	"`body`"	解析エラーの文字列
3	HTTPステータスコードが4xx系または5xx系，未知のステータスコードが返却された時		"`error`"	エラーオブジェクト
		エラーオブジェクトに格納されているキーと値	"`status`"	HTTPステータスコード
			"`headers`"	レスポンスヘッダー
			"`body`"	レスポンスボディー

例外

RestClientException

I/Oエラーが発生した場合

呼び出し例

module.exports = function(args) {
    var baseUrl = args.baseUrl;
    var manager = args.manager;
    var jp1token = args.jp1token;
 
    var method = 'POST';
    var apiPath = '/v1/authorization/token';
    var url = baseUrl + apiPath;
    var headers = {
        'Accept': 'application/json',
        'Content-Type': 'application/json',
        'X-AJS-Authorization-Token': jp1token,
    };
    var body = {
        parameters: {
            manager: manager,
            serviceName: 'AJSROOT1',
        }
    };
    return jp1Imdd.callRest(method, url, headers, JSON.stringify(body));
}

ページの先頭へ

4.5.1 jp1Imdd.callRest

4.5.1　jp1Imdd.callRest