exportPermissionSets

Category	Metadata retrieval
Description	Returns metadata for the complete list of all permission sets in the instance.
Permissions Required To Invoke	None (must be valid credentials for the instance)
Parameters Required On Request	Credentials

This method's request contains only a credentials tag to identify and authorize the calling user. Once verified, the method returns an XML document describing the complete permission set found in the user's instance.

Request Format


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportPermissionSets" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
</call>

credentials element
Tag Name		credentials
Description		All API calls must contain a single credentials element to identify the user invoking the API. The API call is then performed as this user (any audit trail or his- tory of actions in the system will show that this user performed the action), and therefore the user must have the required permissions to perform the action in order for the API call to succeed.
Attributes of the Element
Attribute Name	Required?	Value	Example
login	Y	The login name of the user invoking the API method. This user must have the required permissions to invoke the method	sampleuser@company.com
password	Y	The password of the user invoking the API method.	my_password
locale	N	Specify the locale to be used to interpret incoming numbers and dates, and to format outgoing numbers and dates (using the proper thousands separator, month names, and date formatting). The locale is also used to specify the language in which any system messages in the response should appear. If not specified, en_US (American English) is used.	fr_FR
instanceCode	N	If the user specified in the credentials has access to more than one instance of Adaptive Planning , this attribute can be used to specify that the user is intending to access an instance other than their default instance. If not specified, the user's default instance will be used. To determine the available instance codes, use the exportInstances API.	MYINSTANCE1
Contents of the Element
(none)

Response Format


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
 <output>
   <permission_sets>
     <permission_set id="1" name="Standard" permissions="SHT,RPT,SCOREBOARD"/>
     <permission_set id="2" name="Administrative" permissions="SHT,RPT,SCOREBOARD,SAL,MOD,IMP,EXP"/>
   </permission_sets>
 </output>
</response>

Permission sets and permissions are ordered by name.

response element
Tag Name		response
Attributes of the Element
Attribute Name	Required?	Value	Example
success	Y	Either true or false, indicating whether the API call was successful or not. Even successful calls may contain warning messages in their response.	true
obsolete	N	If present on the response tag and set to true, this attribute indicates that the version of the method or API which is being invoked has become obsolete and is officially deprecated by Adaptive Planning . While it continues to function at this time, it may cease functioning in a short while. Typically, this attribute is not present.	false
Contents of the Element
A single optional messages element, and exactly one required output element.

output element
Tag Name	output
Attributes of the Element
(none)
Contents of the Element
A single accounts element. This output wrapper is standard on all API responses and encloses the valid output of any successful API call.

permission_sets element
Tag Name	permission_sets
Description	Container for one or more permission set elements.
Attributes of the Element
(none)
Contents of the Element
One or more permission set elements.

permission_set element
Tag Name		permission_set
Description		Describes a single permission set available in the instance.
Attributes of the Element
Attribute Name	Required?	Value	Example
id	Y	The internal system ID number for the permission set. This is used to identify the permission set assigned to a user in the exportUsers API call.	1
name	Y	The name of the permission set, as seen in Permission Set Administration	Standard
permissions	Y	A comma-separated list of codes for permissions assigned to this permission set. The codes are internal abbrevi- ations such as "SHT" for Sheet Access and "RPT" for Report Access.	SHT,RPT,SCOREBOARD
Contents of the Element
(none)