システムテンプレートの属性情報を取得します。
リクエストパラメーター
パラメーター名 | 項目 | 項目説明 |
|---|---|---|
Version | 説明 | CFMG APIのバージョンID |
型 | string ASCII | |
設定内容 | 固定。「1.0」を指定してください。 | |
Locale | 説明 | CFMG APIと通信するための言語。ISO 639で規定されている言語コードを指定します。 |
型 | string ASCII | |
設定内容 | 以下から選択します。 | |
Action | 説明 | 実行するCFMG APIの名称 |
型 | string ASCII | |
設定内容 | 固定。「GetVSYSDescriptorAttributes」を指定してください。 | |
userId | 説明 | CFMG APIを実行するユーザーID |
型 | string ASCII | |
設定内容 | 31文字以内 | |
orgId | 説明 | CFMG APIを実行するユーザーの組織ID |
型 | string ASCII | |
設定内容 | 8文字以内 | |
vsysDescriptorId | 説明 | システムテンプレートID |
型 | string ASCII | |
設定内容 | 32文字以内 |
レスポンス
《ステータスコード》
正常に終了した場合に「200 OK」を返します。
《XML》
<?xml version="1.0" encoding="UTF-8"?>
<GetVSYSDescriptorAttributesResponse xmlns=~»http://apioviss.jp.fujitsu.com~»>
<responseMessage>[メッセージ]</responseMessage>
<responseStatus>[ステータス]</responseStatus>
<vsysdescriptor>
<creatorName>[システムテンプレートの作成者の組織ID]</creatorName>
<description>[システムテンプレートの説明]</description>
<registrant>[システムテンプレートの登録者]</registrant>
<vsysdescriptorId>[システムテンプレートID]</vsysdescriptorId>
<vsysDescriptorName>[システムテンプレート名]</vsysDescriptorName>
</vsysdescriptor>
</GetVSYSDescriptorAttributesResponse>《要素》
要素名 | 項目 | 項目説明 |
|---|---|---|
GetVSYSDescriptorAttributesResponse | 説明 | レスポンスの情報を持つ要素 |
型 | なし | |
出現回数 | 1 | |
responseMessage | 説明 | メッセージ。リクエストが正しく処理されたかどうかを表します。メッセージの詳細については、「付録A メッセージ」を参照してください。 |
型 | string UTF-8 | |
出現回数 | 1 | |
responseStatus | 説明 | ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。 |
型 | string ASCII | |
出現回数 | 1 | |
vsysdescriptor | 説明 | システムテンプレート情報のレスポンス情報を持つ要素 |
型 | なし | |
出現回数 | 0または1 | |
creatorName | 説明 | システムテンプレートの作成者の組織ID |
型 | string ASCII | |
出現回数 | 0または1 | |
description | 説明 | システムテンプレートの説明 |
型 | string UTF-8 | |
出現回数 | 0または1 | |
registrant | 説明 | システムテンプレートの登録者 |
型 | string UTF-8 | |
出現回数 | 0または1 | |
vsysdescriptorId | 説明 | システムテンプレートID |
型 | string ASCII | |
出現回数 | 0または1 | |
vsysdescriptorName | 説明 | システムテンプレート名 |
型 | string UTF-8 | |
出現回数 | 0または1 |
サンプルレスポンス
<?xml version="1.0" encoding="UTF-8"?>
<GetVSYSDescriptorAttributesResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
<responseMessage>PAPI00000 Processing was completed.</responseMessage>
<responseStatus>SUCCESS</responseStatus>
<vsysdescriptor>
<creatorName>adminorg</creatorName>
<description>テスト用のテンプレート</description>
<registrant>adminorg</registrant>
<vsysdescriptorId>template-0001</vsysdescriptorId>
<vsysdescriptorName>テストテンプレート</vsysdescriptorName>
</vsysdescriptor>
</GetVSYSDescriptorAttributesResponse>