Skip to main content
Adaptive Insights
Knowledge and Support - Adaptive Insights

publishChanges

Category

Admin publishing

Description

Publish any pending changes.

Permissions Required To Invoke

Must be valid credentials for the instance and "Publish Admin Changes" permission. Instance must have admin publishing enabled.

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="publishChanges" 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 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 a role containing the permissions required for the method being invoked.

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

  • If the request is received with no batched changes, then the response is the 'Publish Success' response with 'publishedCount' = 0.

  • Success is where given n unpublished changes, all n are successfully published.

  • In a successful publish, output contains a publishResponse element that has a publishedCount attribute stating the number of changes that were published.

  • In an unsuccessful publish, output contains a publishResponse element that has the same publishedCount attribute and a notPublishedCount attribute listing the number of changes that were not published.

Success Example

<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
    <output>
        <publishResponse publishedCount="3" />
    </output>
</response>

Error Example

 <?xml version='1.0' encoding='UTF-8'?>
 <response success="false">
   <messages>
       <message type="ERROR">Publish Error</message>
   </messages>
   <output>
       <publishResponse publishedCount="0" notPublishedCount="2" />
   </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 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.

 

publishResponse element

Tag Name

publishResponse

Description

The response to a publish changes request. Contains information on either the status of unpublished changes, or the result of doing a publish.

Attributes of the Element

Attribute Name

Required?

Value

Example

publishedCount

Y

The number of changes that were successfully published.

6

notPublishedCount

N

The number of changes that were NOT published. Included with an unsuccessful 'publish' response.

2

Contents of the Element

(none)

  • Was this article helpful?