Use this call to set the switchover date for a version. 

This enables an integration to automate the point at which actual data replaces forecast data for that version as part of a period-close or rolling-forecast process.

The response contains the response code, as well as the date and human-readable date period as shown in the UI.

Notes: 

  • To use this call, you must be a Workspace Administrator.
  • To apply a switchover date, ensure the versionID corresponds to a version in Anaplan that is set to either forecast or variance.
  • Ensure the switchover date is after the existing version switchover date.
  • To reset the switchover date to Blank, pass an empty string in the request body.

Method and endpoint

PUT

/models/{modelId}/versions/{versionId}/switchover

Parameters

ParameterDetails
{modelId}
  • Required
  • Type: String
  • Description: the model ID
  • Example: 75A40874E6B64FA3AE074327899685
{versionId}
  • Required
  • Type: String
  • Description: the version ID. The ID of the actual version returns a 400 Bad Request response
  • Example: 107000000002

Curl example

curl -X PUT 'https://api.anaplan.com/2/0/models/{modelId}/versions/{versionId}/switchover' \
-H 'Authorization: AnaplanAuthToken {anaplan_auth_token}' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{"date":"{newSwitchoverDate}"}'

Response

Response headers

Content-Type: application/json

Response 200 body

{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/objects/switchover"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "versionSwitchover": {
       "periodText": "May 13",
       "date": "2013-05-01",
       "calendarType": "Calendar Months/Quarters/Years"
   }
}

Group users

Endpoints that enable you to obtain user information accessible to you using your authentication token.

As a standard user, you can access the data to which you have been granted access. Endpoints respond with 401 Not Authorized if you aren't authorized to access the data that you are requesting.

Note that these API calls only work with the user's default tenant. They won't return data for any additional tenants the user is assigned to.

View these endpoints for further details on users APIs: