Use this call to determine the value of the current period in Anaplan.

This helps an integration determine which time period the model currently treats as “current” before loading data, running forecasts, or applying time-based logic.

If the current period is not set in Anaplan, this call returns empty strings for the periodText and lastDay values of the currentPeriod.

Notes:

Method and endpoint

GET

/workspaces/{workspaceId}/models/{modelId}/currentPeriod

Parameters

ParameterDetails
{workspaceId}
  • Required
  • Type: String
  • Description: The workspace ID
  • Example: 8a8196b15b7dbae6015b8694411d13fe
{modelId}
  • Required
  • Type: String
  • Description: the ID for the model
  • Example: 75A40874E6B64FA3AE074327899685

Curl example

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

Response

Response header

Content-Type: application/json

Response 200 body

{
  "meta" : {
    "schema" : "https://api.anaplan.com/2/0/objects/currentPeriod"
  },
  "status" : {
    "code" : 200,
    "message" : "Success"
  },
  "currentPeriod" : {
    "periodText" : "May 20",
    "lastDay" : "2020-05-31",
    "calendarType" : "Calendar Months/Quarters/Years"
  }
}