exportGroups

Category	Metadata retrieval
Description	Return the complete list of all groups defined for the given instance. This includes those groups defined global across whole instance and those groups defined by users.
Permissions Required To Invoke	User Admin
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 set of all groups defined in the instance.

Request Format


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportGroups" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_password"/>
</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 history 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>
    <groups>
       <group id="1" name="Corporate and Operations" isGlobal="true"/>
       <group id="2" name="Admins" isGlobal="true"/>
       <group id="3" name="Ops and Admins" isGlobal="true"/>
       <group id="4" name="My group" isGlobal="false" ownerId="3"/>
    </groups>
 </output>
</response>

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
Contents of the Element
A single optional messages element, and exactly one required output element.

messages element
Tag Name		messages
Description		Container for one or more message elements.
Attributes of the Element
Attribute Name	Required?	Value	Example
(none)
Contents of the Element
One or more message elements.

message element
Tag Name		message
Description		Represents a message being sent from the system back to the caller. Messages are used for error messages when requests do not succeed, for warning messages when requests do succeed, and for confirmation messages upon success.
Attributes of the Element
Attribute Name	Required?	Value	Example
key	N		When given, a key is a way to identify a particular message or type of message, useful for purposes of automated error logging and recovery in client programs. Keys do not change under different locales of requests, even when the language of the message changes. Keys also are unlikely to change in the future due to wording adjustments or terminology changes.
Contents of the Element
The text of the message. This text is in the language of the locale specified on the request (assuming that locale is supported). The text may also contain variable information such as the number of rows which were processed, or the particular column or value which caused an error.

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

groups element
Tag Name		groups
Description		Container for one or more group elements.
Attributes of the Element
Attribute Name	Required?	Value	Example
(none)
Contents of the Element
Zero or more group elements.

group element
Tag Name		group
Description		Represents a single group being returned in the response to an exportGroups API call.
Attributes of the Element
Attribute Name	Required?	Value	Example
id	Y	The internal system ID number for the user group.	2
name	Y	The name of the user group.	Ops and Admins
isGlobal	Y	Indicates if the user group is global across the instance.	3
ownerId	Y	The internal system ID of the user who owns this user group. Only set when isGlobal="false".	5
Contents of the Element
(none)