unpublishedChangesStatus

Category	Admin publishing
Description	Retrieve the number of unpublished changes, and determine if admin publishing is disabled for the instance.
Permissions Required To Invoke	Must be valid credentials for the instance. If admin publishing is disabled, no additional permissions are required. If admin publishing is enabled, the user must have the Publish Admin Changes permission.
Parameters Required On Request	Credentials

This method's request contains a credentials tag to identify and authorize the calling user. Once verified, this method will publish any batched changes. Optionally, the request may contain an action tag.

Request Format


<?xml version='1.0' encoding='UTF-8'?>
<call method="unpublishedChangesStatus" 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

These are examples of responses for admin publishing enabled and disabled.

Admin Publishing Enabled Example


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
    <output>
        <unpublishedStatus adminPublishingEnabled="1" numberToPublish="3" />
    </output>
</response>

Admin Publishing Disabled Example


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
    <output>
        <unpublishedStatus adminPublishingEnabled="0" />
    </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
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 . 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 required unpublishedStatus element. This output wrapper is standard on all API responses and encloses the valid output of any successful API call.

unpublishedStatus element
Tag Name		unpublishedStatus
Description		The response to an unpublishedChangesStatus request. Contains information on whether admin publishing is enabled, and if so, how many unpublished changes there are.
Attributes of the Element
Attribute Name	Required?	Value	Example
adminPublishingEnabled	Y	Whether or not admin publishing is enabled for this instance (0=not enabled, 1=enabled).	1
numberToPublish	N	How many unpublished changes there are. Appears only if admin publishing is enabled. If there are no unpublished changes, value is 0.	2
Contents of the Element
(none)