Web サービス リファレンス

Web サービス リファレンス

Web サービス リファレンスでは、トップ レベルの CA ITCM インストール ディレクトリにある CA ITCM Web サービス WSDL（webserviceapi.wsdl）で説明されているように、CA ITCM Web サービスによって使用可能となるメソッドについて説明します。

CA ITCM Web サービスでは、いくつかの共通 CA ITCM タスクを実行できるユーティリティ メソッドが提供されています。 これらのメソッドは、以下のように論理的にグループ分けされています。

• 認証および Web サービス管理
• 展開
• エンタープライズの配信機能
• クエリ
• ソフトウェア
• セキュリティ
• ユニットおよびグループ
• OSIM
• ヘルス監視
• 自動化 Web サービス

文書化された各 Web サービス メソッドでは、セッション識別子が入力値として使用されます。 このセッション識別子は、Login メソッドを使用して、CA ITCM Web サービスにログインするときに作成されます。 セッション識別子は、Web サービス セッションごとに一意であり、認証されたユーザに関する情報が保持されています。

また、Web サービス メソッドでは、このリファレンス ドキュメントで説明するように、CA ITCM シーケンスおよび列挙が入力値として使用される場合もあります。

注：

• DMdeploy、OSIM、セキュリティ エリア、ソフトウェア ジョブ、ユニットの作成、自動化サービスに関連する Web サービスはドメイン マネージャでのみ適用可能です。
• 配信とドメイン グループに関連する Web サービスはエンタープライズ マネージャでのみ適用可能です。
• UTF8 以外のエンドポイントを使用しているとき、入力パラメータ文字列に英語以外の文字が含まれている場合、文字列は UTF8 にエンコードされた文字列に変換した後、入力パラメータを WS API に渡す前に、その文字列を ISO-8859-1 にエンコードされた文字列に変換する必要があります。
• アスタリスク（^m）は、パラメータが必須であることを示します。
• この Webservice API（webserviceapi.wsdl）は、Microsoft® .NET Framework、Java Axis、および Gsoap toolkit に準拠しています。
• すべての Webservice API に対するドキュメントは、CA ITCM Web Service WSDL ファイルに従ったものであり、使用中のクライアント ツールによるコード生成に従ったものではありません。
• WSDL （definitions¥service¥port¥SOAP:address¥location）でのサービス エンド ポイントは、以下のように記述されます。

  "http://<サーバ名>/UDSM_R11_WebService/mod_gsoap.dll" (Windows の場合)
  "http://<サーバ名>/UDSM_R11_WebService" (Linux の場合)

  ［既定の Web サイト］のリスニング ポート番号が 80 で、SSL が設定されていない場合にのみ、このパスが有効になります。

  ポート番号が 80 でないか、または SSL が設定されている場合、管理者は WSDL でサービス エンド ポイントを手動で変更し、異なるポートおよび SSL に準拠する必要があります。 たとえば、ポートが 5256 に変更された場合、Windows 上のサービス エンド ポイントは以下のようになります。

  「http://<servername>:5256/UDSM_R11_WebService/mod_gsoap.dll」

  SSL が設定されている場合は、http ではなく https を使用します。

• CO & AM コンポーネントと通信するすべての WS API では、DateTime 構造体は GMT で取得され、返されます。 SD コンポーネントと通信するすべての WS API では、DateTime 構造体はマネージャ マシンのタイム ゾーンで取得され、返されます。

このセクションには、以下のトピックが含まれています。

UTF-8 文字列の DSM Web サービス エンド ポイント

自動化 Web サービス エンド ポイント

列挙

メソッド

シーケンス

要素の配列

制限事項

設定パラメータ

SSL 設定

システム定義グループの、パラメータとしての受け渡し

UTF-8 文字列の DSM Web サービス エンド ポイント

CA ITCM は、UTF-8 文字列に対して WSDL とエンド ポイントを提供します。 新しい WSDL およびエンドポイントは、既存の WSDL およびエンドポイントに加えて使用できます。 UTF-8 文字列を受理するか返すために DSM の Web サービスを有効にする、新しい WSDL およびエンド ポイントを以下に示します。

WSDL： webserviceapi_utf8.wsdl

エンド ポイント： http://<ホスト名>/DSM_Webservice/mod_gsoap_utf8.dll

http://<ホスト名>/DSM_Webservice/wsdl を使用して、新しいエンドポイントを指す新しい WSDL にアクセスできます。

自動化 Web サービス エンド ポイント

以下の場所から自動化サービス URI および WSDL にアクセスできます。

• AutomationService URI - http://<ホスト名>:[tomcat ポート番号]/axis/services/automationService
• AutomationService WSDL - http://<ホスト名>:[tomcat ポート番号]/axis/services/automationService?wsdl

また、サーバ上で Automation Service WSDL ファイルは以下の場所にあります。

<DSM インストール フォルダ>¥webservices¥wsdl¥addons¥AutomationService.wsdl