2.2.7 GetLPlatformAttributes (L-Platformの属性を取得)

L-Platformの属性情報を取得します。

リクエストパラメーター

パラメーター名	項目	項目説明
Version	説明	L-Platform APIのバージョンID
	型	string ASCII
	設定内容	固定。"2.0"を指定してください。
Locale	説明	L-Platform APIと通信するための言語。ISO 639で規定されている言語コードを指定します。
	型	string ASCII
	設定内容	以下から選択します。・"ja": 日本語・"en": 英語
Action	説明	実行するL-Platform APIの名称
	型	string ASCII
	設定内容	固定。"GetLPlatformAttributes"を指定してください。
userId	説明	L-Platform APIを実行するユーザーID
	型	string ASCII
	設定内容	31文字以内
orgId	説明	L-Platform APIを実行するユーザーのテナント名
	型	string ASCII
	設定内容	32文字以内
lplatformId	説明	L-Platform ID
	型	string ASCII
	設定内容	32文字以内

レスポンス

《ステータスコード》

正常に終了した場合に"200 OK"を返します。

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<GetLPlatformAttributesResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <lplatform>
    <baseDescriptor>[L-Platformの元になったテンプレートID]</baseDescriptor>
    <creator>[L-Platform作成者のテナント名]</creator>
    <ownerUser>[L-Platformの所有者のユーザーID]</ownerUser>
    <description>[L-Platformの説明]</description>
    <lplatformId>[L-Platform ID]</lplatformId>
    <lplatformName>[L-Platform名]</lplatformName>
  </lplatform>
</GetLPlatformAttributesResponse>

《要素》

要素名	項目	項目説明
GetLPlatformAttributesResponse	説明	レスポンスの情報を持つ要素
	型	なし
	出現回数	1
responseMessage	説明	メッセージ。リクエストが正しく処理されたかどうかを表します。メッセージの詳細については、「メッセージ集」の「第16章 PAPIで始まるメッセージ」を参照してください。
	型	string UTF-8
	出現回数	1
responseStatus	説明	ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。エラーコードの詳細については、「付録A レスポンスステータス・エラーコード一覧（L-Platform API）」を参照してください。
	型	string ASCII
	出現回数	1
lplatform	説明	L-Platform情報のレスポンス情報を持つ要素
	型	なし
	出現回数	0または1
baseDescriptor	説明	L-Platformの元になったテンプレートID
	型	string ASCII
	出現回数	0または1
creator	説明	L-Platform作成者のテナント名
	型	string ASCII
	出現回数	0または1
ownerUser	説明	L-Platformの所有者のユーザーID
	型	string ASCII
	出現回数	0または1
description	説明	L-Platformの説明
	型	string UTF-8
	出現回数	0または1
lplatformId	説明	L-Platform ID
	型	string ASCII
	出現回数	0または1
lplatformName	説明	L-Platform名
	型	string UTF-8
	出現回数	0または1

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetLPlatformAttributesResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lplatform>
    <baseDescriptor>template-132149ef229</baseDescriptor>
    <creator>tenantA</creator>
    <ownerUser>user1</ownerUser>
    <description>desc</description>
    <lplatformId>tenantA-VBMS7X11R</lplatformId>
    <lplatformName>testTemplateA</lplatformName>
  </lplatform>
</GetLPlatformAttributesResponse>