Use this call to get information about the model versions.

This helps an integration discover available versions and understand their settings before reading, writing, or synchronizing version-specific data.

The response contains a list of the versions that the user has access to, and the model metadata that can be viewed from the UI.

Notes: 

  • To use this call, you must be a Workspace Administrator.
  • The returned versions only include the user's model role with read access or higher.
  • If the value for a field is set, it'll be returned in the results.

Method and endpoint

GET

/models/{modelId}/versions

Parameters

ParameterDetails
{modelId}
  • Required
  • Type: String
  • Description: the model ID
  • Example: 75A40874E6B64FA3AE074327899685

Curl example

curl -X GET 'https://api.anaplan.com/2/0/models/{modelId}/versions' \
-H 'Authorization: AnaplanAuthToken {anaplan_auth_token}'\
-H 'Accept: application/json'

Response

Response headers

Content-Type: application/json

Response 200 body

The date format for editFrom and editTo depends on the model calendar setting.

{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/objects/version"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "versionMetadata": [
       {
           "id": "107000000001",
           "name": "Actual",
           "isCurrent": false,
           "isActual": true,
           "editFrom": {
               "periodText": "Start of Timescale",
               "date": "1900-01-01"
           },
           "editTo": {
               "periodText": "End of Timescale",
               "date": "2399-12-31"
           },
           "notes": "This version data is updated every Monday"
       },
       {
           "id": "107000000002",
           "name": "Variance",
           "isCurrent": false,
           "isActual": false,
           "switchover": {
               "periodText": "Mar 20",
               "date": "2020-03-01"
           },
           "formula": "Actual - 20",
           "editFrom": {
               "periodText": "Jan 20",
               "date": "2020-01-01"
           },
           "editTo": {
               "periodText": "Dec 20",
               "date": "2020-12-31"
           }
       }
   ]
}