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

recalculateSheet

Supported in API v16 + 

Category

Data submission

Description

Recalculate sheets with Recalculate on demand property.

Permissions Required To Invoke

Sheet Edit Permission

Parameters Required On Request

Credentials

This method's request contains a credentials tag to identify and authorize the calling user. User must have "Sheet Edit Permission" permission to recalculate.

Request Format

<?xml version='1.0' encoding='UTF-8'?>
<call method="recalculateSheet" callerName="a string that identifies your client application">
   <credentials login="sampleuser@company.com" password="my_password"/>
   <version name="Default Structure"/>
   <sheet name="Expense Cube"/>
   <level name="Corporate Plan"/>
</call>
  • version element - Throws an error if version is not specified.
  • sheet element - If no sheet element is specified, all sheets with recalculate on demand options are recalculated at the top level on given version. In this case, level is ignored.
  • level element
    • If no level is specified, the sheet is recalculated at top level on given version.
    • If the user doesn't have access to the specified level, an error is thrown.
    • The sheet is recalculated for the level and its descendants on the given version.

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 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, time period 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 speci­fied, the user's default instance will be used. To determine the available instance codes, use the exportInstances API.

MYINSTANCE1

Contents of the Element

(none)

 

version element

Tag Name

version

Description

Indicates which version should be used to receive the requested data. A version must be provided for each call.

Attributes of the Element

Attribute Name

Required?

Value

Example

name

N

The name of the version.

Default Structure

id N ID of the version. ID is considered only if name is not present. 4

Contents of the Element

(none)

 

sheet element

Tag Name

sheet

Description

Sheet defined by name or id

Attributes of the Element

Attribute Name

Required?

Value

Example

name

N

The name of the sheet

Expense Cube

id N ID of the sheet. ID is considered only if name is not present. 1

Contents of the Element

(none)

 

level element

Tag Name

level

Description

Level defined by name or id

Attributes of the Element

Attribute Name

Required?

Value

Example

name

N

The name of the level

Corporate Plan

id N ID of the level. Level is considered only if name is not present. 1

Contents of the Element

(none)

Response Format

<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
</response>

 

response element

Tag Name

response

Description

Level defined by name or id

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.

 

messages element

Tag Name

messages

Description

Container for one or more message elements.

Attributes of the Element

(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 mes­sages 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 particu­lar message or type of message, useful for pur­poses of automated error logging and recovery in client programs. Keys do not change under different locales of requests, even when the lan­guage of the message changes. Keys also are unlikely to change in the future due to wording adjustments or terminology changes.

invalid-attributevalueid

Contents of the Element

1. The text of the message. This text is in the language of the locale specified on the request (assuming that locale is sup­ported). The text may also contain variable information such as the number of rows which were processed, or the particu­lar column or value that caused an error.

2. An optional context element.

  • Was this article helpful?