API情報の取得

機能

JP1/ITRMの製品のバージョン,APIのバージョンなどのAPI情報を取得します。

取得する項目を次の表に示します。

項目説明
JP1/ITRMの製品のバージョンJP1/ITRMの製品のバージョン。
VV-RR-SS(バージョン-リビジョン-限定コード)形式で取得する。
APIのバージョンAPIのバージョン。
2桁の半角数字.2桁の半角数字形式で取得する。
APIのサポート状況を判断する。
業務グループの一覧へのリンク業務グループの一覧を取得するAPIへのリンクアドレス。
注※
リンクアドレス中のサーバを示す部分には,ユーザー設定プロパティファイル(jp1itrm.properties)のCO.ITRMServerURLキーで設定されたものが使用されます。詳細については,「ユーザー設定プロパティファイル(jp1itrm.properties)」(2. 定義ファイル)を参照してください。

APIのサポートバージョン

このAPIは,01.00以降で提供します。

HTTPリクエスト形式

API情報を取得するAPIのHTTPリクエスト形式を次の表に示します。

項目
MethodGET
URI/jp1itrm/api
Query String
(凡例)
-:なし。

HTTPステータスコード

200 OK,またはエラーを示すステータスコードが出力されます。

詳細については,「API共通の仕様」の「HTTPステータスコード」を参照してください。

XMLのネームスペース

HTTPステータスコードが,200 OKの場合,http://www.hitachi.co.jp/soft/xml/jp1/itrm/apiを使用します。

XMLのスキーマ

API情報を格納するスキーマを次の表に示します。

エレメント説明データ型出現回数
階層1階層2階層3最小最大
apiオブジェクトの一覧。11
@product_versionVV-RR-SS(バージョン-リビジョン-限定コード)形式のJP1/ITRMの製品バージョン。xs:string11
@api_version2桁の半角数字.2桁の半角数字形式のAPIのバージョン。xs:string11
linkオブジェクト。00以上の任意の数字
@relオブジェクトの種別。
次の値を表す。
  • realms
    業務グループの一覧の取得へのリンク。
xs:string11
@hrefオブジェクトへのリンクアドレス。
1,024文字以内の文字列で表す。
xs:string11
(凡例)
-:なし。
注※
リンクアドレス中のサーバを示す部分には,ユーザー設定プロパティファイル(jp1itrm.properties)のCO.ITRMServerURLキーで設定されたものが使用されます。詳細については,「ユーザー設定プロパティファイル(jp1itrm.properties)」(2. 定義ファイル)を参照してください。

使用例

認証情報にユーザー名「portal01」,パスワード「password」を指定して,API情報を取得する場合の使用例を示します。

GET△/jp1itrm/api△HTTP/1.0
Authorization:△Basic△cG9ydGFsMDE6cGFzc3dvcmQwMQ==

(凡例) △:半角スペース

出力例

API情報を取得した場合の出力例を示します。

HTTP/1.1 200 OK
Content-Length: 188
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<api product_version="09-51-01" api_version="01.00"
xmlns="http://www.hitachi.co.jp/soft/xml/jp1/itrm/api">
<link rel="realms" href="http://localhost:23505/jp1itrm/api/realms" />
</api>