名前

ChangeSynergy::csapi


詳細

ChangeSynergy::csapi クラスは、Rational Change サーバーに情報を送出するために、またこのサーバーから情報を読み出すために使用するクラスです。


メソッド

以下のメソッドを使用できます。

new
 sub new()

新しく作成される ChangeSynergy::csapi クラスを初期化します。

 my $csapi = new ChangeSynergy::csapi();
AddAPreferenceForAUser

ユーザーのユーザー設定と値を追加または変更します。 追加または変更する値は、構成ファイルの 1 つによりユーザー設定として定義済みである必要があります。 ユーザーの cfg 設定を編集または追加するには、keyName が「_USER_CFG_」である必要があります。そうすれば、システムはユーザー名を付け加えます。 返される結果は apiData クラスのインスタンスです。

注記: ユーザー・プロファイルの値は、変更または追加できません。 ユーザー・プロファイル値には、ユーザーのファーストネーム、ラストネーム、E メール・アドレス、ファックス番号、電話番号、および住所があります。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  username: 編集対象のユーザー設定の名前。
	スカラー  keyName : 追加対象の設定の名前。
	スカラー  keyValue: 追加対象の設定の値。
	スカラー allDBs  : true または false。
						追加を全データベースについて行うか、または現在の API ユーザーがログインしているデータベースだけに行うか。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");		
		$tmpData = $csapi->AddAPreferenceForAUser($aUser, "u00001", "user_fontsize", "9", "true");
	
		print $tmpData->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
AddAPreferenceForAllUsers

全ユーザーのユーザー設定と値を追加または変更します。 追加または変更する値は、構成ファイルの 1 つによりユーザー設定として定義済みである必要があります。 ユーザーの cfg 設定を編集または追加するには、keyName が「_USER_CFG_」である必要があります。そうすれば、システムはユーザー名を付け加えます。 返される結果は apiData クラスのインスタンスです。

注記: ユーザー・プロファイルの値は、変更または追加できません。 ユーザー・プロファイル値には、ユーザーのファーストネーム、ラストネーム、E メール・アドレス、ファックス番号、電話番号、および住所があります。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  keyName : 追加対象の設定の名前。
	スカラー  keyValue: 追加対象の設定の値。
	スカラー allDBs  : true または false。
						追加を全データベースについて行うか、または現在の API ユーザーがログインしているデータベースだけに行うか。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");		
		$tmpData = $csapi->AddAPreferenceForAllUsers($aUser, "user_fontsize", "9", "true");
	
		print $tmpData->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
addFolder

新しい空のクエリー、レポート・フォーマット、またはレポート・フォルダーをサーバーに追加します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  folderName: 追加対象のフォルダーの名前。
	スカラー  objectType : フォルダーのオブジェクト・タイプ。
	スカラー  formatType : フォルダーのフォーマット・タイプ: レポート、クエリーまたはレポート・フォーマット。
	スカラー  configType : レポートの構成場所。
 有効なオブジェクト・タイプ (Globals.pm に定義された定数):
        PROBLEM_TYPE
        TASK_TYPE
        OBJECT_TYPE
 有効なフォーマット・タイプ (Globals.pm に定義された定数):
 		QUERY
        REPORT
        REPORT_FORMAT
 

 有効な構成タイプ (Globals.pm に定義された定数):
        SHARED_PROFILE
        SYSTEM_CONFIG
        USER_PROFILE

 戻り値: apiData
	サーバーからのリターン・メッセージ。

 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "Admin", "\\\\machine\\ccmdb\\cm_database");
		
		my $globals = new ChangeSynergy::Globals();
		
		#Create a new shared CR Report folder called 'API Folder'.

		my $addResults = $csapi->addFolder($aUser, "API Folder", $globals->{PROBLEM_TYPE}, $globals->{REPORT}, $globals->{SHARED_PROFILE});
		print $addResults->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
AttributeModifyCRData

変更依頼の詳細を、変更依頼の詳細の修正が可能なデータ・クラスにロードします。 修正されたデータ・クラスは、変更依頼を変更するために、修正 API 関数の 1 つを使って提出できます。 返される結果は apiObjectVector クラスのインスタンスです。

注記: 現在の遷移の選択肢は、この API 関数呼び出しによって提供されます。 apiTransitions クラスの説明を参照してください。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー problemNumber : 参照する変更依頼 ID/問題番号 ID。
 戻り値: apiObjectVector
データ形式の変更依頼の詳細。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->AttributeModifyCRData($aUser, "100");
		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
AttributeModifyCRData

変更依頼の詳細を、変更依頼の詳細の修正が可能なデータ・クラスにロードします。 修正されたデータ・クラスは、変更依頼を変更するために、修正 API 関数の 1 つを使って提出できます。 返される結果は apiObjectVector クラスのインスタンスです。

注記: 現在の遷移の選択肢は、この API 関数呼び出しによって提供されます。 apiTransitions クラスの説明を参照してください。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  problemNumber: 参照する変更依頼 ID/問題番号 ID。
	スカラー  attributeName: 参照されるオブジェクトの現在値を検索する属性の名前。この値は IBM Rational Change テンプレートの名前である必要があります。
 戻り値: apiObjectVector
データ形式の変更依頼の詳細。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->AttributeModifyCRData($aUser, "100", "crstatus");
		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
AttributeModifyCRDataAllTransitions

変更依頼の詳細を、変更依頼の詳細の修正が可能なデータ・クラスにロードします。 修正されたデータ・クラスは、変更依頼を変更するために、修正 API 関数の 1 つを使って提出できます。 返される結果は apiObjectVector クラスのインスタンスです。 AllTransitions 関数には表示されない遷移が含まれています。

注記: 現在の遷移の選択肢は、この API 関数呼び出しによって提供されます。 apiTransitions クラスの説明を参照してください。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  problemNumber: 参照する変更依頼 ID/問題番号 ID。
	スカラー  attributeName: 参照されるオブジェクトの現在値を検索する属性の名前。この値は IBM Rational Change テンプレートの名前である必要があります。
 戻り値: apiObjectVector
データ形式の変更依頼の詳細。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->AttributeModifyCRDataAllTransitions($aUser, "100", "crstatus");
		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
AttributeModifyCRDataAllTransitions

変更依頼の詳細を、変更依頼の詳細の修正が可能なデータ・クラスにロードします。 修正されたデータ・クラスは、変更依頼を変更するために、修正 API 関数の 1 つを使って提出できます。 返される結果は apiObjectVector クラスのインスタンスです。 AllTransitions 関数には表示されない遷移が含まれています。

注記: 現在の遷移の選択肢は、この API 関数呼び出しによって提供されます。 apiTransitions クラスの説明を参照してください。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー problemNumber : 参照する変更依頼 ID/問題番号 ID。
 戻り値: apiObjectVector
データ形式の変更依頼の詳細。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->AttributeModifyCRDataAllTransitions($aUser, "100");
		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
BalanceTransactionServer

セッション・バランス・ルーチンを起動します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->BalanceTransactionServer($aUser);
	};
	if ($@)
	{
		print $@;
	}
CallBsfScript

サーバー上の Bean Scripting Framework (BSF) スクリプトを呼び出して、戻り値を取得します。 BSF スクリプトはサーバー上の wsconfig/scripts ディレクトリーに配置されている必要があります。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  scriptName: サーバーで実行するスクリプトの名前。wsconfig/script ディレクトリーに配置されている必要があります。
						値は、このメソッドによって XML エンコードされます。
	スカラー  scriptData: 文字列としてスクリプトに送信すべきデータ。XML エンコードされる必要があります。
						値は、このメソッドによって XML エンコードされます。
 戻り値: apiData

	スクリプトからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $scriptResults = $csapi->CallBsfScript($aUser, "testscript.js", "Data to the script");
		print $scriptResults->getResponseData() . "\n";
	};
	if ($@)
	{
		print $@;
	}
ChangePreferenceNameForAUser

1 人のユーザーのユーザー設定の名前を変更します。 設定名は、そのユーザーの既存の設定名に変更することはできません。 返される結果は apiData クラスのインスタンスです。

注記: ユーザー・プロファイルの値は、変更または追加できません。 ユーザー・プロファイル値には、ユーザーのファーストネーム、ラストネーム、E メール・アドレス、ファックス番号、電話番号、および住所があります。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  username: 編集対象のユーザー設定の名前。
	スカラー  keyName : 変更対象の設定の名前。
	スカラー  keyValue: 設定の新しい名前。
	スカラー allDBs  : true または false。
						追加を全データベースについて行うか、または現在の API ユーザーがログインしているデータベースだけに行うか。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");		
		$tmpData = $csapi->ChangePreferenceNameForAUser($aUser, "u00001", "user_cr_notes", "user_crnotes", "true");
	
		print $tmpData->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
ChangePreferenceNameForAllUsers

システムの全ユーザーのユーザー設定の名前を変更します。 設定名は、ユーザーの既存の設定名に変更することはできません。 ユーザーの設定名がない場合、そのユーザーについての変更は行われません。 設定名がある場合は、設定名が適宜に変更されます。 返される結果は apiData クラスのインスタンスです。

注記: ユーザー・プロファイルの値は、変更または追加できません。 ユーザー・プロファイル値には、ユーザーのファーストネーム、ラストネーム、E メール・アドレス、ファックス番号、電話番号、および住所があります。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  keyName : 変更対象の設定の名前。
	スカラー  keyValue: 設定の新しい名前。
	スカラー allDBs  : true または false。
						追加を全データベースについて行うか、または現在の API ユーザーがログインしているデータベースだけに行うか。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");		
		$tmpData = $csapi->ChangePreferenceNameForAllUsers($aUser, "user_cr_notes", "user_crnotes", "true");
	
		print $tmpData->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
ChangeRequestFullName

変更依頼の 4 部構成名を取得します。

 パラメーター:
 
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー ProblemNumber: 問題番号。

戻り値: スカラー
4 部構成名。
ClearAllUserConfigurationData

すべてのユーザー構成データを、IBM Rational Change サーバーからアンロードします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ClearAllUserConfigurationData($aUser);
	};
	if ($@)
	{
		print $@;
	}
ClearBusySessions

ビジー・セッション・テーブルをクリアします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ClearBusySessions($aUser);
	};
	if ($@)
	{
		print $@;
	}
ClearTransitionUserList

遷移ユーザー・リストをクリアし、次の依頼で新しいコピーを作成します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ClearTransitionUserList($aUser);
	};
	if ($@)
	{
		print $@;
	}
ClientAPIVersion

クライアントの API バージョン番号を取得します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData


	バージョン番号文字列。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr1 = $csapi->ClientAPIVersion($aUser);
	};
	if ($@)
	{
		print $@;
	}
CopyCRData

変更依頼の詳細の提出またはコピーが可能なデータ・クラスに、変更依頼の詳細をロードします。 修正されたデータ・クラスは、変更依頼を変更するために、修正 API 関数の 1 つを使って提出できます。 返される結果は apiObjectVector クラスのインスタンスです。

注記: 提出の「to 状態」(to state) と「関連名」(relation name) はこの API 関数呼び出しで提供されます。 apiTransitions クラスの説明を参照してください。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー problemNumber : 参照する変更依頼 ID/問題番号 ID。
	スカラー templateName : ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
 戻り値: apiObjectVector
データ形式の変更依頼の詳細。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->CopyCRData($aUser, "100", "COPY_child_cr2new_child");
		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
CopyTaskData

タスク詳細の提出またはコピーが可能なデータ・クラスに、タスクの詳細をロードします。 修正されたデータ・クラスは、タスクを変更する修正 API 関数の 1 つを使って提出できます。 返される結果は apiObjectVector クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー taskNumber   : 参照するタスク ID。
	スカラー templateName : ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
 戻り値: apiObjectVector
	データ形式のタスクの詳細。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->CopyTaskData($aUser, "12", "CreateTask");
		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
CreateAttachmentObject

IBM Rational Change サーバー上で添付ファイル・オブジェクトを作成し、それを CR に関連付けます。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  problemNumber: ファイルを関連付ける ProblemNumber/CR ID。
	スカラー  relation      : オブジェクトを CR に関連付けるときに使用する関係名。
	スカラー  attachmentName: このオブジェクトのファイル名。
スカラー webType       : クライアント上の復帰改行シーケンス。
	                              CRLF:   Windows クライアント・テキスト・ファイル。

	                              LF:     Unix クライアント・テキスト・ファイル。
	                              BINARY: ファイルはバイナリーです。
	スカラー  comment       : 更新するオブジェクトのコメント。
	スカラー  type          : 将来の使用のために予約済み。
	スカラー  isBinary      : ファイルがバイナリー・ファイルであることを指定するフラグ。
	スカラー  buffer        : データのバッファー。
	スカラー  size          : バッファーのサイズ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 例:
	my $csapi  = new ChangeSynergy::csapi();

	my $buf    = "";

	my $buffer = "";

	my $size   = "";
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		open(INPUTFILE, "output.doc") or die "Could not open up the file";
		binmode(INPUTFILE);
		while($buf = readline *INPUTFILE)
		{
			$buffer .= $buf;
		}
		close(INPUTFILE);
	
		$size = -s "output.doc";
    	

		my $data = $csapi->CreateAttachmentObject($aUser, "1", "attachment", "output",
											   "BINARY", "The output", "", "true", $buffer, $size);
		print $data->getResponseData();
	};

	if ($@)
	{
		print $@;
	}
CreateCSObject

オブジェクト・エンティティーを「model」モデルで作成します。 完全な解説については CreateNewCV を参照してください。 新しいエンティティーのフルネーム属性の値を設定するため、引数 cvtype と name が使用されます。 フルネームが IBM Rational Synergy データベースのすべてのオブジェクトを通じて一意でない場合、作成することはできません。

オブジェクトには、英数字と !&^~@*_.+: を使用した名前を含めることができます。ただし、モデルによっては、より制約された命名規則が適用される場合があります。

注記: 「cvtype」が空の文字列の場合、タイプは「cs_object」となります。

注記: 「cvtype」はモデル・オブジェクトで定義されている必要があります。

 注記: 「State」が空の文字列の場合、状態はデフォルトの「cs_public」となります。
 注記: デフォルトの状態は変更されました (ac_def -> cs_public)。
       デフォルトの状態では遷移はできません。

返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  cvtype  : 要求される 4 部構成オブジェクト名の cvtype 値。
	スカラー  name    : 要求される 4 部構成オブジェクト名の name 値。
	スカラー  state   : 自動遷移する status (state) の値。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
	getResponseData() メソッドを使用してオブジェクト ID を取得します。
	文字列の値の例: "CV: 5_digit_integer_value_of_object"
	
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->CreateCSObject($aUser, "admin", "special","");
		print $tmp->getResponseData(); #ex: "CV: 12345"
		#Note: Result will be like: "CV: 5_digit_integer_value_of_object".
	};
	if ($@)
	{
		print $@;
	}
CreateDefaultCSObject

オブジェクト・エンティティーを「model」モデルで作成します。 完全な解説については CreateNewCV を参照してください。

新しいエンティティーのフルネーム属性の値を設定するため、引数 name が使用されます。 フルネームが IBM Rational Synergy データベースのすべてのオブジェクトを通じて一意でない場合、作成することはできません。 オブジェクトには、英数字と !&^~@*_.+: を使用した名前を含めることができます。ただし、モデルによっては、より制約された命名規則が適用される場合があります。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  name    : 要求される 4 部構成オブジェクト名の name 値。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
	getResponseData() メソッドを使用してオブジェクト ID を取得します。
	文字列の値の例: "CV: 5_digit_integer_value_of_object"
	
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->CreateDefaultCSObject($aUser, "special");
		print $tmp->getResponseData(); #ex: "CV: 12345"
		#Note: Result will be like: "CV: 5_digit_integer_value_of_object".
	};
	if ($@)
	{
		print $@;
	}
CreateIndex

SYNERGY/Change サーバーに検索用インデックスを作成します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->CreateIndex($aUser);
	};
	if ($@)
	{
		print $@;
	}
CreateMiscObject

misc オブジェクトを作成します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー objectString: 作成されるオブジェクト識別子。

 戻り値: apiData
	新規オブジェクトの CVID。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->CreateMiscObject($aUser, "DOORS_ID_400");
	};
	if ($@)
	{
		print $@;
	}
CreateNewCV

警告: このメソッドは一般的な使用を意図していません。このメソッドのユーザーは、ACcent プログラミングにかなり精通している必要があります。 それ以外の場合は、一般的な「CreateCSObject」または「CreateDefaultCSObject」API メソッドを使用してください。

オブジェクト・エンティティーを「model」モデルで作成します。

[subsys/cvtype/name/version] 例: "1/admin/cs/1"

新しいエンティティーのフルネーム属性の値を設定するため、引数 subsys、cvtype、name および version が使用されます。 フルネームが IBM Rational Synergy データベースのすべてのオブジェクトを通じて一意でない場合、作成することはできません。

オブジェクトには、英数字と !&^~@*_.+: を使用した名前を含めることができます。ただし、モデルによっては、より制約された命名規則が適用される場合があります。 注記: 「version」が空の文字列の場合、バージョンは「1」となります。

注記: 「cvtype」が空の文字列の場合、タイプは「cs_object」となります。

注記: 「cvtype」はモデル・オブジェクトで定義されている必要があります。

デフォルト・モデル上で定義済みの cvtype: cs_object,admin,ascii,asm0,baseline,binary,bitmap,c++,class,csrc, css,dir,dtd,executable,folder,folder_temp,gif,group,html, incl,jar,java,jpeg,library,lsrc,makefile,misc,perl,problem, project,recon_temp,releasedef,relocatable_obj,shared_library, shsrc,symlink,task,tset,xml,ysrc

注記: 「subsys」に DBID や DCM 区切り文字を追加しないでください。 これらの値は DCM/DCS が初期化されると自動的に追加されます。 DBID や DCM 区切り文字が追加されると、foo#1 となるべき「subsys」が、foo#foo#1 のようになってしまいます。

注記: 「subsys」が空の文字列の場合、instance_number は算出されます。 DCM/DCS が初期化されると、「subsys」または算出されたインスタンスのほかに、DCM データベース ID と DCM 区切り文字が使用されます。

      DCM が初期化された場合:
         例: db63#1/cs_object/your_name/1
      DCM が初期化されていない場合:
         例: 1/cs_object/your_name/1

 
新規エンティティーの以下の属性が作成され、値が指定されます。
 create_time  : time    : 現在時刻。
 cvtype       : string  : 引数 cvtype。

 is_asm       : boolean : オブジェクト・タイプの「is_asm」属性の値。
 is_model     : boolean : オブジェクト・タイプの「is_model」属性の値。
 modify_time  : time    : 現在時刻。
 name         : string  : 引数名。
 owner        : string  : 現在のユーザー。
 status       : string  : オブジェクト・タイプの「dflt_status」属性の値。
 subsystem    : string  : 引数 subsys。
 version      : string  : 引数 version。
 
注記: 「State」が空の文字列の場合、状態はデフォルトの「cs_public」となります。

注記: デフォルトの状態は変更されました (ac_def -> cs_public)。 デフォルトの状態では遷移はできません。

デフォルトのセキュリティーは CHANGE_STATE =「cs_public」に基づいています

			  *** システムで定義済みの state ***
 state working            = private + read + eval;
 state visible            = private + read + eval + bind;
 state working_folder     = private + read + eval + user1;
 state checkpoint         = private + read + eval + user0;
 state readonly           = static + read + eval;
 state cs_admin           = static + read + user9;
 state published_baseline = static + read + eval + user7;
 state released           = static + read + eval + derive + bind;
 state readonly_folder    = static + read + eval + derive + user0;
 state rejected           = static + read + eval + derive + bind + user3;
 state test               = static + read + eval + derive + bind + user2;
 state sqa                = static + read + eval + derive + bind + user0;
 state integrate          = static + read + eval + derive + bind + user1;
 
 state task_deferred      = read + write + user0;
 state registered         = read + write + user1;
 state task_assigned      = read + write + user2;
 state completed          = read + write + user3;
 state deleted            = read + write + user4;
 state excluded           = read + write + user5;
 state task_automatic     = read + write + user6;
 state public             = read + eval  + bind   + write;
 state crbase             = read + write + eval   + user1;
 state entered            = read + write + eval   + user2;
 state deferred           = read + write + eval   + user3;
 state concluded          = read + write + eval   + user4;
 state duplicate          = read + write + user1  + user2;
 state working_recon_temp = read + eval  + write  + user5;
 state static_recon_temp  = read + eval  + static + user5;
 state prep_baseline      = read + eval  + write  + user7;
 state shared_folder      = read + eval  + derive + write;
 state shared             = read + eval  + derive + bind  + write;
 state admin              = read + eval  + bind   + write + user0;
 state release_admin      = read + eval  + write  + user0 + user1;
 state cs_public          = read + eval  + bind   + write + user8;
 state in_review          = read + write + eval   + bind  + user1;
 state assigned           = read + write + eval   + bind  + user2;
 state probreject         = read + write + eval   + bind  + user3;
 state resolved           = read + write + eval   + bind  + user4;
 state prep_folder        = read + eval  + derive + write + user1;
 state prep               = read + eval  + derive + bind  + write + user0;
 state dcm_admin          = read + eval  + bind   + write + user0 + user1;

返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  subsys  : 要求される 4 部構成オブジェクト名の subsys 値。
	スカラー  cvtype  : 要求される 4 部構成オブジェクト名の cvtype 値。
	スカラー  name    : 要求される 4 部構成オブジェクト名の name 値。
	スカラー  version : 要求される 4 部構成オブジェクト名の version 値。
	スカラー  state   : 自動遷移する status (state) の値。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
	getResponseData() メソッドを使用してオブジェクト ID を取得します。
	文字列の値の例: "CV: 5_digit_integer_value_of_object"
	
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->CreateNewCV($aUser, "", "admin", "special", "1", "");
		print $tmp->getResponseData(); #ex: "CV: 12345"
		#Note: Result will be like: "CV: 5_digit_integer_value_of_object".
	};
	if ($@)
	{
		print $@;
	}
CreateObjectAttributes

名前「your name value」と属性タイプ「your type value」を使用して、オブジェクトの新しい属性を作成します。「type」はモデル・オブジェクトで定義されている必要があります。属性に与える初期値を供給する必要があります。 この操作はオブジェクトの modify_time 属性も更新します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー        cvidList    : パイプ文字「|」で区切られた、影響を受ける cvid のリスト、または 1 つの cvid。
	apiObjectVector attrData    : API 関数によって処理されるデータ。
 
 戻り値: apiData
	サーバーからのリターン・メッセージ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $attrData = new ChangeSynergy::apiObjectVector();
		my $objData = new ChangeSynergy::apiObjectData();
		$objData->setName("attribute_a");
		$objData->setType("text");
		$objData->setValue("Linux");
		$attrData->addDataObject($objData);
		my $objData = new ChangeSynergy::apiObjectData();
		$objData->setName("attribute_b");
		$objData->setType("boolean");
		$objData->setValue("true");
		$attrData->addDataObject($objData);
		my $objData = new ChangeSynergy::apiObjectData();
		$objData->setName("attribute_c");
		$objData->setType("integer");
		$objData->setValue("777");
		$attrData->addDataObject($objData);
		my $tmp = $csapi->CreateObjectAttributes($aUser, "10156|10157|10158|10159|10160", $attrData)
		print $tmp->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
createProcessPackage

サーバー上の XML ファイルと同じくサーバー上のパッケージ・テンプレートから CRProcess パッケージを作成します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  xmlFileName     : WEB-INF\cr_process ディレクトリーにある CR プロセス XML ファイル名。
	スカラー packageTemplate : WEB-INF\package_templates ディレクトリーにあるマージ対象のパッケージ・テンプレート名。
 戻り値: apiData

	作成されたパッケージ名。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $globals = new ChangeSynergy::Globals();
		my $aUser = $csapi->Login("u00001", "u00001", "Admin", "\\\\machineA\\ccmdb\\cm_database");
		my $response = $csapi->createProcessPackage($aUser, "dev_process.xml", "dev_template");
		print $response->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
CreateRelation

2 つの IBM Rational Synergy オブジェクト間の関連を作成します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  bothWayRelationship: 双方向の関係を作成します [true|false]。
	スカラー  fromObject         : 作成する関係の元となるオブジェクト。
	スカラー  toObject           : 関係の適用先となるオブジェクト。
スカラー relationName: 有効な IBM Rational Synergy/IBM Rational Change 関連名。
	スカラー  relationType       : 関係タイプ (以下を参照してください)。
 有効な関係タイプ (Globals.pm に定義された定数):
        CCM_PROBLEM_PROBLEM  // 変更依頼から変更依頼への関係を作成します。
        CCM_PROBLEM_TASK     // 変更依頼からタスクへの関係を作成します。
        CCM_PROBLEM_OBJECT   // 変更依頼からオブジェクトへの関係を作成します。
        CCM_TASK_PROBLEM     // タスクから変更依頼への関係を作成します。
        CCM_TASK_TASK        // タスクからタスクへの関係を作成します。
        CCM_TASK_OBJECT      // タスクからオブジェクトへの関係を作成します。
        CCM_OBJECT_PROBLEM   // オブジェクトから変更依頼への関係を作成します。
        CCM_OBJECT_TASK      // オブジェクトからタスクへの関係を作成します。
        CCM_OBJECT_OBJECT    // オブジェクトからオブジェクトへの関係を作成します。
        
        使用例:


          my $globals = new ChangeSynergy::Globals();

          my $relationType = $globals->{CCM_PROBLEM_PROBLEM};
 戻り値: apiData

	作成できた場合、結果のみが戻されます。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $globals = new ChangeSynergy::Globals();
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->CreateRelation($aUser, "FALSE", "400", "1355", "my_copy",
                                            $globals->{CCM_PROBLEM_PROBLEM});
	};
	if ($@)
	{
		print $@;
	}
createReport

既存の Change レポートに基づいて新規の Change レポートを作成します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  reportDefinition   : ChangeSynergy::CreateReportDefinition オブジェクトのインスタンス。
	スカラー  objectType         : レポートのクエリー対象となるオブジェクト・タイプ。
	スカラー  configType         : レポートの最終的な構成場所。有効なタイプは user および shared のみです。
 有効なオブジェクト・タイプ (Globals.pm に定義された定数):
        PROBLEM_TYPE
        TASK_TYPE
        OBJECT_TYPE
 有効な構成タイプ (Globals.pm に定義された定数):
        SHARED_PROFILE
        USER_PROFILE
 戻り値: apiData

	作成できたかどうかを示す結果。

createReport API の使用例については、CreateReportDefinition のヘルプの例を参照してください。必要なパラメーター名、クエリー・ストリング、および基本レポートがすべて CreateReportDefinition オブジェクトで定義されていることを確認してください。

CreateUserSecurityData

サーバーにユーザー・セキュリティー・ファイルを作成します。

 パラメーター:
 
	apiUser aUser:      現在の API ユーザーのログイン・データ。
 
戻り値: スカラー
リターン・メッセージ。
 例:
	my $csapi  = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->CreateUserSecurityData($aUser);
	}
	if ($@)
	{
		print $@;
	}
CSHostName

IBM Rational Change サーバーの構成されたホスト名を取得します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	ホスト名の文字列。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->CSHostName($aUser);
	};
	if ($@)
	{
		print $@;
	}
DatabaseGetObject

データベース・オブジェクトを新しいバイト配列にコピーします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser:      現在の API ユーザーのログイン・データ。
	スカラー  Cvid : 取り出すソース・オブジェクトの cvid。
 戻り値: apiData

	サーバーからのバイト・データ
	
 例:
 
 	$csapi->setUpConnection("http://your_hostname:port/your_context");
 	
 	eval
 	{

 		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");

 		my $data  = $csapi->DatabaseGetObject($aUser, "11023");
		open(OUTPUT, ">file.txt");
		print(OUTPUT $data->getResponseByteData());
		close(OUTPUT);
 	};
 	
 	if ($@)
	{
		print $@;
	}
DatabaseSetObject

IBM Rational Change サーバーのファイル・オブジェクトを更新します。 更新できるのは「public」状態のオブジェクトだけです。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  cvid   : 更新する public ソース・オブジェクトの cvid。
	スカラー  comment: 更新するオブジェクトのコメント。
	スカラー  buffer : サーバー上に設定するバイト・データ。
	スカラー  size  : バイト・データのサイズ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
	
 例:
 
 	$csapi->setUpConnection("http://your_hostname:port/your_context");
 	my $buf    = "";

	my $buffer = "";

	my $size   = "";
 	
	eval
	{

		my $aUser      = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
 		

		open(INPUTFILE, "input.txt") or die "Could not open up the file";
		while($buf = readline *INPUTFILE)
		{
			$buffer .= $buf;
		}
		close(INPUTFILE);
    
		$size = -s "input.txt";
    	

		my $data = $csapi->DatabaseSetObject($aUser, "10341", "new comment", $buffer, $size);
	};
 	
	if ($@)
	{
		print $@;
	}
DeleteAllUserPreferences

システム内の全ユーザーの全設定オブジェクトを削除します。 警告 - この操作によって、全ユーザーの全設定が永久に削除されます。復旧する方法はありません。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");		
		$tmpData = $csapi->DeleteAllUserPreferences($aUser);
	
		print $tmpData->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
DeleteAPreferenceForAllUsers

システム内の全ユーザーの設定を削除します。 警告 - この操作によって、全ユーザーの 1 つの設定が永久に削除されます。復旧する方法はありません。 返される結果は apiData クラスのインスタンスです。

注記: ユーザー・プロファイルの値は、削除できません。 ユーザー・プロファイル値には、ユーザーのファーストネーム、ラストネーム、E メール・アドレス、ファックス番号、電話番号、および住所があります。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  keyName : 削除対象の設定の名前。
	スカラー allDBs  : true または false。
						追加を全データベースについて行うか、または現在の API ユーザーがログインしているデータベースだけに行うか。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");		
		$tmpData = $csapi->DeleteAPreferenceForAllUsers($aUser, "user_fontsize", "true");
		print $tmpData->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
DeleteAPreferenceForAUser

システムのユーザー設定を削除します。 警告 - この操作によって、ユーザーの 1 つの設定が永久に削除されます。復旧する方法はありません。返される結果は apiData クラスのインスタンスです。

注記: ユーザー・プロファイルの値は、削除できません。 ユーザー・プロファイル値には、ユーザーのファーストネーム、ラストネーム、E メール・アドレス、ファックス番号、電話番号、および住所があります。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  username: 削除対象のユーザー設定の名前。
	スカラー  keyName : 削除対象の設定の名前。
	スカラー allDBs  : true または false。
						追加を全データベースについて行うか、または現在の API ユーザーがログインしているデータベースだけに行うか。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");		
		$tmpData = $csapi->DeleteAPreferenceForAUser($aUser, "u00001", "user_fontsize", "true");
	
		print $tmpData->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
DeleteAUsersPreferences

システム内の 1 人のユーザーの設定オブジェクトを削除します。 警告 - この操作によって、1 人のユーザーのすべての設定が永久に削除されます。復旧する方法はありません。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  username: 削除対象のユーザー設定の名前。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");		
		$tmpData = $csapi->DeleteAUsersPreferences($aUser, "u00001");
	
		print $tmpData->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
DeleteChangeRequest

変更依頼を削除します。 この操作を行うにはプロセス管理権限が必要です。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  problemNumber: 削除対象の問題番号。
 戻り値: apiData

	削除状況メッセージ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->DeleteChangeRequest($aUser, "10");
	};
	if ($@)
	{
		print $@;
	}
DeleteCV

オブジェクトとすべての従属するオブジェクトおよび属性をデータベースから削除します。 従属するオブジェクトにはバインディング (アセンブリーの場合) およびディレクトリー・エントリーが含まれます。次のいずれかの条件が true の場合、エンティティーは削除されません。

         >オブジェクトが既存のプロジェクトのメンバーである。
         >オブジェクトがモデル・オブジェクトである。
         >オブジェクトがタイプ・オブジェクトであり、そのインスタンスが現在存在している。
         >オブジェクトがタイプ・オブジェクトであり、別の既存のタイプ・オブジェクトの super_type でもある。
             

返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  cvid  : 削除対象のオブジェクトの cvid。
 
 戻り値: apiData
	サーバーからのリターン・メッセージ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->DeleteCV($aUser,"10159");
		print $tmp->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
deleteFolder

クエリー、レポート・フォーマット、またはレポート・フォルダーとすべてのメンバーを、サーバーから削除します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  folderName: 削除対象のフォルダーの名前。
	スカラー  objectType : フォルダーのオブジェクト・タイプ。
	スカラー  formatType : フォルダーのフォーマット・タイプ: レポート、クエリーまたはレポート・フォーマット。
	スカラー  configType : レポートの構成場所。
 有効なオブジェクト・タイプ (Globals.pm に定義された定数):
        PROBLEM_TYPE
        TASK_TYPE
        OBJECT_TYPE
 有効なフォーマット・タイプ (Globals.pm に定義された定数):
 		QUERY
        REPORT
        REPORT_FORMAT
 

 有効な構成タイプ (Globals.pm に定義された定数):
        SHARED_PROFILE
        SYSTEM_CONFIG
        USER_PROFILE

 戻り値: apiData
	サーバーからのリターン・メッセージ。

 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "Admin", "\\\\machine\\ccmdb\\cm_database");
		


		my $globals = new ChangeSynergy::Globals();
		
		#「API Folder」という共有 CR レポート・フォルダーを削除します。

		my $deleteResults = $csapi->deleteFolder($aUser, 'API Folder', $globals->{PROBLEM_TYPE}, $globals->{REPORT}, $globals->{SHARED_PROFILE});
		print $deleteResults->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
DeleteNewCV

オブジェクトとすべての従属するオブジェクトおよび属性をデータベースから削除します。 従属するオブジェクトにはバインディング (アセンブリーの場合) およびディレクトリー・エントリーが含まれます。次のいずれかの条件が true の場合、エンティティーは削除されません。

         >オブジェクトが既存のプロジェクトのメンバーである。
         >オブジェクトがモデル・オブジェクトである。
         >オブジェクトがタイプ・オブジェクトであり、そのインスタンスが現在存在している。
         >オブジェクトがタイプ・オブジェクトであり、別の既存のタイプ・オブジェクトの super_type でもある。
             

返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  Subsys  : 要求される 4 部構成オブジェクト名の subsys 値。
	スカラー  cvtype  : 要求される 4 部構成オブジェクト名の cvtype 値。
	スカラー  name    : 要求される 4 部構成オブジェクト名の name 値。
	スカラー  version : 要求される 4 部構成オブジェクト名の version 値。
 
 戻り値: apiData
	サーバーからのリターン・メッセージ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->DeleteNewCV($aUser, "3", "admin", "special", "1");
		print $tmp->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
DeleteObjectAttributes

名前が「your name value」のオブジェクトの既存の属性を削除します。 この操作はオブジェクトの modify_time 属性も更新します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー        cvidList    : パイプ文字「|」で区切られた、影響を受ける cvid のリスト、または 1 つの cvid。
	apiObjectVector attrData    : API 関数によって処理されるデータ。
 
 戻り値: apiData
	サーバーからのリターン・メッセージ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $attrData = new ChangeSynergy::apiObjectVector();
		my $objData = new ChangeSynergy::apiObjectData();
		$objData->setName("attribute_a");
		$attrData->addDataObject($objData);
		my $objData = new ChangeSynergy::apiObjectData();
		$objData->setName("attribute_b");
		$attrData->addDataObject($objData);
		my $objData = new ChangeSynergy::apiObjectData();
		$objData->setName("attribute_c");
		$attrData->addDataObject($objData);
		my $tmp = $csapi->DeleteObjectAttributes($aUser, "10156|10157|10158|10159|10160", $attrData)
		print $tmp->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
DeleteRelation

2 つの IBM Rational Synergy オブジェクト間の関連を削除します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  bothWayRelationship: 双方向の関係を作成します [true|false]。
	スカラー  fromObject         : 作成する関係の元となるオブジェクト。
	スカラー  toObject           : 関係の適用先となるオブジェクト。
	スカラー relationName: 有効な IBM Rational Synergy/IBM Rational Change 関連名。
	スカラー  relationType       : 関係タイプ (以下を参照してください)。
 有効な関係タイプ (Globals.pm に定義された定数):
        CCM_PROBLEM_PROBLEM  // 変更依頼から変更依頼への関係を作成します。
        CCM_PROBLEM_TASK     // 変更依頼からタスクへの関係を作成します。
        CCM_PROBLEM_OBJECT   // 変更依頼からオブジェクトへの関係を作成します。
        CCM_TASK_PROBLEM     // タスクから変更依頼への関係を作成します。
        CCM_TASK_TASK        // タスクからタスクへの関係を作成します。
        CCM_TASK_OBJECT      // タスクからオブジェクトへの関係を作成します。
        CCM_OBJECT_PROBLEM   // オブジェクトから変更依頼への関係を作成します。
        CCM_OBJECT_TASK      // オブジェクトからタスクへの関係を作成します。
        CCM_OBJECT_OBJECT    // オブジェクトからオブジェクトへの関係を作成します。
        
        使用例:

          my $globals = new ChangeSynergy::Globals();

          my $relationType = $globals->{CCM_PROBLEM_PROBLEM};
 戻り値: apiData

	削除できた場合、結果のみが戻されます。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $globals = new ChangeSynergy::Globals();
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->DeleteRelation($aUser, "FALSE", "400", "1355", "my_copy",
                                            $globals->{CCM_PROBLEM_PROBLEM});
	};
	if ($@)
	{
		print $@;
	}
deleteReport

ユーザー環境または共有データから CR またはタスク・レポートを削除します。削除対象として指定されたレポートが見つからない場合は、例外をスローします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  reportName : 削除対象のレポートの名前。
	スカラー  objectType : レポートのオブジェクト・タイプ。
	スカラー  configType : レポートの構成場所。有効なタイプは user および shared のみです。
 有効なオブジェクト・タイプ (Globals.pm に定義された定数):
        PROBLEM_TYPE
        TASK_TYPE
        OBJECT_TYPE
 有効な構成タイプ (Globals.pm に定義された定数):
        SHARED_PROFILE
        USER_PROFILE

 戻り値: apiData
	削除状況メッセージ。
	
 例:


	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\machine\\ccmdb\\cm_database");
		my $globals = new ChangeSynergy::Globals();		#Delete a CR report named 'My column report' from the shared preferences and print the results.

		my $deleteResults = $csapi->deleteReport($aUser, "My column report", $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});
		print $deleteResults->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
DeleteTask

タスクを削除します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  taskNumber: 削除対象のタスク番号。
 戻り値: apiData

	削除状況メッセージ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->DeleteTask($aUser, "1");
	};
	if ($@)
	{
		print $@;
	}
DisableDatabase

IBM Rational Change サーバー上の IBM Rational Change データベースを無効にします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  database: 無効にするデータベース。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->DisableDatabase($aUser, "\\\\your_hostname\\ccmdb\\cm_database");
	};
	if ($@)
	{
		print $@;
	}
DisableHost

IBM Rational Change サーバー上の IBM Rational Change ホストを無効にします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser:      現在の API ユーザーのログイン・データ。
	スカラー  host : 無効にするホスト。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->DisableHost($aUser, "cm_host");
	};
	if ($@)
	{
		print $@;
	}
DisableIndexing

検索索引の作成を無効にします。

注意:

1. この関数は同期的です。つまり、索引付けが進行中である場合は、索引付けを安全に停止できるまで、関数がブロックされます。

2. 検索ディレクトリーのバックアップ時には、索引付けを無効にする必要があります。

3. デフォルトの検索ディレクトリーは <CHANGE_HOME>/WEB-INF/wsconfig/search です。

4. デフォルトの検索ディレクトリーをオーバーライドするには、構成エントリー SEARCH_INDEX_DIRECTORY にディレクトリー・パスを指定します。以下に例を示します。

	[CCM_SYSTEM][SEARCH_INDEX_DIRECTORY]<path_to_the_directory>[/SEARCH_INDEX_DIRECTORY][/CCM_SYSTEM]

5. EnableIndexing を呼び出すと、索引付けが再度有効化されます。

6. インデクサーの状態 (有効/無効) は、Change の再始動後も維持されます。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->DisableIndexing($aUser);
		print $tmpstr->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
DumpAUsersPreferences

文字列として返されるユーザー設定の内容をすべて取得します。 この文字列には、ユーザー設定オブジェクトの全内容の名前と値を保持します。 これはデバッグ用、および要求される変更が実施されたことを確認するために役立ちます。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  username: 取得するユーザー環境データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->DumpAUsersPreferences($aUser, "u00001");
		print $tmpstr->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
EnableDatabase

IBM Rational Change サーバー上の IBM Rational Change データベースを有効にします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  database: 有効にするデータベース。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->EnableDatabase($aUser, "\\\\your_hostname\\ccmdb\\cm_database");
	};
	if ($@)
	{
		print $@;
	}
EnableHost

IBM Rational Change サーバー上の IBM Rational Change ホストを有効にします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser:      現在の API ユーザーのログイン・データ。
	スカラー  host : 有効にするホスト。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->EnableHost($aUser, "cm_host");
	};
	if ($@)
	{
		print $@;
	}
EnableIndexing

検索索引の作成を定期的に再開できるようにします。 これは、API「DisableIndexing」の効果を切り替えます。

注記: 索引付けを直ちに開始する場合は、API「UpdateIndex」を参照してください。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->EnableIndexing($aUser);
	};
	if ($@)
	{
		print $@;
	}
exportAReport

指定された CR またはタスク・レポートを、共有環境またはユーザー環境のいずれかからエクスポートします。 返される結果は ReportEntry クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  reportName : サーバーからエクスポートするレポートの名前。
	スカラー  objectType : レポートのオブジェクト・タイプ。
	スカラー  configType : レポートの構成場所。
 有効なオブジェクト・タイプ (Globals.pm に定義された定数):
        PROBLEM_TYPE
        TASK_TYPE
        OBJECT_TYPE
 有効な構成タイプ (Globals.pm に定義された定数):
        SHARED_PROFILE
        SYSTEM_CONFIG
        USER_PROFILE

 戻り値: ReportEntry
	レポートに関するすべての情報を含むレポート・エントリー・オブジェクト。

 例 1:
 	
 	#Print all data about a report.

 	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\machine\\ccmdb\\cm_database");
		#Construct a new Globals object.


		my $globals = new ChangeSynergy::Globals();
		
		#Export a CR report named 'My Report' from the shared preferences 

		my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});
		
		#Print all information about the report, query and subreport.
		print "--------------- Report Entry ---------------------\n";
		print "\nreportEntry->getName          : " . $reportEntry->getName();
		print "\nreportEntry->getBaseName      : " . $reportEntry->getBaseName();
		print "\nreportEntry->getReportTemplate: " . $reportEntry->getReportTemplate();
		print "\nreportEntry->getExportFormat  : " . $reportEntry->getExportFormat();
		print "\nreportEntry->getMaxQuery      : " . $reportEntry->getMaxQuery();
		print "\nreportEntry->getMaxString     : " . $reportEntry->getMaxString();
		print "\nreportEntry->getDescription   : " . $reportEntry->getDescription();
		print "\nreportEntry->getIncrementSize : " . $reportEntry->getIncrementSize();
		print "\nreportEntry->getIncremental   : " . $reportEntry->getIncremental();
		print "\nreportEntry->getStyle         : " . $reportEntry->getStyle();
		print "\nreportEntry->getCustomDisOrder: " . $reportEntry->getCustomDisplayOrder();
		print "\nreportEntry->getImagePath     : " . $reportEntry->getImagePath();
		
		print "\n\n";
		print "--------------- Query Entry ---------------------\n";

		my $queryEntry = $reportEntry->getQueryEntry();
	
		print "Name        : " . $queryEntry->getName() . "\n";
		print "Query String: " . $queryEntry->getQueryString() . "\n";
		print "Desc        : " . $queryEntry->getDescription() . "\n";
		print "Prompting   : " . $queryEntry->getPromptingQueryXml() . "\n";
		print "Template    : " . $queryEntry->getTemplate() . "\n";
		
		print "--------------- Sub Report Entries ---------------------\n";
		

		my @subreports = $reportEntry->getSubReports();
		

		for my $subReportEntry (@subreports)
		{
			print "--------------- Sub Report Entry ---------------------\n";
			print "getName                  :" . $subReportEntry->getName() . "\n";
			print "getMainTemplate          :" . $subReportEntry->getMainTemplate() . "\n";
			print "getHeaderTemplate        :" . $subReportEntry->getHeaderTemplate() . "\n";
			print "getAttributeTemplate     :" . $subReportEntry->getAttributeTemplate() . "\n";
			print "getImageTemplate         :" . $subReportEntry->getImageTemplate() . "\n";
			print "getGroupTemplate         :" . $subReportEntry->getGroupTemplate() . "\n";
			print "getAutoAttributeTemplate :" . $subReportEntry->getAutoAttributeTemplate() . "\n";
			print "getFooterTemplate        :" . $subReportEntry->getFooterTemplate() . "\n";
			print "getGroupBy               :" . $subReportEntry->getGroupBy() . "\n";
			print "getCustomWslet           :" . $subReportEntry->getCustomWslet() . "\n";
			print "getXmlContent            :" . $subReportEntry->getXmlContent() . "\n";
			print "getSpanAttributeTemplate :" . $subReportEntry->getSpanAttributeTemplate() . "\n";
			print "getLabelTemplate         :" . $subReportEntry->getLabelTemplate() . "\n";
			print "getAutoLabelTemplate     :" . $subReportEntry->getAutoLabelTemplate() . "\n";
			print "getAttributes            :" . $subReportEntry->getAttributes() . "\n";
			print "getSortOrder             :" . $subReportEntry->getSortOrder() . "\n";
			print "getRelation              :" . $subReportEntry->getRelation() . "\n";
			print "getDefinitionType        :" . $subReportEntry->getDefinitionType() . "\n\n";
		}
	};
	if ($@)
	{
		print $@;
	}
	
例 2:
 	#Save report XML to file.

 	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\machine\\ccmdb\\cm_database");
		#Construct a new Globals object.


		my $globals = new ChangeSynergy::Globals();
		
		#Export a CR report named 'My Report' from the shared preferences 

		my $reportEntry = $csapi->exportAReport($aUser, "My Report",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});
		

		my $file = $reportEntry->getName() . ".xml";
		
		open(OUTPUT, ">$file");
		print(OUTPUT $reportEntry->toXml());
		close(OUTPUT);
	};
	if ($@)
	{
		print $@;
	}
 例 3:
 
 	#Load saved XML results back into a L<ReporEntry> object.
 	

 	my $file = "report.xml";

 	open (INPUTFILE, "$file") or die "Could not open the file!";

	my $filecontents = "";

	my $buffer = "";
	
	while ($buffer = readline *INPUTFILE)
	{
		$filecontents .= $buffer;
	}
	
	close(INPUTFILE);
	

	my $reportEntryFactory = new ChangeSynergy::ReportEntryFactory();

	my $reportEntry = $reportEntryFactory->createReportEntryFromXml($filecontents);
exportReportsFromFolder

すべての CR またはタスク・レポートを、共有環境内またはユーザー環境内の指定されたフォルダーからエクスポートします。 返される結果は ReportEntry クラスの配列です。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  folderName : すべてのレポートをエクスポートするフォルダーの名前。
	スカラー  objectType : レポートのオブジェクト・タイプ。
	スカラー  configType : レポートの構成場所。
 有効なオブジェクト・タイプ (Globals.pm に定義された定数):
        PROBLEM_TYPE
        TASK_TYPE
        OBJECT_TYPE
 有効な構成タイプ (Globals.pm に定義された定数):
        SHARED_PROFILE
        SYSTEM_CONFIG
        USER_PROFILE
 戻り値: ReportEntry
	各レポートに関するすべての情報を含むレポート・エントリー・オブジェクトの配列。
 
 例:
 	
 	#Print all data about a report.

 	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\machine\\ccmdb\\cm_database");
		#Construct a new Globals object.


		my $globals = new ChangeSynergy::Globals();
		
		#Export all CR reports from the folder 'My Folder' from the shared preferences 

		my @reportEntries = $csapi->exportReportsFromFolder($aUser, "My Folder",  $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});
		

		foreach my $reportEntry (@reportEntries)
		{
			#See the exportAReport above or the L<ReportEntry> class for how to interact with a ReportEntry object.
		}
	};
	
	if ($@)
	{
		print $@;
	}
GetAttributes

サーバーで定義されているすべての IBM Rational Change 属性を取得します。 IBM Rational Change 属性は以下のとおりです。

	[CCM_ATTRIBUTE]
		[NAME]
			IBM Rational Change 属性名。
		[/NAME]
		[TYPE]
ウェブ可視化データ・タイプ。
使用できるタイプは CCM_STRING、CCM_TEXT、CCM_LISTBOX、
および CCM_VALUELISTBOX。
		[/TYPE]
		[INTERFACE NAME]
			オプションのインターフェース・ベースのエイリアス。
			定義されているインターフェースと同数のインターフェース・オプションが存在します。
			実際のタグ名はリテラルのインターフェース名です。
		[/INTERFACE NAME]...
		[ALIAS]
			この属性のデフォルトのエイリアス値。インターフェース・オプションを使用しない場合、またはユーザーのインターフェースが指定されていない場合、この値が返されます。
[ALIAS] タグ・セットはデフォルトを定義します。[ALIAS] タグが存在しない場合、[NAME] が返されます。
		[/ALIAS]
	[/CCM_ATTRIBUTE]

[NAME] は getName() メソッドによって識別されます。 [TYPE] は getType() メソッドによって識別されます。 [ALIAS] は getLabel() メソッドによって識別されます。 [INTERFACE NAME] オプションは、API からは利用できません。

返される結果は apiObjectVector クラスのインスタンスです。

 パラメーター:
	apiUser aUser:      現在の API ユーザーのログイン・データ。
 
戻り値: apiObjectVector
サーバーで定義されているすべての IBM Rational Change 属性。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $attrs = $csapi->GetAttributes($aUser);
		my $i;

		my $j = $attrs->getDataSize();
		for($i=0; $i < $j; $i++)
		{
			print $attrs->getDataObject($i)->getName() . "\n";  #[CCM_ATTRIBUTE][NAME]
			print $attrs->getDataObject($i)->getType() . "\n";  #[CCM_ATTRIBUTE][TYPE]
			print $attrs->getDataObject($i)->getLabel() . "\n"; #[CCM_ATTRIBUTE][ALIAS]
		}
	};
	if ($@)
	{
		print $@;
	}
GetCRData

変更依頼の詳細を、変更依頼の詳細の修正が可能なデータ・クラスにロードします。 修正されたデータ・クラスは、変更依頼を変更するために、修正 API 関数の 1 つを使って提出できます。 返される結果は apiObjectVector クラスのインスタンスです。

注記: 現在の遷移の選択肢は、この API 関数呼び出しによって提供されます。 apiTransitions クラスの説明を参照してください。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー problemNumber : 参照する変更依頼 ID/問題番号 ID。
	スカラー  attributeList: 区切られた属性のリスト。
	                       [attribute_name|attribute_name|attribute_name|...]
 戻り値: apiObjectVector
データ形式の変更依頼の詳細。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->GetCRData($aUser, "100", "problem_synopsis|problem_description");
		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
GetCRDataAllTransitions

変更依頼の詳細を、変更依頼の詳細の修正が可能なデータ・クラスにロードします。 修正されたデータ・クラスは、変更依頼を変更するために、修正 API 関数の 1 つを使って提出できます。 返される結果は apiObjectVector クラスのインスタンスです。 AllTransitions 関数には表示されない遷移が含まれています。

注記: 現在の遷移の選択肢は、この API 関数呼び出しによって提供されます。 apiTransitions クラスの説明を参照してください。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー problemNumber : 参照する変更依頼 ID/問題番号 ID。
	スカラー  attributeList: 区切られた属性のリスト。
	                       [attribute_name|attribute_name|attribute_name|...]
 戻り値: apiObjectVector
データ形式の変更依頼の詳細。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->GetCRDataAllTransitions($aUser, "100", "problem_synopsis|problem_description");
		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
GetCV

オブジェクトの 4 部構成名を取得します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser:      現在の API ユーザーのログイン・データ。
	スカラー  cvid : 取得対象オブジェクトの cvid。
 戻り値: apiData


	4 部構成名: [subsys/cvtype/name/version]、例: "1/admin/cs/1"
	
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->GetCV($aUser,"10159");
		print $tmp->getResponseData(); #ex: "3/admin/special/1"
		#Note: Result will be a four part name like: "[subsys/cvtype/name/version]", in string format.
	};
	if ($@)
	{
		print $@;
	}
GetDatabases

IBM Rational Change データベースのリストを Rational Change サーバーから取得します。 返される結果は apiListObject クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiListObject
IBM Rational Change サーバー上の全データベースのリスト。
 	
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->GetDatabases($aUser);
		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
GetCentralCrDatabase

セントラル・サーバー・モードの場合に、セントラル・データベースのパスを取得します。 セントラル・サーバー・モードではない場合は、空の文字列が返されます。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	apiData オブジェクトにラップされたセントラル CR データベースのパス。
	
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->GetCentralCrDatabase($aUser);
		my $tmpstr = $tmp->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
GetDatabaseSettings

無効になっているデータベースも含めて、すべてのデータベースの現在の設定を取得します。

 パラメーター:
	apiUser user: 現在の API ユーザーのログイン・データ。
 戻り値: 各ハッシュ値が 1 つのデータベースを現しているハッシュ参照のリスト。
	各ハッシュは次のキーを持ちます。path、enabled、description、max_sessions、min_sessions、
	および users_per_session。値はすべてストリングです。ただし「enabled」は truthy/falsey 値です。
 
 例:
 

	my @databases = $csapi->GetDatabaseSettings($user);
	foreach my $db (@databases)
	{
		print "Path:          $db->{path} \n";
		print "Enabled:       " . ($db->{enabled} ? "yes\n" : "no\n");
		print "Label:         $db->{label} \n";
		print "Description:   $db->{description} \n";
		print "Max Sessions:  $db->{max_sessions} \n";
		print "Min Sessions:  $db->{min_sessions} \n";
		print "Users/Session: $db->{users_per_session} \n\n";
	}
GetDataListBox

DataListbox の内容を取得します。 返される結果は apiListObject クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  listObject: 取得対象の DataListbox。
 戻り値: apiListObject
DataListbox の内容。
  
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $list = $csapi->GetDataListBox($aUser, "CRQUERYREPORTPREDEFINED");
		for(my $i=0; $i < $list->getListboxSize(); $i++)
		{

			my $label = $list->getLabel($i);

			my $value = $list->getValue($i);
			print "List label $i: " . $label . "\n";
			print "List value $i: " . $value . "\n";
		}
	};
	if ($@)
	{
		print $@;
	}
GetDataListBox

DataListbox の内容を取得します。 返される結果は apiListObject クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  listObject: 取得対象の DataListbox。
スカラー configType: リストから検索する config エントリー。

有効な Config タイプ: Globals クラスで定義されます。
        $self->{ALL}       // User、Shared および System。 検出した最初の 1 つを返します。
        $self->{USER_PROFILE}	// 1 人のユーザー・プロファイル・データ。
        $self->{SHARED_PROFILE} // 共有プロファイル・データ。
	    $self->{SYSTEM_CONFIG}  // システム config データ。
 戻り値: apiListObject
DataListbox の内容。
  
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $globals = new ChangeSynergy::Globals();
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $list = $csapi->GetDataListBox($aUser, "CRQUERYREPORTUSERDEFINED", $globals->{USER_PROFILE});
		for(my $i=0; $i < $list->getListboxSize(); $i++)
		{

			my $label = $list->getLabel($i);

			my $value = $list->getValue($i);
			print "List label $i: " . $label . "\n";
			print "List value $i: " . $value . "\n";
		}
	};
	if ($@)
	{
		print $@;
	}
GetDOORSAttribute

DOORS 属性タグ値を DOORS 添付オブジェクトから取得します。

 パラメーター:
	apiUser aUser          : 現在の API ユーザーのログイン・データへのポインター。
	スカラー  cvid           : 取り出すソース・オブジェクトの cvid。
	スカラー  attributeValue : 要求される DOORS 属性の DOORS_ATTR:NAME 値。
スカラー attributeTag   : [NAME|TYPE|RANGE|VALUE|DEFAULT_AR|USER|GROUP] から情報を取得するためのタグ名。
	スカラー  objectType     : XML ルート・タグ [DYNAMIC_ATTRS_ORIG|DYNAMIC_ATTRS_NEW]。
	スカラー  charSet        : 使用する文字セット。例: "UTF-16LE"、"iso-8859-1"
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->GetDOORSAttribute($aUser, "10126", "the name", "VALUE", "DYNAMIC_ATTRS_ORIG", "UTF-16LE");
	};
	if ($@)
	{
		print $@;
	}
GetDOORSAttribute52

DOORS 属性タグ値を DOORS 添付オブジェクトから取得します。

 パラメーター:
	apiUser aUser          : 現在の API ユーザーのログイン・データへのポインター。
	スカラー  cvid           : 取り出すソース・オブジェクトの cvid。
	スカラー  attributeValue : 要求される DOORS 属性の DOORS_ATTR:NAME 値。
スカラー attributeTag   : [NAME|TYPE|RANGE|VALUE|DEFAULT_AR|USER|GROUP] から情報を取得するためのタグ名。
	スカラー  objectType     : XML ルート・タグ [DYNAMIC_ATTRS_ORIG|DYNAMIC_ATTRS_NEW]。
	スカラー  objectId       : 属性を検索するために必要な要求の ID。
	スカラー  charSet        : 使用する文字セット。例: "UTF-16LE"、"iso-8859-1"
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->GetDOORSAttribute($aUser, "10126", "the name", "VALUE", "DYNAMIC_ATTRS_ORIG", "98_req0000002d_1", "UTF-16LE");
	};
	if ($@)
	{
		print $@;
	}
getFolderSecurityRule

指定されたフォルダーのフォルダー・セキュリティー情報を取得します。フォルダー・セキュリティー情報は、フォルダー名、読み取りセキュリティー・メンバー、および書き込みセキュリティー・メンバーで構成されます。 返される結果は FolderSecurityRule クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  folderName : セキュリティーを取得対象のフォルダーの名前。
	スカラー  objectType : フォルダーのオブジェクト・タイプ。
	スカラー  formatType : フォルダーのフォーマット・タイプ: レポート、クエリーまたはレポート・フォーマット。
	スカラー  configType : レポートの構成場所。
 戻り値: FolderSecurityRule
	ルールを表す FolderSecurityRule オブジェクト。
 
 例:
 

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\angler\\ccmdb\\cm_database");


		my $globals = new ChangeSynergy::Globals();
		
		#Get the folder security rule for the "all" CR Shared query folder.

		my $folderRule = $csapi->getFolderSecurityRule($aUser, "", $globals->{PROBLEM_TYPE}, $globals->{QUERY},
						 $globals->{SHARED_PROFILE});
		
		print "Folder Name: " . $folderRule->getFolderName() . "\n";
		

		my @readMembers = $folderRule->getReadMembers();
	
		print "Current readers \n";
		

		foreach my $member (@readMembers)
		{
			print "Reader: '$member'\n";
		}
		
		print "Finished printing readers: \n";
		

		my @writeMembers = $folderRule->getWriteMembers();
	
		print "Current writers: \n";
		

		foreach my $member (@writeMembers)
		{
			print "Writer: '$member'\n";
		}
		
		print "Finished printing writers: \n";
	};
	if ($@)
	{
		print $@;
	}
GetHosts

IBM Rational Change ホストのリストを取得します。 返される結果は apiListObject クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiListObject
	IBM Rational Change サーバー上の全ホストのリスト。
 
 例:
 

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->GetHosts($aUser);
		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
GetHostSettings

無効なホストも含め、すべてのホストの現在の設定値を取得します。

 パラメーター:
	apiUser user: 現在の API ユーザーのログイン・データ。
 戻り値: 各ハッシュ値が 1 つのホストを現しているハッシュ参照のリスト。
	各ハッシュは次のキーを持ちます。hostname、type、enabled、description、max_sessions、priority、
	および threshold。値はすべてストリングです。ただし「enabled」は truthy/falsey 値です。
              
ホスト・タイプは "NT" または "UNIX" です。
  例:
 

	my @hosts = $csapi->GetHostSettings($user);
	

	foreach my $host (@hosts)
	{
		print "Hostname:     $host->{hostname} \n";
		print "Type:         $host->{type} \n";
		print "Enabled:      " . ($host->{enabled} ? "yes\n" : "no\n");
		print "Description:  $host->{description} \n";
		print "Max Sessions: $host->{max_sessions} \n";
		print "Priority:     $host->{priority} \n";
		print "Threshold:    $host->{threshold} \n\n";
	}
GetList

リストの内容を取得します。 返される結果は apiListObject クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  listObject: 取得対象のリスト。
 戻り値: apiListObject
リストの内容。
  
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $list = $csapi->GetList($aUser, "CRQueryReportPreDefined");
		for(my $i=0; $i < $list->getListboxSize(); $i++)
		{

			my $label = $list->getLabel($i);

			my $value = $list->getValue($i);
			print "List label $i: " . $label . "\n";
			print "List value $i: " . $value . "\n";
		}
	};
	if ($@)
	{
		print $@;
	}
GetList

リストの内容を取得します。 返される結果は apiListObject クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  listObject: 取得対象のリスト。
スカラー configType: リストから検索する config エントリー。

有効な Config タイプ: Globals クラスで定義されます。
        $self->{ALL}       // User、Shared および System。 検出した最初の 1 つを返します。
        $self->{USER_PROFILE}	// 1 人のユーザー・プロファイル・データ。
        $self->{SHARED_PROFILE} // 共有プロファイル・データ。
	    $self->{SYSTEM_CONFIG}  // システム config データ。
 戻り値: apiListObject
リストの内容。
  
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $globals = new ChangeSynergy::Globals();
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $list  = $csapi->GetList($aUser, "CRQUERYUSERDEFINED", $globals->{USER_PROFILE});
		for(my $i=0; $i < $list->getListboxSize(); $i++)
		{

			my $label = $list->getLabel($i);

			my $value = $list->getValue($i);
			print "List label $i: " . $label . "\n";
			print "List value $i: " . $value . "\n";
		}
	};
	if ($@)
	{
		print $@;
	}
GetListBox

リスト・ボックスの内容を取得します。 返される結果は apiListObject クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  listObject: 取得対象のリスト・ボックス。
 戻り値: apiListObject
リスト・ボックスの内容。
  
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $list  = $csapi->GetListBox($aUser, "severity");
		for(my $i=0; $i < $list->getListboxSize(); $i++)
		{

			my $label = $list->getLabel($i);

			my $value = $list->getValue($i);
			print "Listbox label $i: " . $label . "\n";
			print "Listbox value $i: " . $value . "\n";
		}
	};
	if ($@)
	{
		print $@;
	}
GetListBox

リスト・ボックスの内容を取得します。 返される結果は apiListObject クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  listObject: 取得対象のリスト・ボックス。
	スカラー configType: リスト・ボックスから検索する config エントリー。
	

有効な Config タイプ: Globals クラスで定義されます。
        $self->{ALL}       // User、Shared および System。 検出した最初の 1 つを返します。
        $self->{USER_PROFILE}	// 1 人のユーザー・プロファイル・データ。
        $self->{SHARED_PROFILE} // 共有プロファイル・データ。
	    $self->{SYSTEM_CONFIG}  // システム config データ。
 戻り値: apiListObject
リスト・ボックスの内容。
  
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $globals = new ChangeSynergy::Globals();
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->GetListBox($aUser, "severity", $globals->{USER_PROFILE});
		for(my $i=0; $i < $list->getListboxSize(); $i++)
		{

			my $label = $list->getLabel($i);

			my $value = $list->getValue($i);
			print "Listbox label $i: " . $label . "\n";
			print "Listbox value $i: " . $value . "\n";
		}
	};
	if ($@)
	{
		print $@;
	}
GetListBoxDefaultValue

リスト・ボックスのデフォルト値を取得します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser   : 現在の API ユーザーのログイン・データ。              
 戻り値: apiData

 	構成ファイルに設定されたリスト・ボックスのデフォルト値。
 例:
	my $csapi = new ChangeSynergy::csapi();
     eval
     {
            $csapi->setUpConnection("http://your_hostname:port/your_context");
            my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database"); 
            my $tmpStr = $csapi->GetListBoxDefaultValue($aUser);
            print $tmpStr->getResponseData();
      };
      if ($@)
{
	print $@;
}

GetNewCV

4 部構成名が所与の場合、オブジェクトの cvid を返します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  subsys  : 要求される 4 部構成オブジェクト名の subsys 値。
	スカラー  cvtype  : 要求される 4 部構成オブジェクト名の cvtype 値。
	スカラー  name    : 要求される 4 部構成オブジェクト名の name 値。
	スカラー  version : 要求される 4 部構成オブジェクト名の version 値。
 戻り値: apiData

	Cvid ストリング値: 「CV: 5_digit_integer_value_of_object」(例: 「CV: 12345」)
	
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->GetNewCV($aUser, "3", "admin", "special", "1");
		print $tmp->getResponseData(); #ex: "CV: 12345"
		#Note: Result will be like: "CV: 5_digit_integer_value_of_object", in string format.
	};
	if ($@)
	{
		print $@;
	}
GetObjectData

オブジェクトの詳細を、オブジェクトの詳細の修正または表示が可能なデータ・クラスにロードします。修正されたデータ・クラスは、修正 API 関数の 1 つを使って提出できます。 返される結果は apiObjectVector クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  cvid      : オブジェクトの cvid。
	スカラー  AttrList  : 区切られた属性のリスト。[attribute_name|attribute_name|attribute_name|...]

戻り値: apiObjectVector 要求された属性の内容。

 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $objVector = $csapi->GetObjectData($aUser, $cv1, "create_time|cvtype|is_asm|is_model|is_versioned|modify_time|name|owner|status|subsystem|version");
		my $i;

		my $j = $objVector->getDataSize();
		for($i=0; $i < $j; $i++)
		{
			print "Name : " . $objVector->getDataObject($i)->getName() . "\n";
			print "Value: " . $objVector->getDataObject($i)->getValue() . "\n";
		}
	};
	if ($@)
	{
		print $@;
	}
GetQuery

クエリーの内容を取得します。 返される結果は apiListObject クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  listObject: 取得対象のクエリー。
 戻り値: apiListObject
クエリーの内容。
  
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $query = $csapi->GetQuery($aUser, "All CRs");
		print "getName       : " . $query->getName() . "\n";
		print "getQueryString: " . $query->getQueryString() . "\n";
		print "getDateLastRun: " . $query->getDateLastRun() . "\n";
	};
	if ($@)
	{
		print $@;
	}
GetQuery

クエリーの内容を取得します。 返される結果は apiListObject クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  listObject: 取得対象のクエリー。
スカラー configType: クエリーから検索する config エントリー。

	有効な Config タイプ: Globals クラスで定義されます。
		$self->{ALL}       		// User、Shared および System。検出した最初の 1 つを返します。
		$self->{USER_PROFILE}	// 1 人のユーザー・プロファイル・データ。
		$self->{SHARED_PROFILE} // 共有プロファイル・データ。
		$self->{SYSTEM_CONFIG}  // システム config データ。
 戻り値: apiListObject
クエリーの内容。
  
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $globals = new ChangeSynergy::Globals();
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $query = $csapi->GetQuery($aUser, "Test Query", $globals->{USER_PROFILE});
		print "getName       : " . $query->getName() . "\n";
		print "getQueryString: " . $query->getQueryString() . "\n";
		print "getDateLastRun: " . $query->getDateLastRun() . "\n";
	};
	if ($@)
	{
		print $@;
	}
GetReport

レポートの内容を取得します。 返される結果は apiListObject クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  listObject: 取得対象のレポート。
 戻り値: apiListObject
レポートの内容。
  
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $report = $csapi->GetReport($aUser, "Basic Summary");
		print "getName        : " . $report->getName()        . "\n";
		print "getExportForm  : " . $report->getExportForm () . "\n";
		print "getQueryName   : " . $report->getQueryName()   . "\n";
		print "getQueryString : " . $report->getQueryString() . "\n";
		print "getDateLastRun : " . $report->getDateLastRun() . "\n";
	

		for(my $i = 0; $i < $report->getSubreportSize(); $i++)
		{
			print "   Subreport $i \n";
			print "		getSubreportName    : "  . $report->getSubreportName($i)     . "\n";
			print "		getSubreportRelation: "  . $report->getSubreportRelation($i) . "\n";
			print "		getSubreportType    : "  . $report->getSubreportType($i)     . "\n";
		}
	};
	if ($@)
	{
		print $@;
	}
GetReport

レポートの内容を取得します。 返される結果は apiListObject クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  listObject: 取得対象のレポート。
スカラー configType: レポートから検索する config エントリー。

有効な Config タイプ: Globals クラスで定義されます。
        $self->{ALL}       // User、Shared および System。 検出した最初の 1 つを返します。
        $self->{USER_PROFILE}	// 1 人のユーザー・プロファイル・データ。
        $self->{SHARED_PROFILE} // 共有プロファイル・データ。
	    $self->{SYSTEM_CONFIG}  // システム config データ。
 戻り値: apiListObject
レポートの内容。
  
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $globals = new ChangeSynergy::Globals();
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $report = $csapi->GetReport($aUser, "Test Format", $globals->{USER_PROFILE});
		print "getName        : " . $report->getName()        . "\n";
		print "getExportForm  : " . $report->getExportForm () . "\n";
		print "getQueryName   : " . $report->getQueryName()   . "\n";
		print "getQueryString : " . $report->getQueryString() . "\n";
		print "getDateLastRun : " . $report->getDateLastRun() . "\n";
	

		for(my $i = 0; $i < $report->getSubreportSize(); $i++)
		{
			print "   Subreport $i \n";
			print "		getSubreportName    : "  . $report->getSubreportName($i)     . "\n";
			print "		getSubreportRelation: "  . $report->getSubreportRelation($i) . "\n";
			print "		getSubreportType    : "  . $report->getSubreportType($i)     . "\n";
		}
	};
	if ($@)
	{
		print $@;
	}
GetTaskData

タスクの詳細を、タスクの詳細の修正が可能なデータ・クラスにロードします。 修正されたデータ・クラスは、タスクを変更する修正 API 関数の 1 つを使って提出できます。 返される結果は apiObjectVector クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
スカラー taskNumber   : 参照するタスク ID。
	スカラー  attributeList: 区切られた属性のリスト。
	                       [attribute_name|attribute_name|attribute_name|...]
 戻り値: apiObjectVector
	データ形式のタスクの詳細。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->GetTaskData($aUser, "10", "task_synopsis|task_description|priority");
		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
GetUserPreference

指定したユーザーのユーザー設定またはプロファイル値を取得します。 返される結果は apiData クラスのインスタンスです。

 定義されているユーザー設定属性:
user_name                : ユーザーのフルネーム。
	user_first_name          : ユーザーのファーストネーム。
	user_last_name           : ユーザーのラストネーム。
	user_address             : リストに記載されるユーザーの住所。
	user_company             : ユーザーの勤務先。
	user_email               : ユーザーの E メール・アドレス。
	user_fax                 : ユーザーの FAX 番号。
	user_phone               : ユーザーの電話番号。
	user_fontsize            : ユーザーが定義したフォント・サイズ。
	user_read_security_value : ユーザーの読み取りセキュリティー値。
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  userName  : 情報を取得する対象のユーザーの名前。
	スカラー  prefName  : 取り出す対象の設定の名前。
 戻り値: apiData

	要求されたユーザー設定の値。
 
 例:
	my $csapi  = new ChangeSynergy::csapi();
	
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->GetUserPreference($aUser, "u00001", "user_email");
	

		my $tmpstr = $tmp->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
GetValueListBox

ValueListbox の内容を取得します。 返される結果は apiListObject クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  listObject: 取得対象の ValueListbox。
 戻り値: apiListObject
ValueListbox の内容。
  
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $list = $csapi->GetValueListBox($aUser, "date_keywords");
		for(my $i=0; $i < $list->getListboxSize(); $i++)
		{

			my $label = $list->getLabel($i);

			my $value = $list->getValue($i);
			print "GetValueListBox label $i: " . $label . "\n";
			print "GetValueListBox value $i: " . $value . "\n";		
		}
	};
	if ($@)
	{
		print $@;
	}
GetValueListBox

ValueListbox の内容を取得します。 返される結果は apiListObject クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  listObject: 取得対象の ValueListbox。
スカラー configType: ValueListbox から検索する config エントリー。

有効な Config タイプ: Globals クラスで定義されます。
        $self->{ALL}       // User、Shared および System。 検出した最初の 1 つを返します。
        $self->{USER_PROFILE}	// 1 人のユーザー・プロファイル・データ。
        $self->{SHARED_PROFILE} // 共有プロファイル・データ。
	    $self->{SYSTEM_CONFIG}  // システム config データ。
 戻り値: apiListObject
ValueListbox の内容。
  
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $globals = new ChangeSynergy::Globals();
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $list = $csapi->GetValueListBox($aUser, "user_defined_valuelistbox", $globals->{USER_PROFILE});
		for(my $i=0; $i < $list->getListboxSize(); $i++)
		{

			my $label = $list->getLabel($i);

			my $value = $list->getValue($i);
			print "GetValueListBox label $i: " . $label . "\n";
			print "GetValueListBox value $i: " . $value . "\n";		
		}
	};
	if ($@)
	{
		print $@;
	}
ImmediateQueryHtml

IBM Rational Change レポートを実行し、その完了を待ちます。 この API はポーリング・テンプレートには対応しません。 この API は小さいレポートの実行に使用します。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な HTML ページです。<HTML>...</HTML>
       戻り値は .html ファイルとして保存、またはブラウザーの window/control にロードすることができます。
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  reportName : IBM Rational Change レポート名。
						 (CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー  queryString: 有効な IBM Rational Synergy クエリー・ストリング。
	スカラー  queryName  : IBM Rational Change クエリー名。
						 ([CCM_QUERY][NAME]query name[/NAME]...[/CCM_QUERY])
	スカラー reportTitle: レポートのこのインスタンスのタイトル。
 戻り値: apiData

	要求された即時クエリーの HTML ページ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
	

		my $tmpstr = $csapi->ImmediateQueryHtml($aUser, "Basic Summary",
												"(submitter='cschuffe') and (cvtype='problem')",
												 undef, undef);
	};
	if ($@)
	{
		print $@;
	}
ImmediateReportHtml

IBM Rational Change レポートを実行し、その完了を待ちます。 この API はポーリング・テンプレートには対応しません。 この API は小さいレポートの実行に使用します。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な HTML ページです。<HTML>...</HTML>
       戻り値は .html ファイルとして保存、またはブラウザーの window/control にロードすることができます。
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  reportName : IBM Rational Change レポート名。
						 ([CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー reportTitle: レポートのこのインスタンスのタイトル。
 戻り値: apiData

	要求された即時クエリーの HTML ページ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
	

		my $tmpstr = $csapi->ImmediateReportHtml($aUser, "Basic Summary", "Basic Summary Report");
	};
	if ($@)
	{
		print $@;
	}
importAReport

exportAReport または exportReportsFromFolder のいずれかの API を使用してエクスポートされた Change レポートをインポートします。インポートするレポートの名前が既にサーバー上に存在する場合、このメソッドはエラーとなり、例外をスローします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	ReportEntry reportEntry: レポートに関するすべての情報を含むレポート・エントリー。
	スカラー  objectType : レポートのオブジェクト・タイプ。
	スカラー  configType     : レポートの構成場所。有効なタイプは user および shared のみです。
 有効なオブジェクト・タイプ (Globals.pm に定義された定数):
        PROBLEM_TYPE
        TASK_TYPE
        OBJECT_TYPE
 有効な構成タイプ (Globals.pm に定義された定数):
        SHARED_PROFILE
        USER_PROFILE
 戻り値: apiData

	インポートが正常に行われたかどうかに関する情報。
 
 例 1:
	#Create a copy of an existing report and change the query.

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\machine\\ccmdb\\cm_database");


		my $globals = new ChangeSynergy::Globals();
		
		#Export the 'Column' report from the system config data.

		my $reportEntry = $csapi->exportAReport($aUser, "Column",  $globals->{PROBLEM_TYPE}, $globals->{SYSTEM_CONFIG});
		
		#Change the name
		$reportEntry->setName("My column report");
		
		#Set a new query string in the query entry.
		$reportEntry->getQueryEntry->setQueryString("(cvtype='problem') and (crstatus='assigned')");
		
		#Get the subReports from the report entry.

		my @subReports = $reportEntry->getSubReports();
		
		#The column output only has a single subreport definition, CCM_PROBLEM.

		my $subReport = $subReports[0];
		
		#Get the original attributes and append submitter and severity as new attributes, must be in config file format.
		$subReport->setAttributes($subReport->getAttributes() . "|submitter:3:false|severity:4:false");
	
		#Import the report back to the server.

		my $result = $csapi->importAReport($aUser, $reportEntry, $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});
	};
	if ($@)
	{
		print $@;
	}
	
例 2:
	#Import a report from a file.

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\machine\\ccmdb\\cm_database");
		#Open a file named 'report.xml' and read in all the contents.

		my $file = "report.xml";

	 	open (INPUTFILE, "$file") or die "Could not open the file!";

		my $filecontents = "";

		my $buffer = "";
		
		while ($buffer = readline *INPUTFILE)
		{
			$filecontents .= $buffer;
		}
		
		close(INPUTFILE);
		
		#Create a new instance of the ReportEntryFactory so we can create our new data from the XML data read from file.

		my $reportEntryFactory = new ChangeSynergy::ReportEntryFactory();

		my $reportEntry = $reportEntryFactory->createReportEntryFromXml($filecontents);
		
		#Import the report back to the server.

		my $result = $csapi->importAReport($aUser, $reportEntry, $globals->{PROBLEM_TYPE}, $globals->{SHARED_PROFILE});
	};
	if ($@)
	{
		print $@;
	}
InstallAPackage

IBM Rational Change パッケージをインストールします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  packageName : インストールするパッケージの名前。
 戻り値: apiData

	パッケージがインストールできたかどうかの結果のみです。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");	

		my $results = $csapi->InstallAPackage($aUser, "dev_process");
		
		print $results->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
LoadAllConfigurationFiles

すべての構成データ・ファイルを Rational Change サーバーにロードします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->LoadAllConfigurationFiles($aUser);
	};
	if ($@)
	{
		print $@;
	}
LoadConfigurationData

構成データを Rational Change サーバーにロードします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->LoadConfigurationData($aUser);
	};
	if ($@)
	{
		print $@;
	}
LoadConfigurationFile

指定した構成データ・ファイルを Rational Change サーバーにロードします。 pt.cfg、admin_framework.cfg、user_framework.cfg、および task_framework.cfg の構成ファイルはロードできません。 指定したファイルは「<CHANGE_APP_HOME>/WEB-INF/wsconfig」ディレクトリーにある必要があります。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  cfgFile : 再ロードする構成ファイルの名前。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->LoadConfigurationFile($aUser, "my_config_file.cfg");
	};
	if ($@)
	{
		print $@;
	}
LoadDatabaseListboxes

データベースから値を取得する全リスト・ボックスを再ロードします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->LoadDatabaseListboxes($aUser);
	};
	if ($@)
	{
		print $@;
	}
listFolders

最上位フォルダー以下にあるすべてのクエリー、レポート・フォーマット、またはレポート・フォルダーのリストを返します。 返される結果は apiListObject クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  objectType   : ルート・フォルダーのオブジェクト・タイプ。
	スカラー  formatType   : ルート・フォルダーのフォーマット・タイプ: レポート、クエリーまたはレポート・フォーマット。
	スカラー  configType   : ルート・フォルダーの構成場所。
 有効なオブジェクト・タイプ (Globals.pm に定義された定数):
        PROBLEM_TYPE
        TASK_TYPE
        OBJECT_TYPE
 有効なフォーマット・タイプ (Globals.pm に定義された定数):
 		QUERY
        REPORT
        REPORT_FORMAT
 

 有効な構成タイプ (Globals.pm に定義された定数):
        SHARED_PROFILE
        SYSTEM_CONFIG
        USER_PROFILE

 戻り値: apiListObject
	ルート・フォルダー以下にあるフォルダーのリスト。

 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "Admin", "\\\\machine\\ccmdb\\cm_database");
		


		my $globals = new ChangeSynergy::Globals();
		
		#Get a list of all the shared CR report folders.

		my $folders = $csapi->listFolders($aUser, $globals->{PROBLEM_TYPE}, $globals->{REPORT}, $globals->{SHARED_PROFILE});
		for (my $i = 0; $i < $folders->getListSize(); $i++)
		{
			print $folders->getLabel($i) . "\n";
		}
	};
	
	if ($@)
	{
		print $@;
	}
LoadFormHtml

テンプレートの名前とタイプ以外のデータを必要としない IBM Rational Change テンプレートをロードします。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な HTML ページです。<HTML>...</HTML>
       戻り値は .html ファイルとして保存、またはブラウザーの window/control にロードすることができます。
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー templateName : ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
	スカラー templateType: ロード対象の IBM Rational Change テンプレートのタイプ: ([ONLOAD_ACTION]type[/ONLOAD_ACTION])
 
 戻り値: apiData
	サーバーからの HTML テンプレート。
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->LoadFormHtml($aUser, "SearchTipsWindow", "workspace_form");
	};
	if ($@)
	{
		print $@;
	}
LoadFormUrl

テンプレートの名前とタイプ以外のデータを必要としない IBM Rational Change テンプレートをロードします。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な URL アドレスです。
       戻り値はリンクとして保存、またはブラウザーの window/control にロードすることができます。
 
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー templateName : ロード対象の IBM Rational Change テンプレートの名前。
	                      ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
	スカラー templateType: ロード対象の IBM Rational Change テンプレートのタイプ: ([ONLOAD_ACTION]type[/ONLOAD_ACTION])
 
 戻り値: apiData
	目的のテンプレートの URL アドレス。
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->LoadFormUrl($aUser, "SearchTipsWindow", "workspace_form");
	};
	if ($@)
	{
		print $@;
	}
LoadFrameSetHtml

IBM Rational Change の「frameset_form」テンプレートをロードします。 IBM Rational Change サーバーは提供されたテンプレート名を構文解析します。 その他の関数変数は、フレーム・セット・フォーム定義に格納されている URL で利用できます。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な HTML ページです。<HTML>...</HTML>
       戻り値は .html ファイルとして保存、またはブラウザーの window/control にロードすることができます。
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー templateName : ロード対象の IBM Rational Change テンプレートの名前。
						  ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
	スカラー taskNumber   : 参照するタスク ID。
	スカラー taskStatus   : 参照するタスクの状態値。
	スカラー problemNumber : 参照する変更依頼 ID/問題番号 ID。
	スカラー problemStatus: 参照する CR の crstatus 値。
	スカラー cvid         : 参照するオブジェクトの CVID。
	スカラー externalData : 提出依頼に渡される XML データの文字列。
 外部データ XML のフォーマット:
 
 <EXTERNAL_CONTEXT_DATA>
 	<ATTRIBUTE NAME="attribute_name">your value</ATTRIBUTE>
 	<ATTRIBUTE NAME="attribute_name">your value</ATTRIBUTE>
 	<ATTRIBUTE NAME="attribute_name">your value</ATTRIBUTE>
 	.
 	.
 	.
 </EXTERNAL_CONTEXT_DATA>
 
 戻り値: apiData
	要求されたフレームセットの HTML ページ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->LoadFrameSetHtml($aUser, "ChangeSynergyShowDetails", undef,
											  undef, "1347", undef, undef, undef);
	};
	if ($@)
	{
		print $@;
	}
LoadFrameSetUrl

IBM Rational Change の「frameset_form」テンプレートをロードします。 IBM Rational Change サーバーは提供されたテンプレート名を構文解析します。 その他の関数変数は、フレーム・セット・フォーム定義に格納されている URL で利用できます。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な URL アドレスです。
       戻り値はリンクとして保存、またはブラウザーの window/control にロードすることができます。
 
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー templateName : ロード対象の IBM Rational Change テンプレートの名前。
						  ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
	スカラー taskNumber   : 参照するタスク ID。
	スカラー taskStatus   : 参照するタスクの状態値。
	スカラー problemNumber : 参照する変更依頼 ID/問題番号 ID。
	スカラー problemStatus: 参照する CR の crstatus 値。
	スカラー cvid         : 参照するオブジェクトの CVID。
	スカラー externalData : 提出依頼に渡される XML データの文字列。
 外部データ XML のフォーマット:
 
 <EXTERNAL_CONTEXT_DATA>
 	<ATTRIBUTE NAME="attribute_name">your value</ATTRIBUTE>
 	<ATTRIBUTE NAME="attribute_name">your value</ATTRIBUTE>
 	<ATTRIBUTE NAME="attribute_name">your value</ATTRIBUTE>
 	.
 	.
 	.
 </EXTERNAL_CONTEXT_DATA>
 
 戻り値: apiData
	要求されたフレームセットの URL。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->LoadFrameSetUrl($aUser, "ChangeSynergyShowDetails", undef,
											  undef, "1347", undef, undef, undef);
	};
	if ($@)
	{
		print $@;
	}
LoadMergeConfigurationFiles

すべての構成データ・ファイルを [CFG_MERGE][/CFG_MERGE] から IBM Rational Change サーバーにロードします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->LoadMergeConfigurationFiles($aUser);
	};
	if ($@)
	{
		print $@;
	}
Login

特定のユーザーとして IBM Rational Change サーバーにログインし、特定の IBM Rational Synergy データベースに接続します。 返される結果は apiUser クラスのインスタンスです。

 パラメーター:
	スカラー user    : ユーザーの名前。
	スカラー password: ユーザーのパスワード。
	スカラー role    : ユーザーのロール。(Web クライアントでは、現在、この使用方法の「ロール」の代わりに「インターフェース」という用語が使用されています)
	スカラー database: ユーザーの IBM Rational Synergy データベース・パス。
 戻り値: apiUser
指定した情報を持つ apiUser クラスの新しいインスタンス。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
	};
	if ($@)
	{
		print $@;
	}
AddUser

LDAP サーバーと Rational Synergy データベースの両方に新規ユーザーを追加し、指定された Rational Synergy ロールのセットを割り当てます。新規ユーザーは、この呼び出しが完了するとログインできるようになります。返される結果は apiData クラスのインスタンスです。

注記: この関数をループ内で呼び出さないでください。代わりに AddUsers() API 関数を使用してください。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	apiUser aNewUser: 新規ユーザーのデータ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");		

		my $aNewUser = new ChangeSynergy::apiUser("jsmith", "password", "developer|ccm_admin|pt_admin",
                                                  "\\\\your_hostname\\ccmdb\\cm_database");
		

		my $tmpstr = $csapi->AddUser($aUser, $aNewUser);
	};
	if ($@)
	{
		print $@;
	}
AddUsers

LDAP サーバーと Rational Synergy データベースの両方に新規ユーザーのセットを追加し、指定された Rational Synergy ロールのセットを割り当てます。新規ユーザーは、この呼び出しが完了するとログインできるようになります。返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	@apiUser aNewUser: 新規ユーザーのデータの配列
	スカラー   iCount  : 新規ユーザーの配列のサイズ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $i;

		my $j=100;
		my @newUsers;
		for($i=0;$i<$j;$i++)
		{
			push @newUsers, new ChangeSynergy::apiUser("ATestUser" . $i ,"ATestUser",
                                                       "developer|ccm_admin|pt_admin",
                                                       "\\\\your_hostname\\ccmdb\\cm_database");
		}
		my $tmpstr = $csapi->AddUsers($aUser, \@newUsers, $j);
	};
	if ($@)
	{
		print $@;
	}
Logout

チェックアウトしたライセンスを即時に (ライセンス・リンガー・タイムなし) 開放してユーザーをログアウトします。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
 
 戻り値: apiData
	サーバーからのリターン・メッセージ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->Logout($aUser);
	};
	if ($@)
	{
		print $@;
	}
ModifyCR

修正した変更依頼データを適用します。 修正済みというフラグの付いたデータ・オブジェクトだけが IBM Rational Change サーバーに送信されます。 属性 problem_number、modify_time、および cvid は変更してはなりません。 これらの属性は、API クラスが必要に応じて自動処理します。 返される結果は apiData クラスのインスタンスです。

注記: apiObjectData のメンバーのメソッド setValue("") は、起動されると、修正済みフラグを自動的に設定します。

 パラメーター:
	apiUser aUser:      現在の API ユーザーのログイン・データ。
	apiObjectVector data : API 関数によって処理されるデータ。
 戻り値: apiData

	修正が正常に完了したかどうかの結果のみ。
 
 例:
 

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->AttributeModifyCRData($aUser, "100", "crstatus");
		or

		my $tmp = $csapi->AttributeModifyCRData($aUser, "100");
		or

		my $tmp = $csapi->ModifyCRData($aUser, "100", "CRDetail");
		or

		my $tmp = $csapi->GetCRData($aUser, "100", "problem_synopsis|problem_description|keyword");
		
		$tmp->getDataObjectByName("problem_synopsis")->setValue("I modified the synopsis through the csapi...");
		$tmp->getDataObjectByName("problem_description")->setValue("I modified the description through the csapi...");
		$tmp->getDataObjectByName("keyword")->setValue("csapi");
		my $tmpstr = $csapi->ModifyCR($aUser, $tmp);
	};
	if ($@)
	{
		print $@;
	}
ModifyCRData

変更依頼の詳細を、変更依頼の詳細の修正が可能なデータ・クラスにロードします。 修正されたデータ・クラスは、変更依頼を変更するために、修正 API 関数の 1 つを使って提出できます。 返される結果は apiObjectVector クラスのインスタンスです。

注記: 現在の遷移の選択肢は、この API 関数呼び出しによって提供されます。 apiTransitions クラスの説明を参照してください。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー problemNumber : 参照する変更依頼 ID/問題番号 ID。
	スカラー  templateName : ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
 戻り値: apiObjectVector
データ形式の変更依頼の詳細。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->ModifyCRData($aUser, "100", "CRDetail");
		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
ModifyObjectAttributes

名前が「your name value」のオブジェクトの既存の属性を修正します。属性に与える初期値を指定する必要があります。この操作はオブジェクトの modify_time 属性も更新します。返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー        cvidList    : パイプ文字「|」で区切られた、影響を受ける cvid のリスト、または 1 つの cvid。
	apiObjectVector attrData    : API 関数によって処理されるデータ。
 
 戻り値: apiData
	サーバーからのリターン・メッセージ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $attrData = new ChangeSynergy::apiObjectVector();
		my $objData = new ChangeSynergy::apiObjectData();
		$objData->setName("attribute_a");
		$objData->setValue("Linux");
		$attrData->addDataObject($objData);
		my $objData = new ChangeSynergy::apiObjectData();
		$objData->setName("attribute_b");
		$objData->setValue("true");
		$attrData->addDataObject($objData);
		my $objData = new ChangeSynergy::apiObjectData();
		$objData->setName("attribute_c");
		$objData->setValue("777");
		$attrData->addDataObject($objData);
		my $tmp = $csapi->ModifyObjectAttributes($aUser, "10156|10157|10158|10159|10160", $attrData)
		print $tmp->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
ModifyTask

修正したタスク・データを適用します。 修正済みというフラグの付いたデータ・オブジェクトだけが IBM Rational Change サーバーに送信されます。属性 task_number、modify_time、および cvid は変更してはなりません。 これらの属性は、API クラスが必要に応じて自動処理します。 返される結果は apiData クラスのインスタンスです。

注記: apiObjectData のメンバーのメソッド setValue("") は、起動されると、修正済みフラグを自動的に設定します。

 パラメーター:
	apiUser aUser:      現在の API ユーザーのログイン・データ。
	apiObjectVector data : API 関数によって処理されるデータ。
 戻り値: apiData

	修正が正常に完了したかどうかの結果のみ。
 例:
 

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->ModifyTaskData($aUser, "10", "TaskDetails");
		or

		my $tmp = $csapi->GetTaskData($aUser, "10", "task_synopsis|task_description|priority");
		
		$tmp->getDataObjectByName("task_synopsis")->setValue("I modified the synopsis through the csapi...");
		$tmp->getDataObjectByName("task_description")->setValue("I modified the description through the csapi...");
		$tmp->getDataObjectByName("priority")->setValue("high");
		my $tmpstr = $csapi->ModifyTask($aUser, $tmp);
	};
	if ($@)
	{
		print $@;
	}
ModifyTaskData

タスクの詳細を、タスクの詳細の修正が可能なデータ・クラスにロードします。 修正されたデータ・クラスは、タスクを変更する修正 API 関数の 1 つを使って提出できます。 返される結果は apiObjectVector クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー taskNumber   : 参照するタスク ID。
	スカラー  templateName: ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE]) 
戻り値: apiObjectVector
データ形式のタスクの詳細
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->ModifyTaskData($aUser, "10", "TaskDetails");
		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
moveFolderMembers

クエリー、レポート・フォーマット、またはレポート・フォルダーのメンバーを同じタイプの新規フォルダーに移動します。 サーバーは、レポートがメンバーとして現在所属しているフォルダーを検出し、新規に指定されたフォルダーにレポートを移動します。移動を完了するには、リスト内のすべてのメンバーが存在している必要があります。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  folderName   : レポートの移動先フォルダーの名前。
	スカラー  memberList   : フォルダー間を移動するレポートのパイプ区切りリスト。
	スカラー  objectType : フォルダーのオブジェクト・タイプ。
	スカラー  formatType : フォルダーのフォーマット・タイプ: レポート、クエリーまたはレポート・フォーマット。
	スカラー  configType : レポートの構成場所。
 有効なオブジェクト・タイプ (Globals.pm に定義された定数):
        PROBLEM_TYPE
        TASK_TYPE
        OBJECT_TYPE
 有効なフォーマット・タイプ (Globals.pm に定義された定数):
 		QUERY
        REPORT
        REPORT_FORMAT
 

 有効な構成タイプ (Globals.pm に定義された定数):
        SHARED_PROFILE
        SYSTEM_CONFIG
        USER_PROFILE

 戻り値: apiData
	サーバーからのリターン・メッセージ。

 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "Admin", "\\\\machine\\ccmdb\\cm_database");
		


		my $globals = new ChangeSynergy::Globals();
		
		#Moves the reports 'API Test 1' and 'API Test 2' to the folder 'API Folder'.

		my $moveResults = $csapi->moveFolderMembers($aUser, "API Folder", "API Test 1|API Test 2", $globals->{PROBLEM_TYPE}, $globals->{REPORT}, $globals->{SHARED_PROFILE});
		print $moveResults->getResponseData() . "\n";
	};
	if ($@)
	{
		print $@;
	}
PreferenceNameSubstitutionForAllUsers

すべてのユーザーの設定名内で置換を実行します。例えば、ユーザーのレポートとクエリーは _USER_CFG_%username_%databasepath エントリーに格納されています。 これが _USER_CFG_jsmith_\\your_hostnameA\ccmdb\cm_database であるとします。データベースが your_hostnameA から your_hostnameB に移動した場合は、このメソッドを使用して置換を実行できます。 この関数は、指定文字列を検索してそれをすべて別の文字列に置換します。 つまり、「\\your_hostnameA\ccmdb\cm_database」を検索して「\\your_hostnameB\ccmdb\cm_database」に置換します。 返される結果は apiData クラスのインスタンスです。

注記: ユーザー・プロファイルの値は、変更または追加できません。 ユーザー・プロファイル値には、ユーザーのファーストネーム、ラストネーム、E メール・アドレス、ファックス番号、電話番号、および住所があります。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  keyValue: 置換を実行するときに検索する値。
	スカラー  subValue: 置換する値、追加する値。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostnameB\\ccmdb\\cm_database");
		$tmpData = $csapi->PreferenceNameSubstitutionForAllUsers($aUser, "\\\\your_hostnameA\\ccmdb\\cm_database", "\\\\your_hostnameB\\ccmdb\\cm_database");
	
		print $tmpData->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
PreferenceNameSubstitutionForAUser

1 人のユーザーの設定名内で置換を実行します。例えば、ユーザーのレポートとクエリーは _USER_CFG_%username_%databasepath エントリーに格納されています。 これが _USER_CFG_jsmith_\\your_hostnameA\ccmdb\cm_database であるとします。データベースが your_hostnameA から your_hostnameB に移動した場合は、このメソッドを使用して置換を実行できます。 この関数は、指定文字列を検索してそれをすべて別の文字列に置換します。 つまり、「\\your_hostnameA\ccmdb\cm_database」を検索して「\\your_hostnameB\ccmdb\cm_database」に置換します。 返される結果は apiData クラスのインスタンスです。

注記: ユーザー・プロファイルの値は、変更または追加できません。 ユーザー・プロファイル値には、ユーザーのファーストネーム、ラストネーム、E メール・アドレス、ファックス番号、電話番号、および住所があります。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  username: 編集対象のユーザー設定の名前。
	スカラー  keyValue: 置換を実行するときに検索する値。
	スカラー  subValue: 置換する値、追加する値。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostnameB\\ccmdb\\cm_database");
		$tmpData = $csapi->PreferenceNameSubstitutionForAUser($aUser, "u00001", "\\\\your_hostnameA\\ccmdb\\cm_database", "\\\\your_hostnameB\\ccmdb\\cm_database");
	
		print $tmpData->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
PreferenceSubstitutionForAUser

1 人のユーザーの設定値内で置換を実行します。ユーザー設定が所与の場合、指定文字列を検索してそれをすべて別の文字列に置換します。 これは、ユーザーの config エントリーを変更して、あるレポート名 (problem_review) を _USER_CFG_ エントリー全体で別のレポート名 (cr_review) に置換する必要がある場合に便利です。返される結果は apiData クラスのインスタンスです。

注記: ユーザー・プロファイルの値は、変更または追加できません。 ユーザー・プロファイル値には、ユーザーのファーストネーム、ラストネーム、E メール・アドレス、ファックス番号、電話番号、および住所があります。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  username: 編集対象のユーザー設定の名前。
	スカラー  keyName : 編集対象の設定の名前。
	スカラー  keyValue: 置換を実行するときに検索する値。
	スカラー  subValue: 置換する値、追加する値。
	スカラー allDBs  : true または false。
						追加を全データベースについて行うか、または現在の API ユーザーがログインしているデータベースだけに行うか。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");		
		$tmpData = $csapi->PreferenceSubstitutionForAUser($aUser, "u00001", "_USER_CFG_", "problem_review", "cr_review", "true");
	
		print $tmpData->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
PreferenceSubstitutionForAllUsers

すべてのユーザーの設定値内で置換を実行します。ユーザー設定が所与の場合、指定文字列を検索してそれをすべて別の文字列に置換します。 これは、ユーザーの config エントリーを変更して、あるレポート名 (problem_review) を _USER_CFG_ エントリー全体で別のレポート名 (cr_review) に置換する必要がある場合に便利です。返される結果は apiData クラスのインスタンスです。

注記: ユーザー・プロファイルの値は、変更または追加できません。 ユーザー・プロファイル値には、ユーザーのファーストネーム、ラストネーム、E メール・アドレス、ファックス番号、電話番号、および住所があります。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  keyName : 編集対象の設定の名前。
	スカラー  keyValue: 置換を実行するときに検索する値。
	スカラー  subValue: 置換する値、追加する値。
	スカラー allDBs  : true または false。
						追加を全データベースについて行うか、または現在の API ユーザーがログインしているデータベースだけに行うか。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");		
		$tmpData = $csapi->PreferenceSubstitutionForAllUsers($aUser, "_USER_CFG_", "problem_review", "cr_review", "true");
	
		print $tmpData->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
ProcessEmailSubmitForms

IBM Rational Change サーバーの E メール提出フォームを処理します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ProcessEmailSubmitForms($aUser);
	};
	if ($@)
	{
		print $@;
	}
QueryData

IBM Rational Change レポートを実行し、XML データのみで応答します。 返される結果は apiQueryData クラスのインスタンスです。

注記: 戻り値は、データのみで表されたレポートの全内容です。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  reportName   : IBM Rational Change レポート名。
	                      ([CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー  queryString: 有効な IBM Rational Synergy クエリー・ストリング。
	スカラー  queryName   : IBM Rational Change クエリー名。
	                      ([CCM_QUERY][NAME]query name[/NAME]...[/CCM_QUERY])
	スカラー reportTitle: レポートのこのインスタンスのタイトル。
	スカラー  templateName: ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])	
 戻り値: apiQueryData
レポート・データを表す XML データ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->QueryData($aUser, "Basic Summary", "(submitter='cschuffe') and (cvtype='problem')",
                                    undef, undef, undef);
	};
	if ($@)
	{
		print $@;
	}
QueryData

IBM Rational Change レポートを実行し、XML データのみで応答します。 返される結果は apiQueryData クラスのインスタンスです。

注記: 戻り値は、データのみで表されたレポートの全内容です。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー reportName : IBM Rational Change レポート名。
	                      ([CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー  queryString  : 有効な IBM Rational Synergy クエリー・ストリング。
	スカラー  queryName    : IBM Rational Change クエリー名。
	                       ([CCM_QUERY][NAME]query name[/NAME]...[/CCM_QUERY])
	スカラー reportTitle: レポートのこのインスタンスのタイトル。
	スカラー templateName : ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
	スカラー attributeList: パイプ文字で区切られた属性のリスト。"problem_number|crstatus|assigner..."
	
 戻り値: apiQueryData
レポート・データを表す XML データ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->QueryData($aUser, "Basic Summary", "(submitter='cschuffe') and (cvtype='problem')",
                                    undef, undef, undef, "problem_number|crstatus");
	};
	if ($@)
	{
		print $@;
	}
QueryHtml

IBM Rational Change レポートを実行し、結果もしくはポーリング・テンプレート (まだ結果が用意されていない場合) を返します。

この API は大きいレポートの実行に使用します。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な HTML ページです。<HTML>...</HTML>
       戻り値は .html ファイルとして保存するか、またはブラウザーの window/control にロードすることができます。
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー reportName : IBM Rational Change レポート名。
	                      ([CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー  queryString: 有効な IBM Rational Synergy クエリー・ストリング。
	スカラー  queryName    : IBM Rational Change クエリー名。
	                      ([CCM_QUERY][NAME]query name[/NAME]...[/CCM_QUERY])
	スカラー reportTitle: レポートのこのインスタンスのタイトル。
	スカラー templateName : ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
 戻り値: apiData

 	要求された即時クエリーの HTML ページ、または実行したクエリーのポーリング・テンプレート。これは HTML ページです。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->QueryHtml($aUser, "Basic Summary",
                                       "(submitter='cschuffe') and (cvtype='problem')",
                                       undef, "Basic Summary Report");
	};
	if ($@)
	{
		print $@;
	}
QueryNameData

IBM Rational Change レポートを実行し、XML データのみで応答します。 返される結果は apiQueryData クラスのインスタンスです。

注記: 戻り値は、データのみで表されたレポートの全内容です。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー reportName : IBM Rational Change レポート名。
	                      ([CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー  queryName    : IBM Rational Change クエリー名。
	                       ([CCM_QUERY][NAME]query name[/NAME]...[/CCM_QUERY])
	スカラー attributeList: パイプ文字で区切られた属性のリスト。"problem_number|crstatus|assigner..."
	
 戻り値: apiQueryData
レポート・データを表す XML データ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->QueryNameData($aUser, "Basic Summary", "All CRs", "problem_number|crstatus");
	};
	if ($@)
	{
		print $@;
	}
QueryStringData

IBM Rational Change レポートを実行し、XML データのみで応答します。 返される結果は apiQueryData クラスのインスタンスです。

注記: 戻り値は、データのみで表されたレポートの全内容です。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー reportName : IBM Rational Change レポート名。
	                      ([CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー  queryString  : 有効な IBM Rational Synergy クエリー・ストリング。
	スカラー attributeList: パイプ文字で区切られた属性のリスト。"problem_number|crstatus|assigner..."
	
 戻り値: apiQueryData
レポート・データを表す XML データ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->QueryStringData($aUser, "Basic Summary", "(submitter='cschuffe') and (cvtype='problem')",
                                    "problem_number|crstatus");
	};
	if ($@)
	{
		print $@;
	}
RefreshUsers

注記: IBM Rational Change 5.2 ではこの方法はあまり有用ではありません。 現在の IBM Rational Change は" ccm users" command による変更を自動検知しますので、この API を呼び出す必要性は軽減されています。更新は、内容によらずすべてについて一回で行われます。 この方法は、処理が冗長にはなりますが問題は発生しません。

すべてのバックエンド・セッションのセキュリティー設定を更新し、すべてのユーザー情報を再ロードします。この操作は、IBM Rational Change の外部から IBM Rational Synergy にユーザーが追加された場合に必要となります。 通常、こういった変更は新しいセッションの開始時に検知されます。既存のセッションは変更前のデータを使用します。 この機能はすべてのセッションを更新し、即時にこういった変更を表示させます。

管理インターフェースへのアクセス権を持つユーザーとしてログインしている必要があります。

IBM Rational Change は LDAP サーバーに登録されていないユーザーを認識しません。 ユーザーを IBM Rational Synergy に追加して、この関数で呼び出すだけではユーザーは IBM Rational Change にログオンを許可されません。 この API は上級ユーザーによるカスタマイズにのみ役に立ちます。

 パラメーター:
	apiUser aUser        : 現在の API ユーザーのログイン・データ。
 戻り値: スカラー
 	サーバーからのリターン・メッセージ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		$csapi->RefreshUsers($aUser);
	};
	if ($@)
	{
		print $@;
	}
renameFolder

サーバー上のクエリー、レポート・フォーマット、またはレポート・フォルダーの名前を変更します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  folderName   : フォルダーの現在の名前。
	スカラー  newFolderName: フォルダーの新しい名前。
	スカラー  objectType : フォルダーのオブジェクト・タイプ。
	スカラー  formatType : フォルダーのフォーマット・タイプ: レポート、クエリーまたはレポート・フォーマット。
	スカラー  configType : レポートの構成場所。
 有効なオブジェクト・タイプ (Globals.pm に定義された定数):
        PROBLEM_TYPE
        TASK_TYPE
        OBJECT_TYPE
 有効なフォーマット・タイプ (Globals.pm に定義された定数):
 		QUERY
        REPORT
        REPORT_FORMAT
 

 有効な構成タイプ (Globals.pm に定義された定数):
        SHARED_PROFILE
        SYSTEM_CONFIG
        USER_PROFILE

 戻り値: apiData
	サーバーからのリターン・メッセージ。

 例:
	

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "Admin", "\\\\machine\\ccmdb\\cm_database");
		


		my $globals = new ChangeSynergy::Globals();
		
		#Renames a shared CR Report folder called 'API Folder' to 'API Folder Renamed'

		my $renameResults = $csapi->renameFolder($aUser, "API Folder", "API Folder Renamed", $globals->{PROBLEM_TYPE}, $globals->{REPORT}, $globals->{SHARED_PROFILE});
		print $renameResults->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
ReloadListboxes

pt_listbox.cfg ファイルを再ロードし、データベースから値を取得する全リスト・ボックスを再ロードします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ReloadListboxes($aUser);
	};
	if ($@)
	{
		print $@;
	}
ReloadStringTable

外部文字列テーブルをクリアし、再ロードします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ReloadStringTable($aUser);
	};
	if ($@)
	{
		print $@;
	}
reloadAppProperties

ファイル WEB-INF/wsconfig/system/app.properties および WEB-INF/wsconfig/system/app.user.properties を再ロードします。

返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->reloadAppProperties($aUser);
	};
	if ($@)
	{
		print $@;
	}
ReportData

IBM Rational Change レポートを実行し、XML データのみで応答します。 返される結果は apiQueryData クラスのインスタンスです。

注記: 戻り値は、データのみで表されたレポートの全内容です。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー reportName : IBM Rational Change レポート名。
	                      ([CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー  attributeList: パイプ文字で区切られた属性のリスト。"problem_number|crstatus|assigner..."
 戻り値: apiQueryData
レポート・データを表す XML データ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->ReportData($aUser, "DRP - Summary of CRs Submitted by Me", "problem_number");
		
		$tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
ReportData

IBM Rational Change レポートを実行し、XML データのみで応答します。 返される結果は apiQueryData クラスのインスタンスです。

注記: 戻り値は、データのみで表されたレポートの全内容です。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー reportName : IBM Rational Change レポート名。
	                      ([CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー reportTitle: レポートのこのインスタンスのタイトル。
	スカラー templateName : ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
 戻り値: apiQueryData
レポート・データを表す XML データ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->ReportData($aUser, "DRP - Summary of CRs Submitted by Me", undef, undef);
		
		$tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
ReportData

IBM Rational Change レポートを実行し、XML データのみで応答します。 返される結果は apiQueryData クラスのインスタンスです。

注記: 戻り値は、データのみで表されたレポートの全内容です。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー reportName : IBM Rational Change レポート名。
	                      ([CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー reportTitle: レポートのこのインスタンスのタイトル。
	スカラー  templateName : ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
	スカラー  attributeList: パイプ文字で区切られた属性のリスト。"problem_number|crstatus|assigner..."
 戻り値: apiQueryData
レポート・データを表す XML データ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->ReportData($aUser, "DRP - Summary of CRs Submitted by Me", undef, undef, undef);
		
		$tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
ReportHtml

IBM Rational Change レポートを実行し、結果もしくはポーリング・テンプレート (まだ結果が用意されていない場合) を返します。 この API は大きいレポートの実行に使用します。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な HTML ページです。<HTML>...</HTML>
       戻り値は .html ファイルとして保存するか、またはブラウザーの window/control にロードすることができます。
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー reportName : IBM Rational Change レポート名。
	                      ([CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー reportTitle: レポートのこのインスタンスのタイトル。
	スカラー  templateName: ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
 
 戻り値: apiData
 	要求された即時クエリーの HTML ページ、または実行したレポートのポーリング・テンプレート。これは HTML ページです。 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ReportHtml($aUser, "Basic Summary", "Basic Summary Report", undef);
	};
	if ($@)
	{
		print $@;
	}
ReportOnCRData

1 つの変更依頼についてレポートする IBM Rational Change レポートを実行します。 返される結果は apiQueryData クラスのインスタンスです。

注記: 戻り値は、データのみで表されたレポートの全内容です。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  problemNumber : 参照する変更依頼 ID/問題番号 ID。
	スカラー  ReportName   : IBM Rational Change レポート名。
	                      ([CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー  reportTitle  : レポートのこのインスタンスのタイトル。
 戻り値: apiQueryData
	レポートの内容を表す XML データ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->ReportOnCRData($aUser, "132", "DRP - Summary with Tasks and Objects", undef);
		

		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
ReportOnCRData

1 つの変更依頼についてレポートする IBM Rational Change レポートを実行します。 返される結果は apiQueryData クラスのインスタンスです。

注記: 戻り値は、データのみで表されたレポートの全内容です。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  problemNumber : 参照する変更依頼 ID/問題番号 ID。
	スカラー  ReportName   : IBM Rational Change レポート名。
	                      ([CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー reportTitle: レポートのこのインスタンスのタイトル。
	スカラー  attributeList: パイプ文字で区切られた属性のリスト。"problem_number|crstatus|assigner..."
 戻り値: apiQueryData
	レポートの内容を表す XML データ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->ReportOnCRData($aUser, "132", "DRP - Summary with Tasks and Objects",
                                         undef, "problem_number|crstatus");
		

		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
ReportOnCRHtml

1 つの変更依頼についてレポートする IBM Rational Change レポートを実行します。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な HTML ページです。<HTML>...</HTML>
       戻り値は .html ファイルとして保存、またはブラウザーの window/control にロードすることができます。
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  problemNumber : 参照する変更依頼 ID/問題番号 ID。
	スカラー reportName : IBM Rational Change レポート名。
	                      ([CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー reportTitle: レポートのこのインスタンスのタイトル。
 
 戻り値: apiData
	HTML ページ形式のレポート。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ReportOnCRHtml($aUser, "1347", "problemdetail", undef);
	};
	if ($@)
	{
		print $@;
	}
ReportOnObjectData

1 つのオブジェクトについてレポートする IBM Rational Change レポートを実行します。 返される結果は apiQueryData クラスのインスタンスです。

注記: 戻り値は、データのみで表されたレポートの全内容です。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  objectId   : 参照されるオブジェクトの CVID。
	スカラー reportName : IBM Rational Change レポート名。
	                      ([CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー reportTitle: レポートのこのインスタンスのタイトル。
 戻り値: apiQueryData
	XML データ形式のレポート。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->ReportOnObjectData($aUser, "11753", "objectdetail", undef);
		

		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
ReportOnObjectData

1 つのオブジェクトについてレポートする IBM Rational Change レポートを実行します。 返される結果は apiQueryData クラスのインスタンスです。

注記: 戻り値は、データのみで表されたレポートの全内容です。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  objectId   : 参照されるオブジェクトの CVID。
	スカラー  reportName   : IBM Rational Change レポート名。
	                      ([CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー reportTitle: レポートのこのインスタンスのタイトル。
	スカラー  attributeList: パイプ文字で区切られた属性のリスト。"problem_number|crstatus|assigner..."
 戻り値: apiQueryData
	XML データ形式のレポート。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->ReportOnObjectData($aUser, "11753", "objectdetail", undef, "problem_number");
		

		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
ReportOnObjectHtml

1 つのオブジェクトについてレポートする IBM Rational Change レポートを実行します。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な HTML ページです。<HTML>...</HTML>
       戻り値は .html ファイルとして保存、またはブラウザーの window/control にロードすることができます。
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  objectId   : 参照されるオブジェクトの CVID。
	スカラー  reportName   : IBM Rational Change レポート名。
	                      ([CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー reportTitle: レポートのこのインスタンスのタイトル。
 戻り値: apiData

	HTML ページ形式のレポート。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ReportOnObjectHtml($aUser, "13", "objectdetail", undef);
	};
	if ($@)
	{
		print $@;
	}
ReportOnTaskData

1 つのタスクについてレポートする IBM Rational Change レポートを実行します。 返される結果は apiQueryData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー taskNumber   : 参照するタスク ID。
	スカラー  reportName   : IBM Rational Change レポート名。
	                      ([CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー reportTitle: レポートのこのインスタンスのタイトル。
 戻り値: apiQueryData
	XML データ形式のレポート。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->ReportOnTaskData($aUser, "1", "taskdetail", undef);
		

		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
ReportOnTaskData

1 つのタスクについてレポートする IBM Rational Change レポートを実行します。 返される結果は apiQueryData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー taskNumber   : 参照するタスク ID。
	スカラー  reportName   : IBM Rational Change レポート名。
	                      ([CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー reportTitle: レポートのこのインスタンスのタイトル。
	スカラー  attributeList: パイプ文字で区切られた属性のリスト。"problem_number|crstatus|assigner..."
 戻り値: apiQueryData
	XML データ形式のレポート。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->ReportOnTaskData($aUser, "1", "taskdetail", undef, "task_number");
		

		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
ReportOnTaskHtml

1 つのタスクについてレポートする IBM Rational Change レポートを実行します。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な HTML ページです。<HTML>...</HTML>
       戻り値は .html ファイルとして保存、またはブラウザーの window/control にロードすることができます。
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー taskNumber   : 参照するタスク ID。
	スカラー  reportName   : IBM Rational Change レポート名。
	                      ([CCM_REPORT][NAME]report name[/NAME]...[/CCM_REPORT])
	スカラー reportTitle: レポートのこのインスタンスのタイトル。
 戻り値: apiData

	HTML ページ形式でのレポートの結果。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ReportOnTaskHtml($aUser, "13", "taskdetail", undef);
	};
	if ($@)
	{
		print $@;
	}
ResetAdminTokens

すべてのデータベースの管理者ユーザーをログインします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ResetAdminTokens($aUser);
	};
	if ($@)
	{
		print $@;
	}
ResetConfigurationDataLoadTime

IBM Rational Change サーバーにロードされた構成データ・タイム・スタンプをリセットします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ResetConfigurationDataLoadTime($aUser);
	};
	if ($@)
	{
		print $@;
	}
ServerAPIVersion

サーバーの API バージョン番号を取得します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData


	バージョン番号文字列。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr1 = $csapi->ServerAPIVersion($aUser);
	};
	if ($@)
	{
		print $@;
	}
ServerGetFile

ファイル・オブジェクトを IBM Rational Change サーバーから取得します。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser:      現在の API ユーザーのログイン・データ。
	スカラー  file : 取り出す対象のオブジェクトのファイル名。
 戻り値: apiData

	サーバーから返されるバイト・データ。
	
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");

		my $file       = "serverFile.txt";

		my $filehandle = $csapi->ServerGetFile($aUser, $file);
		open(OUTPUTFILE, ">serverFile.txt");
		print OUTPUTFILE $filehandle->getResponseByteData();
		close OUTPUTFILE;
	};
	if ($@)
	{
		print $@;
	}
ServerSendFile

ファイル・オブジェクトを IBM Rational Change サーバーへコピーします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  buffer: サーバーに送出するバイト・データ。
	スカラー  size  : バイト・データのサイズ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
	
 例:
	my $csapi  = new ChangeSynergy::csapi();

	my $buffer = "";

	my $buf    = "";

	my $size   = "";
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		open(INPUTFILE, "filename.txt") or die "Could not open up the file";
		while($buf = readline *INPUTFILE)
		{
			$buffer .= $buf;
		}
		close(INPUTFILE);
		
		$size = -s "filename.txt";
		my $filehandle = $csapi->ServerSendFile($aUser, $buffer, $size);
	};
	if ($@)
	{
		print $@;
	}
ServerVersion

サーバーのバージョン番号を取得します。トークンレスの API です。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData


	バージョン番号文字列。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr1 = $csapi->ServerVersion();
	};
	if ($@)
	{
		print $@;
	}
SetAttributes

サーバーで IBM Rational Change 属性を設定または作成します。

インストールされた CRProcess で、カスタム・アプリケーションが参照するすべての属性が定義されている場合、この操作は必要ありません。 このことを確認するには、GetAttributes() API メソッドを使用できます。

指定された一意の属性のリストは、指定された名前で IBM Rational Change 構成ファイルに保存されます。「lpszCfgName」にはドット付きの拡張子「.ext」を付けず、「my_app_attrs」などのように、ファイル名の接頭辞のみを付けます。 IBM Rational Change サーバーによって名前に「.cfg」が追加されます。 ファイルの名前付けには注意が必要です。 'pt'、'task_framework'、'admin_framework'、'user_framework'、'users'、'template' などの名前は、予約済みのシステム構成ファイル名なので使用できません。 lpszCfgName.cfg という名前が存在する場合、この操作によりそのファイルが削除されます。 同様の方法で、自分のカスタム属性リストを上書きできます。 ファイルが生成または削除できない場合、この操作は失敗します。

既存の lpszCfgName.cfg ファイルに定義されている属性以外に、リストにある属性のいずれかがサーバーに存在する場合、この操作は失敗します。 このような理由で操作が失敗した場合、原因となる属性のリストが返されます。 GetAttributes() API メソッドを使用して、すべてのカスタムのアプリケーション属性が IBM Rational Change サーバーに認識されていないことを確認してください。

既知の定義済みの IBM Rational Change 属性 (予約済みなので定義できません):

	***************** グローバル CR 属性 *****************
	
	[CCM_ATTRIBUTE][NAME]crstatus[/NAME][ALIAS]状態[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]problem_synopsis[/NAME][ALIAS]概要[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]problem_description[/NAME][ALIAS]問題の説明[/ALIAS][TYPE]CCM_TEXT[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]problem_number[/NAME][ALIAS]問題番号[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]transition_log[/NAME][ALIAS]ログ[/ALIAS][TYPE]CCM_TEXT[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]submitter[/NAME][ALIAS]提出者[/ALIAS][TYPE]CCM_USER[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]submitter_name[/NAME][ALIAS]名前[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]submitter_phone[/NAME][ALIAS]電話番号[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]submitter_fax[/NAME][ALIAS]Fax 番号[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]submitter_address[/NAME][ALIAS]住所[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]submitter_email[/NAME][ALIAS]E メール・アドレス[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]submitter_company[/NAME][ALIAS]会社[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	
	 ***************** グローバル・タスク属性 *****************
	[CCM_ATTRIBUTE][NAME]task_number[/NAME][ALIAS]タスク ID[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]task_synopsis[/NAME][ALIAS]概要[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	
	***************** グローバル・オブジェクト属性 *****************
	
	[CCM_ATTRIBUTE][NAME]cvid[/NAME][ALIAS]IBM Rational Synergy ID[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]comment[/NAME][ALIAS]オブジェクトのコメント[/ALIAS][TYPE]CCM_TEXT[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]description[/NAME][ALIAS]オブジェクト詳細[/ALIAS][TYPE]CCM_TEXT[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]displayname[/NAME][ALIAS]表示名[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]source[/NAME][ALIAS]移行元[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]attachment_name[/NAME][ALIAS]添付名[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]attachment_size[/NAME][ALIAS]添付の長さ[/ALIAS][TYPE]CCM_NUMBER[/TYPE][/CCM_ATTRIBUTE]
	
	***************** 共有 Ccm/PT/システム属性 *****************
	
	[CCM_ATTRIBUTE][NAME]status[/NAME][ALIAS]状態[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]database[/NAME][ALIAS]データベース[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]modifiable_in[/NAME][ALIAS]作業 DB[/ALIAS][TYPE]CCM_LISTBOX[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]created_in[/NAME][ALIAS]作成 DB[/ALIAS][TYPE]CCM_LISTBOX[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]cvtype[/NAME][ALIAS]オブジェクト・タイプ[/ALIAS][TYPE]CCM_LISTBOX[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]name[/NAME][ALIAS]オブジェクト名[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]modify_time[/NAME][ALIAS]最終修正時刻[/ALIAS][TYPE]CCM_DATE[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]status_log[/NAME][ALIAS]遷移ログ[/ALIAS][TYPE]CCM_TEXT[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]platform[/NAME][ALIAS]プラットフォーム[/ALIAS][TYPE]CCM_LISTBOX[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]creator[/NAME][ALIAS]作成者[/ALIAS][TYPE]CCM_USER[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]create_time[/NAME][ALIAS]作成日[/ALIAS][TYPE]CCM_DATE[/TYPE][/CCM_ATTRIBUTE]
	
	***************** 特殊 PTCLI/システム属性 *****************
	
	[CCM_ATTRIBUTE][NAME]users_roles[/NAME][ALIAS]ユーザー・ロール[/ALIAS][TYPE]CCM_TEXT[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]users[/NAME][ALIAS]ユーザー[/ALIAS][TYPE]CCM_TEXT[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]user[/NAME][ALIAS]ユーザー[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]generic_cs_attribute[/NAME][ALIAS]使用/削除しない[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]dcm_dbid[/NAME][ALIAS]DCM データベース ID[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]dcm_delimiter[/NAME][ALIAS]DCM 区切り文字[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]pt_app[/NAME][ALIAS]DevClient アプリケーション・データ[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]pt_app_role[/NAME][ALIAS]DevClient アプリケーション・ロール[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]all_databases[/NAME][ALIAS]すべてのデータベース[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]all_groups[/NAME][ALIAS]すべてのグループ[/ALIAS][TYPE]CCM_LISTBOX[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]LIFECYCLES[/NAME][ALIAS]すべてのライフサイクル[/ALIAS][TYPE]CCM_LISTBOX[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]LIFECYCLE_STATES[/NAME][ALIAS]ライフサイクルのすべての状態[/ALIAS][TYPE]CCM_LISTBOX[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]LIFECYCLE_TRANSITIONS[/NAME][ALIAS]ライフサイクルのすべての遷移[/ALIAS][TYPE]CCM_LISTBOX[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]VALID_TRANSITIONS[/NAME][ALIAS]許可される遷移[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]VALID_CREATES[/NAME][ALIAS]許可される提出[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]VALID_CREATES_USER[/NAME][ALIAS]ユーザーに許可される提出[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]CURRENT_LIFECYCLE[/NAME][ALIAS]現在のライフサイクル[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]

	[CCM_ATTRIBUTE][NAME]IS_ADMIN[/NAME][ALIAS]Admin である[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]licensed_dcmpt[/NAME][ALIAS]ライセンス情報[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]licensed_xpt[/NAME][ALIAS]ライセンス情報[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]licensed_grpsec[/NAME][ALIAS]ライセンス情報[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	
	***************** 特殊 ACcent 属性 *****************
	
	[CCM_ATTRIBUTE][NAME]_COMMENTS[/NAME][ALIAS]コメント[/ALIAS][TYPE]CCM_TEXT[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]_DUPLICATE[/NAME][ALIAS]重複[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]_CREATE_TASK[/NAME][ALIAS]タスク作成[/ALIAS][TYPE]CCM_TOGGLE[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]_IS_MODIFIABLE[/NAME][ALIAS]オブジェクトは変更可能[/ALIAS][TYPE]CCM_TOGGLE[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]IS_MODIFIABLE[/NAME][ALIAS]オブジェクトは変更可能[/ALIAS][TYPE]CCM_TOGGLE[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]has_duplicate[/NAME][ALIAS]CR 重複[/ALIAS][TYPE]CCM_RELATION[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]attachment[/NAME][ALIAS]添付[/ALIAS][TYPE]CCM_RELATION[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]associated_task[/NAME][ALIAS]関連タスク[/ALIAS][TYPE]CCM_RELATION[/TYPE][/CCM_ATTRIBUTE]
	
	***************** 特殊 IBM Rational Change 識別子 *****************
	
	[CCM_ATTRIBUTE][NAME]_ATTACHMENT_NAME[/NAME][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]_ATTACHMENT_COMMENT[/NAME][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]_ATTACHMENT_IS_BINARY[/NAME][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]_ATTACHMENT_IS_ASCII[/NAME][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]_ATTACHMENT_TYPE[/NAME][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]START_HERE[/NAME][ALIAS]フォームの提出[/ALIAS][TYPE]CCM_VALUELISTBOX[/TYPE][/CCM_ATTRIBUTE]
	
	***************** テキスト置換変数 *****************
	
	[CCM_ATTRIBUTE][NAME]ChangeRequestProcessImage[/NAME][ALIAS]no_cr_process.gif[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	
	***************** テキスト置換変数 *****************
	
	[CCM_ATTRIBUTE][NAME]Problem_Identifier[/NAME][ALIAS]変更依頼[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]Problem_Identifier_Plural[/NAME][ALIAS]変更依頼[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]Problem_Identifier_Abbr[/NAME][ALIAS]CR[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	
	***************** テキスト置換変数 *****************
	
	[CCM_ATTRIBUTE][NAME]DUPLICATE[/NAME][ALIAS]CR 重複[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]QUERY_STRING[/NAME][ALIAS]クエリー・ストリング[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]cr_modifications[/NAME][ALIAS]変更イベントの表示[/ALIAS][TYPE]CCM_TOGGLE[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]cr_transitions[/NAME][ALIAS]遷移コメントの表示[/ALIAS][TYPE]CCM_TOGGLE[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]cr_notes[/NAME][ALIAS]注記の表示[/ALIAS][TYPE]CCM_TOGGLE[/TYPE][/CCM_ATTRIBUTE]
	
	***************** ユーティリティー *****************
	
	[CCM_ATTRIBUTE][NAME]TRANSITION_USER[/NAME][ALIAS]遷移ユーザー[/ALIAS][TYPE]CCM_LISTBOX[/TYPE][/CCM_ATTRIBUTE]
	
	***************** プロファイル属性 *****************
	
	[CCM_ATTRIBUTE][NAME]report_window_target[/NAME][ALIAS]レポート・ウィンドウ・ターゲット[/ALIAS][TYPE]CCM_VALUELISTBOX[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]report_link_target[/NAME][ALIAS]レポート・リンク・ターゲット[/ALIAS][TYPE]CCM_VALUELISTBOX[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]fontsize[/NAME][ALIAS]フォント・サイズ[/ALIAS][TYPE]CCM_LISTBOX[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]user_default_home_page[/NAME][ALIAS]レポート・リンク・ターゲット[/ALIAS][TYPE]CCM_LISTBOX[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]defaultReport[/NAME][ALIAS]デフォルト・レポート[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]reportIncremental[/NAME][ALIAS]インクリメンタル・レポート[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]reportIncrementalSize[/NAME][ALIAS]インクリメンタル・レポートのサイズ[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]object_scope[/NAME][ALIAS]オブジェクト・スコープ[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]object_scope_lifecycle[/NAME][ALIAS]オブジェクト・スコープ・ライフサイクル[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]cr_notes[/NAME][ALIAS]CR 注記[/ALIAS][TYPE]CCM_TOGGLE[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]cr_transitions[/NAME][ALIAS]CR 遷移[/ALIAS][TYPE]CCM_TOGGLE[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]cr_modifications[/NAME][ALIAS]CR 修正[/ALIAS][TYPE]CCM_TOGGLE[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]firstname[/NAME][ALIAS]ユーザーの名[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]lastname[/NAME][ALIAS]ユーザーの姓[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	
	***************** タスク属性 *****************
	
	[CCM_ATTRIBUTE][NAME]task_subsys[/NAME][ALIAS]タスク・サブシステム[/ALIAS][TYPE]CCM_LISTBOX[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]task_description[/NAME][ALIAS]詳細[/ALIAS][TYPE]CCM_TEXT[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]priority[/NAME][ALIAS]優先度[/ALIAS][TYPE]CCM_LISTBOX[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]est_completion_date[/NAME][ALIAS]完了予定日[/ALIAS][TYPE]CCM_DATE[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]est_duration[/NAME][ALIAS]予定所要時間[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]actual_duration[/NAME][ALIAS]実際の所要時間[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]registration_date[/NAME][ALIAS]登録日[/ALIAS][TYPE]CCM_DATE[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]completion_date[/NAME][ALIAS]完了日[/ALIAS][TYPE]CCM_DATE[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]asgndate_begin[/NAME][ALIAS]後に割り当て[/ALIAS][TYPE]CCM_DATE[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]asgndate_end[/NAME][ALIAS]前に割り当て[/ALIAS][TYPE]CCM_DATE[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]compdate_begin[/NAME][ALIAS]後に完了[/ALIAS][TYPE]CCM_DATE[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]compdate_end[/NAME][ALIAS]前に完了[/ALIAS][TYPE]CCM_DATE[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]completed_id[/NAME][ALIAS]完了 ID[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]completed_in[/NAME][ALIAS]完了[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]assigner[/NAME][ALIAS]割り当て者[/ALIAS][TYPE]CCM_USER[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]resolver[/NAME][ALIAS]解決者[/ALIAS][TYPE]CCM_USER[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]assignment_date[/NAME][ALIAS]割り当て日時[/ALIAS][TYPE]CCM_DATE[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]release[/NAME][ALIAS]リリース[/ALIAS][TYPE]CCM_LISTBOX[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]keyword[/NAME][ALIAS]キーワード[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	
	***************** オブジェクト属性 *****************
	
	[CCM_ATTRIBUTE][NAME]owner[/NAME][ALIAS]オブジェクトの所有者[/ALIAS][TYPE]CCM_USER[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]subsystem[/NAME][ALIAS]サブシステム[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]

	[CCM_ATTRIBUTE][NAME]version[/NAME][ALIAS]オブジェクト・バージョン[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]type[/NAME][ALIAS]オブジェクト・タイプ[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]description[/NAME][ALIAS]フォルダーの説明[/ALIAS][TYPE]CCM_TEXT[/TYPE][/CCM_ATTRIBUTE]
	
	***************** テキスト置換変数 *****************
	
	[CCM_ATTRIBUTE][NAME]ASSOCIATED_TASK[/NAME][ALIAS]関連タスク[/ALIAS][TYPE]CCM_STRING[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]associated_cv[/NAME][ALIAS]関連オブジェクト[/ALIAS][TYPE]CCM_RELATION[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]has_associated_task[/NAME][ALIAS]関連 CR[/ALIAS][TYPE]CCM_RELATION[/TYPE][/CCM_ATTRIBUTE]
	
	***************** ユーティリティー *****************
	
	[CCM_ATTRIBUTE][NAME]TASKSTATES[/NAME][ALIAS]タスクの状態[/ALIAS][TYPE]CCM_LISTBOX[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]TASK_DATABASE[/NAME][ALIAS]タスク・データベース[/ALIAS][TYPE]CCM_LISTBOX[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]all_releases[/NAME][ALIAS]すべてのリリース[/ALIAS][TYPE]CCM_LISTBOX[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]inactive_releases[/NAME][ALIAS]非アクティブ・リリース[/ALIAS][TYPE]CCM_LISTBOX[/TYPE][/CCM_ATTRIBUTE]
	[CCM_ATTRIBUTE][NAME]active_releases[/NAME][ALIAS]アクティブ・リリース[/ALIAS][TYPE]CCM_LISTBOX[/TYPE][/CCM_ATTRIBUTE]

IBM Rational Change 属性は以下のとおりです。

	[CCM_ATTRIBUTE]
		[NAME]
			IBM Rational Change 属性名。
		[/NAME]
		[TYPE]
ウェブ可視化データ・タイプ。
使用できるタイプは CCM_STRING、CCM_TEXT、CCM_LISTBOX、
および CCM_VALUELISTBOX。
		[/TYPE]
		[INTERFACE NAME]
			オプションのインターフェース・ベースのエイリアス。
			インターフェースと同数のインターフェース・オプションが存在します。
			ここで、「INTERFACE NAME」と「/INTERFACE NAME」はリテラルのインターフェース名です。
		[/INTERFACE NAME]...
		[ALIAS]
			この属性のデフォルトのエイリアス値。インターフェース・オプションを使用しない場合、またはユーザーのインターフェースが指定されていない場合、この値が返されます。
[ALIAS] タグ・セットはデフォルトを定義します。[ALIAS] タグが存在しない場合、[NAME] が返されます。
		[/ALIAS]
	[/CCM_ATTRIBUTE]

[NAME] は getName() メソッドによって識別されます。 [TYPE] は getType() メソッドによって識別されます。 [ALIAS] は getLabel() メソッドによって識別されます。 [INTERFACE NAME] オプションは、API からは利用できません。

返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー          cfgName : 新規属性を定義する新規構成ファイルの名前。
	                          拡張子「.cfg」は自動的に追加されます。
	apiObjectVector attrData: API 関数によって処理されるデータ。

 戻り値: apiData
	サーバーからのリターン・メッセージ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $attrData = new ChangeSynergy::apiObjectVector();
		my $objData = new ChangeSynergy::apiObjectData();
		$objData->setName("cost");
		$objData->setType("CCM_STRING");
		$objData->setLabel("Cost");
		$attrData->addDataObject($objData);
		my $objData = new ChangeSynergy::apiObjectData();
		$objData->setName("customer_priority");
		$objData->setType("CCM_LISTBOX");
		$objData->setLabel("Customer Priority");
		$attrData->addDataObject($objData);
		my $objData = new ChangeSynergy::apiObjectData();

		$objData->setName("version_fixed");
		$objData->setType("CCM_STRING");
		$objData->setLabel("Version Fixed");
		$attrData->addDataObject($objData);
		$tmp = $csapi->SetAttributes($aUser, "api_attributes", $attrData);
		print $tmp->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
setFolderSecurityRule

指定されたフォルダーのフォルダー・セキュリティー情報を設定します。フォルダー・セキュリティー情報は、フォルダー名、読み取りセキュリティー・メンバー、および書き込みセキュリティー・メンバーで構成されます。 リーダーもライターも持たないフォルダー名を指定することで、ルールを空にすることもできます。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	FolderSecurityrule folderRule : フォルダーのフォルダー・セキュリティー・ルール・オブジェクト。
	スカラー  objectType : フォルダーのオブジェクト・タイプ。
	スカラー  formatType : フォルダーのフォーマット・タイプ: レポート、クエリーまたはレポート・フォーマット。
	スカラー             configType : レポートの構成場所。
 戻り値: apiData

	更新の成功または失敗に関するメッセージを含む apiData。
 
 例:
 

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\angler\\ccmdb\\cm_database");


		my $globals = new ChangeSynergy::Globals();
		
		#Get the folder security rule for the "all" CR Shared query folder.

		my $folderRule = $csapi->getFolderSecurityRule($aUser, "", $globals->{PROBLEM_TYPE}, $globals->{QUERY},
						 $globals->{SHARED_PROFILE});
		
		$folderRule->addReadMember("someone");
		$folderRule->addWriteMember("someone else");
		

		my $result = $csapi->setFolderSecurityRule($aUser, $folderRule, $globals->{PROBLEM_TYPE}, $globals->{QUERY}, $globals->{SHARED_PROFILE});
		print $result->getResponseData() . "\n";
	};
	if ($@)
	{
		print $@;
	}
setQueryConfigType

クエリー実行時に使用する config タイプを設定します。 指定できる config タイプには、user、shared、system および all の 4 つがあります。 user config タイプは、ユーザーが保存した情報のみを検索します。 shared config タイプは shared config のみを検索し、system は system config のみを検索します。 All は user、次に shared、最後に system config を検索し、要求に合致した最初のクエリーを実行します。

 パラメーター:
	スカラー configType: クエリーから検索する config エントリー。
	

有効な Config タイプ: Globals クラスで定義されます。
        $self->{ALL}       // User、Shared および System。 検出した最初の 1 つを返します。
        $self->{USER_PROFILE}	// 1 人のユーザー・プロファイル・データ。
        $self->{SHARED_PROFILE} // 共有プロファイル・データ。
	    $self->{SYSTEM_CONFIG}  // システム config データ。
 例:
	my $csapi = new ChangeSynergy::csapi();
 	eval
	{


		my $globals = new ChangeSynergy::Globals();
		
		$csapi->setUpConnection("http://your_hostname:port/your_context");

		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
				
		#set the config type for the query.
 		$csapi->setQueryConfigType($globals->{USER_PROFILE});
 		or
 		$csapi->setQueryConfigType($globals->{SHARED_PROFILE});
 		or
 		$csapi->setQueryConfigType($globals->{SYSTEM_CONFIG});
 		or
 		$csapi->setQueryConfigType($globals->{ALL});
 		
 		#set the config type for the report format.
 		$csapi->setReportConfigType($globals->{USER_PROFILE});
 		or
 		$csapi->setReportConfigType($globals->{SHARED_PROFILE});
 		or
 		$csapi->setReportConfigType($globals->{SYSTEM_CONFIG});
 		or
 		$csapi->setReportConfigType($globals->{ALL});
	

		my $tmpstr = $csapi->ImmediateReportHtml($aUser, "Basic Summary", "Basic Summary Report");
 		
	};
	if ($@)
	{
		print $@;
	}
setReportConfigType

レポート実行時に使用する config タイプを設定します。 指定できる config タイプには、user、shared、system および all の 4 つがあります。 user config タイプは、ユーザーが保存した情報のみを検索します。 shared config タイプは shared config のみを検索し、system は system config のみを検索します。 All は user、次に shared、最後に system config を検索し、要求に合致した最初のレポートを実行します。

 パラメーター:
	スカラー configType: レポートから検索する config エントリー。
	

	有効な Config タイプ: Globals クラスで定義されます。
		$self->{ALL}       		// User、Shared および System。検出した最初の 1 つを返します。
		$self->{USER_PROFILE}	// 1 人のユーザー・プロファイル・データ。
		$self->{SHARED_PROFILE} // 共有プロファイル・データ。
		$self->{SYSTEM_CONFIG}  // システム config データ。
 例:
	my $csapi = new ChangeSynergy::csapi();
 	eval
	{


		my $globals = new ChangeSynergy::Globals();
		
		$csapi->setUpConnection("http://your_hostname:port/your_context");

		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		
		
		#set the config type for the report.
 		$csapi->setReportConfigType($globals->{USER_PROFILE});
 		or
 		$csapi->setReportConfigType($globals->{SHARED_PROFILE});
 		or
 		$csapi->setReportConfigType($globals->{SYSTEM_CONFIG});
 		or
 		$csapi->setReportConfigType($globals->{ALL});
	

		my $tmpstr = $csapi->ImmediateReportHtml($aUser, "Basic Summary", "Basic Summary Report");
 		
	};
	if ($@)
	{
		print $@;
	}
setUpConnection

API 関数を呼び出すための接続情報を設定します。

 パラメーター:
	スカラー URL: アプリケーションの URL。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
	};
	if ($@)
	{
		print $@;
	}
ShowCRHtml

変更依頼の詳細を HTML ウェブ・ページとして表示します。 IBM Rational Change サーバーはどのテンプレートを使用するかを決定します。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な HTML ページです。<HTML>...</HTML>
       戻り値は .html ファイルとして保存、またはブラウザーの window/control にロードすることができます。
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  problemNumber : 参照する変更依頼 ID/問題番号 ID。
	スカラー relationName: 有効な IBM Rational Synergy/IBM Rational Change 関連名。
	スカラー  isModifiable : 次のいずれかの文字列表現: ["true"|"false"]。
 戻り値: apiData

	HTML ページ形式での完全な表示フォーム。
 例:
 

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ShowCRHtml($aUser, "1347", "child_cr", "true");
	};
	if ($@)
	{
		print $@;
	}
ShowCRHtml

変更依頼の詳細を HTML ウェブ・ページとして表示します。 IBM Rational Change サーバーは提供されたテンプレート名を使用します。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な HTML ページです。<HTML>...</HTML>
       戻り値は .html ファイルとして保存、またはブラウザーの window/control にロードすることができます。
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  problemNumber : 参照する変更依頼 ID/問題番号 ID。
	スカラー  templateName : ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
	スカラー relationName: 有効な IBM Rational Synergy/IBM Rational Change 関連名。
	スカラー  isModifiable : 次のいずれかの文字列表現: ["true"|"false"]。

戻り値: apiData HTML ページ形式での完全な表示フォーム。

 例:
 

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ShowCRHtml($aUser, "1347", "CRDetail", undef, undef);
	};
	if ($@)
	{
		print $@;
	}
ShowCRUrl

変更依頼の詳細を HTML ウェブ・ページとして表示します。 IBM Rational Change サーバーはどのテンプレートを使用するかを決定します。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な URL アドレスです。
       戻り値はリンクとして保存、またはブラウザーの window/control にロードすることができます。
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  problemNumber : 参照する変更依頼 ID/問題番号 ID。
	スカラー relationName: 有効な IBM Rational Synergy/IBM Rational Change 関連名。
	スカラー  isModifiable : 次のいずれかの文字列表現: ["true"|"false"]。
 戻り値: apiData

	HTML ページ形式での完全な表示フォーム。
 例:
 

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ShowCRUrl($aUser, "1347", "child_cr", "true");
	};
	if ($@)
	{
		print $@;
	}
ShowCRUrl

変更依頼の詳細を HTML ウェブ・ページとして表示します。 IBM Rational Change サーバーは提供されたテンプレート名を使用します。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な URL アドレスです。
       戻り値はリンクとして保存、またはブラウザーの window/control にロードすることができます。
 
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  problemNumber : 参照する変更依頼 ID/問題番号 ID。
	スカラー  templateName : ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
	スカラー relationName: 有効な IBM Rational Synergy/IBM Rational Change 関連名。
	スカラー  isModifiable : 次のいずれかの文字列表現: ["true"|"false"]。

戻り値: apiData URL アドレス形式の表示フォーム。

 例:
 

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ShowCRUrl($aUser, "1347", "CRDetail", undef, undef);
	};
	if ($@)
	{
		print $@;
	}
ShowTaskHtml

タスクの詳細を HTML ウェブ・ページとして表示します。 IBM Rational Change サーバーは、タスクの現在の状態値に基づいて、どのテンプレートを使用するかを決定します。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な HTML ページです。<HTML>...</HTML>
       戻り値は .html ファイルとして保存、またはブラウザーの window/control にロードすることができます。
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー taskNumber   : 参照するタスク ID。
	スカラー  relationName: 有効な IBM Rational Synergy/IBM Rational Change 関係名。
	スカラー  isModifiable : 次のいずれかの文字列表現: ["true"|"false"]。
 戻り値: apiData

	HTML ページ形式のタスク詳細表示ページ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ShowTaskHtml($aUser, "1", undef, undef);
	};
	if ($@)
	{
		print $@;
	}
ShowTaskHtml

タスクの詳細を HTML ウェブ・ページとして表示します。 IBM Rational Change サーバーは提供されたテンプレート名を使用します。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な HTML ページです。<HTML>...</HTML>
       戻り値は .html ファイルとして保存、またはブラウザーの window/control にロードすることができます。
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー taskNumber   : 参照するタスク ID。
	スカラー templateName : ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
	スカラー  relationName: 有効な IBM Rational Synergy/IBM Rational Change 関係名。
	スカラー  isModifiable : 次のいずれかの文字列表現: ["true"|"false"]。
 戻り値: apiData

	HTML ページ形式のタスク詳細表示ページ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ShowTaskHtml($aUser, "1", "TaskDetails", undef, undef);
	};
	if ($@)
	{
		print $@;
	}
ShowTaskUrl

タスクの詳細を HTML ウェブ・ページとして表示します。 IBM Rational Change サーバーは、タスクの現在の状態値に基づいて、どのテンプレートを使用するかを決定します。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な URL アドレスです。
       戻り値はリンクとして保存、またはブラウザーの window/control にロードすることができます。
 
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー taskNumber   : 参照するタスク ID。
	スカラー  relationName: 有効な IBM Rational Synergy/IBM Rational Change 関係名。
	スカラー  isModifiable : 次のいずれかの文字列表現: ["true"|"false"]。
 戻り値: apiData

	タスク詳細表示ページの URL。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ShowTaskUrl($aUser, "1", undef, undef);
	};
	if ($@)
	{
		print $@;
	}
ShowTaskUrl

タスクの詳細を HTML ウェブ・ページとして表示します。 IBM Rational Change サーバーは提供されたテンプレート名を使用します。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な URL アドレスです。
       戻り値はリンクとして保存、またはブラウザーの window/control にロードすることができます。
 
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー taskNumber   : 参照するタスク ID。
	スカラー templateName : ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
	スカラー  relationName: 有効な IBM Rational Synergy/IBM Rational Change 関係名。
	スカラー  isModifiable : 次のいずれかの文字列表現: ["true"|"false"]。
 戻り値: apiData

	タスク詳細表示ページの URL。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ShowTaskUrl($aUser, "1", "TaskDetails", undef, undef);
	};
	if ($@)
	{
		print $@;
	}
StartServerAccess

IBM Rational Change サーバーでサーバー・アクセスを再起動します。

これは、通常は明示的に呼び出す必要のない下位レベルの API です。 サーバー・アクセスをブロックする必要のある操作 (構成データの更新やセッション・プールの管理など) が、既に内部的にこの操作を行っています。しかし、データベース保守の発生時など、他の理由でサーバー・アクセスをブロックするために、これらの API を使用できます。

StartServerAccess と StopServerAccess は、スタック・モデルに基づいて機能します。StopServerAccess の呼び出しごとに、対応する StartServerAccess が必要になります。 例えば、StopServerAccess を続けて 2 回呼び出した場合は、StartServerAccess も同様に 2 回呼び出して、サーバー・アクセスを復旧する必要があります。

返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->StartServerAccess($aUser);
	};
	if ($@)
	{
		print $@;
	}
StopServerAccess

IBM Rational Change サーバーでサーバー・アクセスを停止します。

これは、通常は明示的に呼び出す必要のない下位レベルの API です。 サーバー・アクセスをブロックする必要のある操作 (構成データの更新やセッション・プールの管理など) が、既に内部的にこの操作を行っています。しかし、データベース保守の発生時など、他の理由でサーバー・アクセスをブロックするために、これらの API を使用できます。

StartServerAccess と StopServerAccess は、スタック・モデルに基づいて機能します。StopServerAccess の呼び出しごとに、対応する StartServerAccess が必要になります。 例えば、StopServerAccess を続けて 2 回呼び出した場合は、StartServerAccess も同様に 2 回呼び出して、サーバー・アクセスを復旧する必要があります。

返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->StopServerAccess($aUser);
	};
	if ($@)
	{
		print $@;
	}
SubmitCR

修正した変更依頼データを適用します。 修正済みというフラグの付いたデータ・オブジェクトだけが IBM Rational Change サーバーに送信されます。 属性 problem_number、modify_time、および cvid は変更してはなりません。 これらの属性は、API クラスが必要に応じて自動処理します。 返される結果は apiData クラスのインスタンスです。

注記: apiObjectData のメンバーのメソッド setValue("") は、起動されると、修正済みフラグを自動的に設定します。

 パラメーター:
	apiUser aUser:      現在の API ユーザーのログイン・データ。
	apiObjectVector data         : API 関数によって処理されるデータ。
 
 戻り値: apiData
	提出が正常に終了したかどうかの結果のみ。 例:
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->SubmitCRData($aUser, "START_HERE2entered");
		my $i;

		my $j = $tmp->getDataSize();
		for($i=0;$i<$j;$i++)
		{
			if($tmp->getDataObject($i)->getRequired())
			{
				$tmp->getDataObject($i)->setValue("I must supply a value here to successfully complete a submit...");
			}
		}
		$tmp->getDataObjectByName("problem_synopsis")->setValue("I submitted this through the csapi");
		$tmp->getDataObjectByName("problem_description")->setValue("Yes, isn't this great!!!!");
		$tmp->getDataObjectByName("severity")->setValue("Showstopper");
		$tmp->getDataObjectByName("product_name")->setValue("Product A");
		$tmp->getDataObjectByName("submitter")->setValue("u00001");
		$tmp->getDataObjectByName("request_type")->setValue("Defect");
		$tmp->getDataObjectByName("crstatus")->setValue($tmp->getTransitionLink(0)->getToState());
		

		my $tmpstr = $csapi->SubmitCR($aUser, $tmp);
	};
	if ($@)
	{
		print $@;
	}
SubmitCRAssocCR

修正した変更依頼データを適用します。 修正済みというフラグの付いたデータ・オブジェクトだけが IBM Rational Change サーバーに送信されます。属性 problem_number、modify_time、および cvid は変更してはなりません。 これらの属性は、API クラスが必要に応じて自動処理します。 返される結果は apiData クラスのインスタンスです。

注記: apiObjectData のメンバーのメソッド setValue("") は、起動されると、修正済みフラグを自動的に設定します。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	apiObjectVector data         : API 関数によって処理されるデータ。
	スカラー relationName: 有効な IBM Rational Synergy/IBM Rational Change 関連名。
	スカラー problemNumber : 参照する変更依頼 ID/問題番号 ID。

 戻り値: apiData
	提出と関連付けが正常に終了したかどうかの結果のみ。例 1:

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->SubmitCRData($aUser, "START_HERE2entered");
		my $i;

		my $j = $tmp->getDataSize();
		for($i=0;$i<$j;$i++)
		{
			if($tmp->getDataObject($i)->getRequired())
			{
				$tmp->getDataObject($i)->setValue("I must supply a value here to successfully complete a submit...");
			}
		}
		$tmp->getDataObjectByName("problem_synopsis")->setValue("I submitted this through the csapi");
		$tmp->getDataObjectByName("problem_description")->setValue("Yes, isn't this great!!!!");
		$tmp->getDataObjectByName("severity")->setValue("Showstopper");
		$tmp->getDataObjectByName("product_name")->setValue("Product A");
		$tmp->getDataObjectByName("submitter")->setValue($aUser->getUserName());
		$tmp->getDataObjectByName("request_type")->setValue("Defect");
		$tmp->getDatagetDataObjectByNameObject("crstatus")->setValue($tmp->getTransitionLink(0)->getToState());
		
		$tmpstr = $csapi->SubmitCRAssocCR($aUser, $tmp, "child_cr", "1347");
	};
	if ($@)
	{
		print $@;
	}
 例 2:
 

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->CopyCRData($aUser, "1347", "COPY_child_cr2new_child");
		my $i;

		my $j = $tmp->getDataSize();
		for($i=0;$i<$j;$i++)
		{
			if($tmp->getDataObject($i)->getRequired())
			{
				$tmp->getDataObject($i)->setValue("I must supply a value here to successfully complete a submit...");
			}
			if($tmp->getDataObject($i)->getInherited())
			{
				$tmp->getDataObject($i)->setIsModified(TRUE);
			}
		}
		$tmp->getDataObjectByName("problem_synopsis")->setValue("I submitted this through the csapi");
		$tmp->getDataObjectByName("problem_description")->setValue("Yes, isn't this great!!!!");
		$tmp->getDataObjectByName("severity")->setValue("Showstopper");
		$tmp->getDataObjectByName("product_name")->setValue("Product A");
		$tmp->getDataObjectByName("submitter")->setValue("u00001");
		$tmp->getDataObjectByName("request_type")->setValue("Defect");
		$tmp->getDataObject("crstatus")->setValue($tmp->getTransitionLink(0)->getToState());
		

		my $tmpstr = $csapi->SubmitCRAssocCR($aUser, $tmp, $tmp->getTransitionLink(0)->getRelation(), "1347");
	};
	if ($@)
	{
		print $@;
	}
SubmitCRData

変更依頼提出の要件を、新しい変更依頼の詳細の修正が可能なデータ・クラスにロードします。 修正されたデータ・クラスは、変更依頼を変更するために、修正 API 関数の 1 つを使って提出できます。 返される結果は apiObjectVector クラスのインスタンスです。 注記: 発行の「to 状態」(to state) はこの API 関数呼び出しで提供されます。 apiTransitions クラスの説明を参照してください。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  templateName: ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
 戻り値: apiObjectVector
	データ形式の CR 提出の要件。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->SubmitCRData($aUser, "START_HERE2entered");
		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
SubmitCRHtml

変更依頼を提出するための要件を HTML ウェブ・ページとしてロードします。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な HTML ページです。<HTML>...</HTML>
       戻り値は .html ファイルとして保存、またはブラウザーの window/control にロードすることができます。
	   
パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー templateName : ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
	スカラー  problemNumber : 参照する変更依頼 ID/問題番号 ID。
	スカラー relationName: 有効な IBM Rational Synergy/IBM Rational Change 関連名。
	スカラー externalData : 提出依頼に渡される XML データの文字列。
  外部データ XML のフォーマット:
 
 <EXTERNAL_CONTEXT_DATA>
 	<ATTRIBUTE NAME="attribute_name">your value</ATTRIBUTE>
 	<ATTRIBUTE NAME="attribute_name">your value</ATTRIBUTE>
 	<ATTRIBUTE NAME="attribute_name">your value</ATTRIBUTE>
 	.
 	.
 	.
 </EXTERNAL_CONTEXT_DATA>
 
 戻り値: apiData
	HTML ページ形式の要求された CR 提出ページ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->SubmitCRHtml($aUser, "CRSubmit", undef, undef, undef);
	};
	if ($@)
	{
		print $@;
	}
SubmitCRUrl

変更依頼を提出するための要件を HTML ウェブ・ページとしてロードします。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な URL アドレスです。
       戻り値はリンクとして保存、またはブラウザーの window/control にロードすることができます。
 	   
パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  templateName : ロード対象の IBM Rational Change テンプレートの名前: ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
	スカラー  problemNumber : 参照する変更依頼 ID/問題番号 ID。
	スカラー relationName: 有効な IBM Rational Synergy/IBM Rational Change 関連名。
	スカラー externalData : 提出依頼に渡される XML データの文字列。
  外部データ XML のフォーマット:
 
 <EXTERNAL_CONTEXT_DATA>
 	<ATTRIBUTE NAME="attribute_name">your value</ATTRIBUTE>
 	<ATTRIBUTE NAME="attribute_name">your value</ATTRIBUTE>
 	<ATTRIBUTE NAME="attribute_name">your value</ATTRIBUTE>
 	.
 	.
 	.
 </EXTERNAL_CONTEXT_DATA>
 
 戻り値: apiData
	HTML ページ形式の要求された CR 提出ページ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->SubmitCRUrl($aUser, "CRSubmit", undef, undef, undef);
	};
	if ($@)
	{
		print $@;
	}
SubmitTask

修正したタスク・データを適用します。 修正済みというフラグの付いたデータ・オブジェクトだけが IBM Rational Change サーバーに送信されます。属性 task_number、modify_time、および cvid は変更してはなりません。 これらの属性は、API クラスが必要に応じて自動処理します。 返される結果は apiData クラスのインスタンスです。

注記: apiObjectData のメンバーのメソッド setValue("") は、起動されると、修正済みフラグを自動的に設定します。

 パラメーター:
	apiUser aUser:      現在の API ユーザーのログイン・データ。
	apiObjectVector data : API 関数によって処理されるデータ。
 戻り値: apiData

	提出が正常に終了したかどうかの結果のみ。
 例 1:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->SubmitTaskData($aUser, "TaskCreate");
		

		my $i;

		my $j = $tmp->getDataSize();
		for($i=0;$i<$j;$i++)
		{
			if($tmp->getDataObject($i)->getRequired())
			{
				$tmp->getDataObject($i)->setValue("I must supply a value here to successfully complete a submit...");
			}
		}
		$tmp->getDataObjectByName("task_synopsis")->setValue("I modified the synopsis through the csapi...");
		$tmp->getDataObjectByName("task_description")->setValue("I modified the description through the csapi...");
		$tmp->getDataObjectByName("priority")->setValue("high");
		$tmp->getDataObjectByName("resolver")->setValue($aUser->getUserName());
		my $tmpstr = $csapi->SubmitTask($aUser, $tmp);
	};
	if ($@)
	{
		print $@;
	}
 例 2:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->CopyTaskData($aUser, "12", "CreateTask");
		

		my $i;

		my $j = $tmp->getDataSize();
		for($i=0;$i<$j;$i++)
		{
			if($tmp->getDataObject($i)->getRequired())
			{
				if($tmp->getDataObject($i)->getValue() == NULL)
					$tmp->getDataObject($i)->setValue("I must supply a value here to successfully complete a submit...");
			}
		}
		$tmp->getDataObjectByName("task_synopsis")->setValue("I modified the synopsis through the csapi...");
		$tmp->getDataObjectByName("task_description")->setValue("I modified the description through the csapi...");
		$tmp->getDataObjectByName("priority")->setValue("high");
		$tmp->getDataObjectByName("resolver")->setValue($aUser->getUserName());
		my $tmpstr = $csapi->SubmitTask($aUser, $tmp);
	};
	if ($@)
	{
		print $@;
	}
SubmitTaskAssocCR

修正したタスク・データを適用します。 修正済みというフラグの付いたデータ・オブジェクトだけが IBM Rational Change サーバーに送信されます。属性 task_number、modify_time、および cvid は変更してはなりません。 これらの属性は、API クラスが必要に応じて自動処理します。 返される結果は apiData クラスのインスタンスです。

注記: apiObjectData のメンバーのメソッド setValue("") は、起動されると、修正済みフラグを自動的に設定します。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	apiObjectVector data         : API 関数によって処理されるデータ。
	スカラー relationName: 有効な IBM Rational Synergy/IBM Rational Change 関連名。
	スカラー problemNumber : 参照する変更依頼 ID/問題番号 ID。
 戻り値: apiData

	提出と関連付けが正常に終了したかどうかの結果のみ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->SubmitTaskData($aUser, "TaskCreate");
		

		my $i;

		my $j = $tmp->getDataSize();
		for($i=0;$i<$j;$i++)
		{
			if($tmp->getDataObject($i)->getRequired())
			{
				$tmp->getDataObject($i)->setValue("I must supply a value here to successfully complete a submit...");
			}
		}
		$tmp->getDataObjectByName("task_synopsis")->setValue("I modified the synopsis through the csapi...");
		$tmp->getDataObjectByName("task_description")->setValue("I modified the description through the csapi...");
		$tmp->getDataObjectByName("priority")->setValue("high");
		$tmp->getDataObjectByName("resolver")->setValue($aUser->getUserName());
		my $tmpstr = $csapi->SubmitTaskAssocCR($aUser, $tmp, "associated_task", "1355");
	};
	if ($@)
	{
		print $@;
	}
SubmitTaskData

タスク提出の要件を、新しいタスクの詳細の修正が可能なデータ・クラスにロードします。 修正されたデータ・クラスは、タスクを変更する修正 API 関数の 1 つを使って提出できます。 返される結果は apiObjectVector クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  templateName: ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
 戻り値: apiObjectVector
	データ形式のタスク提出の要件。
 例:
 

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->SubmitTaskData($aUser, "TaskCreate");
		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
SubmitTaskHtml

タスクを提出するための要件を HTML ウェブ・ページとしてロードします。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な HTML ページです。<HTML>...</HTML>
       戻り値は .html ファイルとして保存、またはブラウザーの window/control にロードすることができます。
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー templateName : ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
 戻り値: apiData

	HTML ページ形式の要求されたタスク提出ページ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->SubmitTaskHtml($aUser, "TaskCreate");
	};
	if ($@)
	{
		print $@;
	}
SubmitTaskUrl

タスクを提出するための要件を HTML ウェブ・ページとしてロードします。 返される結果は apiData クラスのインスタンスです。

 注記: この戻り値は完全な URL アドレスです。
       戻り値はリンクとして保存、またはブラウザーの window/control にロードすることができます。
 
 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー templateName : ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
 戻り値: apiData

	タスク提出ページの URL。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->SubmitTaskUrl($aUser, "TaskCreate");
	};
	if ($@)
	{
		print $@;
	}
SwitchUser

ローカル・アドミン・ユーザーが任意のユーザーに切り替えられるようにします。 返される結果は apiUser クラスのインスタンスです。

 パラメーター:

    apiUser localAdminUser: ローカル・アドミン・ユーザーのログイン・データ。
	スカラー targetUserName : ターゲット・ユーザーの名前。
	スカラー targetRole     : ターゲット・ユーザーのロール。(Web クライアントでは、現在、この使用方法の「ロール」の代わりに「インターフェース」という用語が使用されています)
	スカラー targetDatabase : ユーザーの IBM Rational Synergy データベース・パス。
 戻り値: apiUser
指定した情報を持つ apiUser クラスの新しいインスタンス。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $localAdminUser = $csapi->Login("admin", "localAdminPassword", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		


		my $aTargetUser = $csapi->SwitchUser($localAdminUser, "u00002", "User", "\\\\your_hostname\\ccmdb\\cm_database");
	};
	if ($@)
	{
		print $@;
	}
SyncDatabase

セントラル・サーバー・モードで、セントラル・サーバーがすべての CR の特定データベースへの同期処理を終えるのを待機します。 セントラル CR は自動的に他のすべてのデータベースと同期されるため、この呼び出しは不要ですが、すべての中断状態の更新が完了するのを待つことができます。

たとえば、あるスクリプトが大量の CR を迅速に更新した場合、すべての変更が同期されるまでに時間がかかる可能性があります。 スクリプトで引き続いて実行される処理が特定のデータベースとセントラル・データベースの同期処理に依存する場合、いったん、最新データに同期された後、この関数呼び出しからリターンしてスクリプトは処理を続行できます。 スクリプトでこの関数を使うことですべての変更が同期されるのを待つ処理を作成できます。 この関数呼び出しの後で行われた変更は、待機状態に入っている場合でも、無視されます。

データベースがオンラインにもかかわらずしばらくの間どの CR も同期されない場合は、タイムアウトが発生します。 パラメーター:

	apiUser user:     現在の API ユーザーのログイン・データ。
	スカラー  database: 同期および待機の対象となるデータベース。オンライン状態のデータベースを指定する必要があります。
 
 戻り値:
	なし。同期が終わると戻り値なしで制御を戻します。保留中の更新がない場合は、即座に制御を戻します。
TaskFullName

タスクの 4 部構成名を取得します。タスクが実際に存在するかどうかはチェックしません。; タスクの 4 部構成名を構成するだけです。 パラメーター:

	apiUser aUser:      現在の API ユーザーのログイン・データ。
	スカラー taskNumber    : タスク番号。
 戻り値: スカラー
4 部構成名。
ToggleDebug

IBM Rational Change サーバーのデバッグ・フラグを切り換えます。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser:      現在の API ユーザーのログイン・データ。
	スカラー  enable: デバッグを有効にする場合は「true」、デバッグを無効にする場合は「false」。この
	                パラメーターはオプションです。指定しない場合、デバッグは
	                現在と反対の状態に切り替えられます (オンの場合はオフ、オフの場合はオン)。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $debugString = $csapi->ToggleDebug($aUser);
		or

		my $debugString = $csapi->ToggleDebug($aUser, "true");
		or

		my $debugString = $csapi->ToggleDebug($aUser, "false");
		
		print $debugString->getResponseData() . "\n";
	};
	if ($@)
	{
		print $@;
	}
TransitionCR

修正した変更依頼データを適用します。 修正済みというフラグの付いたデータ・オブジェクトだけが IBM Rational Change サーバーに送信されます。属性 problem_number、modify_time、および cvid は変更してはなりません。 これらの属性は、API クラスが必要に応じて自動処理します。 返される結果は apiData クラスのインスタンスです。 注記: apiObjectData のメンバーのメソッド setValue("") は、起動されると、修正済みフラグを自動的に設定します。

 パラメーター:
	apiUser aUser:      現在の API ユーザーのログイン・データ。
apiObjectVector data : API 関数によって処理されるデータ。
 戻り値: apiData

	遷移が正常に終了したかどうかの結果のみ。
 
 例:
 

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp1 = $csapi->AttributeModifyCRData($aUser, "100", "crstatus");
		or

		my $tmp1 = $csapi->AttributeModifyCRData($aUser, "100");
		or

		my $tmp1 = $csapi->ModifyCRData($aUser, "100", "CRDetail");
		or

		my $tmp1 = $csapi->GetCRData($aUser, "100", "problem_synopsis|problem_description|keyword");
		

		my $tmp2 = $csapi->TransitionCRData($aUser, "100", $tmp1->getTransitionLink(1)->getTransition());
		$tmp2->getDataObjectByName("problem_synopsis")->setValue("I modified the synopsis through the csapi...");
		$tmp2->getDataObjectByName("problem_description")->setValue("I modified the description through the csapi...");
		$tmp2->getDataObjectByName("keyword")->setValue("csapi");
  		$tmp2->getDataObjectByName("crstatus")->setValue($tmp1->getTransitionLink(1)->getToState());
		my $tmpstr = $csapi->TransitionCR($aUser, $tmp2);
	};
	if ($@)
	{
		print $@;
	}
TransitionCRData

変更依頼の詳細を、変更依頼の詳細の修正が可能なデータ・クラスにロードします。 修正されたデータ・クラスは、変更依頼を変更するために、修正 API 関数の 1 つを使って提出できます。 返される結果は apiObjectVector クラスのインスタンスです。

注記: 遷移の「from 状態」(from state) と「to 状態」(to state) はこの API 関数呼び出しで提供されます。 apiTransitions クラスの説明を参照してください。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  problemNumber : 参照する変更依頼 ID/問題番号 ID。
	スカラー templateName : ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
 戻り値: apiObjectVector
データ形式の変更依頼の詳細。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->TransitionCRData($aUser, "100", "assigned2resolved");
		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
TransitionTask

修正したタスク・データを適用します。 修正済みというフラグの付いたデータ・オブジェクトだけが IBM Rational Change サーバーに送信されます。属性 task_number、modify_time、および cvid は変更してはなりません。 これらの属性は、API クラスが必要に応じて自動処理します。

注記: apiObjectData のメンバーのメソッド setValue("") は、起動されると、修正済みフラグを自動的に設定します。

 パラメーター:
	apiUser aUser:      現在の API ユーザーのログイン・データ。
apiObjectVector data : API 関数によって処理されるデータ。
 戻り値: apiData

	遷移が正常に終了したかどうかの結果のみ。
 例:
 

	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->ModifyTaskData($aUser, "10", "TaskDetails");
		or

		my $tmp = $csapi->GetTaskData($aUser, "10", "task_synopsis|task_description|priority");
		or

		my $tmp = $csapi->TransitionTaskData($aUser, "10", "TaskDetails");
		
		$tmp->getDataObjectByName("task_synopsis")->setValue("I modified the synopsis through the csapi...");
		$tmp->getDataObjectByName("task_description")->setValue("I modified the description through the csapi...");
		$tmp->getDataObjectByName("priority")->setValue("high");
		$tmp->getDataObjectByName("status")->setValue("completed");
		my $tmpstr = $csapi->TransitionTask($aUser, $tmp);
	};
	if ($@)
	{
		print $@;
	}
TransitionTaskData

タスクの詳細を、タスクの詳細の修正が可能なデータ・クラスにロードします。 修正されたデータ・クラスは、タスクを変更する修正 API 関数の 1 つを使って提出できます。 返される結果は apiObjectVector クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー taskNumber   : 参照するタスク ID。
	スカラー  templateName: ロード対象の IBM Rational Change テンプレートの名前。
	                       ([CCM_TEMPLATE][NAME]template name[/NAME]...[/CCM_TEMPLATE])
 戻り値: apiObjectVector
	データ形式のタスクの詳細。
 例:
 

	my $csapi = new ChangeSynergy::csapi();
	
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->TransitionTaskData($aUser, "4", "TaskDetails");
		my $tmpstr = $tmp->getXmlData();
	};
	if ($@)
	{
		print $@;
	}
UninstallAPackage

IBM Rational Change パッケージをアンインストールします。 返される結果は apiData クラスのインスタンスです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  packageName : アンインストール対象のパッケージの名前。
 戻り値: apiData

	パッケージのアンインストールが正常に終了したかどうかの結果のみ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");	

		my $results = $csapi->UninstallAPackage($aUser, "dev_process");
		
		print $results->getResponseData();
	};
	if ($@)
	{
		print $@;
	}
UpdateIndex

検索索引の更新を、次にスケジュールされた期間が経過するまで待機せずに、要求時に実行します。 索引付けが無効化されている場合は、これによって索引付けの暗黙的な有効化も行われます (「EnableIndexing」および「DisableIndexing」を参照)。

 パラメーター:
	apiUser aUser: 現在の API ユーザーのログイン・データ。
 戻り値: apiData

	サーバーからのリターン・メッセージ。
 
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->UpdateIndex($aUser);
	};
	if ($@)
	{
		print $@;
	}
ValidateLicense

このライセンスを取得できるかどうかを確認します。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー licenseString: 確認対象のライセンス識別子。
 戻り値: スカラー
true または false
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->ValidateLicense($aUser, "pt");
	};
	if ($@)
	{
		print $@;
	}
VerifySignatures

指定した CCM_E_SIGNATURE 属性にある変更依頼の電子署名を確認します。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  problemNumber: 確認対象の問題番号。
	スカラー  attributeName: 電子署名の属性名。
 
戻り値: スカラー
true または false
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmp = $csapi->VerifySignatures($aUser, "1", "myEig");
	};
	if ($@)
	{
		print $@;
	}
ExportProjectSecurityData

プロジェクトのセキュリティー定義 (ロールおよびグローバル割り当てを含む) を、RDS から LDIF ファイル (CHANGE_APP_HOME/WEB-INF/wsconfig/tmpdir/import_<現在の日時>.ldif) にエクスポートします。 このファイルは、API ImportProjectSecurityData を通じてインポートできます。 この API を使用できるのは、Rational Change Admin ユーザーだけです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
 
 戻り値: apiData
	エクスポートの成功または失敗に関するメッセージ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ExportProjectSecurityData($aUser);
		print $tmpstr->getResponseData() . "\n";
	};
	if ($@)
	{
		print $@;
	}
ImportProjectSecurityData

ExportProjectSecurityData を通じて作成された LDIF ファイルから、Rational Change に接続された RDS にデータをインポートします。このファイルは、CHANGE_APP_HOME/WEB-INF/wsconfig/tmpdir に格納されている必要があります。 この API を使用できるのは、Rational Change Admin ユーザーだけです。

 パラメーター:
	apiUser aUser     : 現在の API ユーザーのログイン・データ。
	スカラー  importFileName: インポートする LDIF ファイルの名前。
	スカラー  isUpdate: データの更新/RDS への追加を実行する場合は「true」。
			RDS に新規データを追加するだけで、既存のデータを更新しない場合は「false」。
 
 戻り値: apiData
	インポートの成功または失敗に関するメッセージ。
 例:
	my $csapi = new ChangeSynergy::csapi();
	eval
	{
		$csapi->setUpConnection("http://your_hostname:port/your_context");
		my $aUser     = $csapi->Login("u00001", "u00001", "Admin", "\\\\your_hostname\\ccmdb\\cm_database");
		my $tmpstr = $csapi->ImportProjectSecurityData($aUser, "import_12_07_2010_12_41_12.ldif", true);
		print $tmpstr->getResponseData() . "\n";
	};
	if ($@)
	{
		print $@;
	}