2.2.5 GetLPlatformAttributes (Gets the Attributes of an L-Platform)

This API gets attribute information for an L-Platform.

Request parameters

Parameter name	Item	Item description
Version	Description	The version ID of the L-Platform API.
	Type	string
	Value	Fixed. Specify "2.0".
Locale	Description	The language for communicating with the L-Platform API. This parameter is specified using the language codes stipulated by ISO 639.
	Type	string
	Value	Select one of the following: - en: English - zh: Chinese
Action	Description	The name of the L-Platform API to be executed.
	Type	string
	Value	Fixed. Specify "GetLPlatformAttributes".
userId	Description	The user ID of the user that executes the L-Platform API.
	Type	string
	Value	No more than 31 characters.
orgId	Description	The tenant name of the user that executes the L-Platform API.
	Type	string
	Value	No more than 32 characters.
lplatformId	Description	L-Platform ID.
	Type	string
	Value	No more than 32 characters.

Response

The API returns "200 OK" if it terminates normally.

<XML>

<?xml version="1.0" encoding="UTF-8"?>
<GetLPlatformAttributesResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[Message]</responseMessage>
  <responseStatus>[Status]</responseStatus>
  <lplatform>
    <baseDescriptor>[Template ID from which the L-Platform was created]</baseDescriptor>
    <creator>[tenant name of the person who created the system]</creator>
    <ownerUser>[The user ID of the person who owns the L-Platform]</ownerUser>
    <description>[L-Platform description]</description>
    <lplatformId>[L-Platform ID]</lplatformId>
    <lplatformName>[L-Platform name]</lplatformName>
  </lplatform>
</GetLPlatformAttributesResponse>

Element name	Item	Item description
GetLPlatformAttributesResponse	Description	Element holding the response information.
	Type	None
	Number of occurrences	1
responseMessage	Description	Message. This element indicates whether the request has been processed correctly. Refer to "Chapter 15 Messages Starting with PAPI" in the "Messages" for message details.
	Type	string
	Number of occurrences	1
responseStatus	Description	Status. This element indicates whether the request has been processed normally. "SUCCESS" is returned if the request is processed normally. Otherwise, an error code is returned. Refer to "Appendix A List of Response Status Error Codes(L-Platform APIs)" for information on error codes.
	Type	string
	Number of occurrences	1
lplatform	Description	Element holding the response information for the L-Platform information.
	Type	None
	Number of occurrences	0 or 1
baseDescriptor	Description	Template ID from which the L-Platform was created.
	Type	string
	Number of occurrences	As many as there are lplatform elements (0 or 1 element for each lplatform element).
creator	Description	The tenant name of the person who created the L-Platform.
	Type	string
	Number of occurrences	As many as there are lplatform elements (0 or 1 element for each lplatform element).
description	Description	L-Platform description
	Type	string
	Number of occurrences	As many as there are lplatform elements (0 or 1 element for each lplatform element).
ownerUser	Description	The user ID of the person who owns the L-Platform.
	Type	string
	Number of occurrences	As many as there are lplatform elements (0 or 1 element for each lplatform element).
lplatformId	Description	L-Platform ID
	Type	string
	Number of occurrences	As many as there are lplatform elements (0 or 1 element for each lplatform element).
lplatformName	Description	L-Platform name
	Type	string
	Number of occurrences	As many as there are lplatform elements (0 or 1 element for each lplatform element).

Sample response

<?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>papi</creator>
    <description/>
    <ownerUser>user3</ownerUser>
    <lplatformId>tenantA-M3PGGWCFX</lplatformId>
    <lplatformName>testTemplateA</lplatformName>
  </lplatform>
</GetLPlatformAttributesResponse>