業務グループの一覧の取得
機能
JP1/ITRMに登録されているすべての業務グループの一覧を取得します。一部の業務グループだけを取得するといった指定はできません。
業務グループが登録されていない場合は,0件となります。
取得する項目を次の表に示します。
項目 | 説明 |
---|---|
業務グループID | システムで自動的に割り振られた業務グループID。業務グループを一意に表す。 |
業務グループ名 | 業務グループのフルパス。 |
仮想ホストの一覧へのリンク※ | 仮想ホストの一覧を取得するAPIへのリンクアドレス。 |
APIのサポートバージョン
このAPIは,01.00以降で提供します。
HTTPリクエスト形式
業務グループの一覧を取得するAPIのHTTPリクエスト形式を次の表に示します。
項目 | 値 |
---|---|
Method | GET |
URI※ | /jp1itrm/api/realms |
Query String※ | - |
HTTPステータスコード
200 OK,またはエラーを示すステータスコードが出力されます。
詳細については,「API共通の仕様」の「HTTPステータスコード」を参照してください。
XMLのネームスペース
HTTPステータスコードが,200 OKの場合,http://www.hitachi.co.jp/soft/xml/jp1/itrm/api/realmsを使用します。
XMLのスキーマ
業務グループの一覧を格納するスキーマを次の表に示します。
エレメント | 説明 | type | 出現回数 | ||||
---|---|---|---|---|---|---|---|
階層1 | 階層2 | 階層3 | 階層4 | 最小 | 最大 | ||
realms | - | - | - | 業務グループの一覧。 | - | 1 | 1 |
realm | - | - | 業務グループ。 業務グループがJP1/ITRM上に1つも登録されていない場合,このエレメントの個数は0となる。 | - | 0 | 0以上の任意の数字 | |
@id | - | 業務グループID。 0以上の整数で表す。 | xs:long | 1 | 1 | ||
name | - | 業務グループ名。 業務グループフォルダ名と業務グループ名を"/"で連結した,2,048文字以内の文字列で表す。 | xs:string | 1 | 1 | ||
instances | - | 仮想ホストの一覧。 | - | 0 | 1 | ||
@href※ | 仮想ホストの一覧へのリンクアドレス。 1,024文字以内の文字列で表す。 | xs:string | 1 | 1 |
使用例
認証情報にユーザー名「portal01」,パスワード「password」を指定して,業務グループの一覧を取得する場合の使用例を示します。
GET△/jp1itrm/api/realms△HTTP/1.0
Authorization:△Basic△cG9ydGFsMDE6cGFzc3dvcmQwMQ==
(凡例) △:半角スペース
出力例
業務グループの一覧を取得する場合の出力例を示します。
HTTP/1.1 200 OK
Content-Length: 361
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<realms xmlns="http://www.hitachi.co.jp/soft/xml/jp1/itrm/api/realms">
<realm id="1">
<name>第一開発/1課/グループA</name>
<instances href="http://localhost:23505/jp1itrm/api/instances?realm=1" />
</realm>
<realm id="2">
<name>第一開発/1課/グループB</name>
<instances href="http://localhost:23505/jp1itrm/api/instances?realm=2" />
</realm>
:
</realms>