Retrieves information about a specific model in the user's default tenant, if the user has access to the model.

This helps validate that a model exists, confirm access, and check whether it is the correct target before running actions or retrieving data.

Method and endpoint

GET

/models/{modelId}

Parameters

ParameterDescription
modelId
  • Required
  • Type: string
  • Description: The model ID
  • Example: FC12345678912343455667
modelDetails
  • Optional
  • Type: Boolean
  • Description: When set to true, this call returns the available model memory usage in bytes and models status information. When set to false, or not defined, this call doesn't return the model memory usage.
  • Example: ?modelDetails=true

Curl example

curl -X GET \
https://api.anaplan.com/2/0/models/{modelId} \
-H 'authorization: AnaplanAuthToken {anaplan_auth_token}'

Response

Response 200 (application/json)

{
 "meta": {
   "schema": "https://api.anaplan.com/2/0/objects/model"
 },
 "model": {
   "id": "FC12345678912343455667",
   "activeState": "UNLOCKED",
   "name": "PF&A",
   "currentWorkspaceId": "8a8b8c8d8e8f8g8i",
   "currentWorkspaceName": "Financial Planning",
   "modelUrl": "https://rt.anaplan.com/anaplan/rt?selectedWorkspaceId\8a8b8c8d8e8f8g8i\u0026selectedModelId\FC12345678912343455667",
   "categoryValues": []
 },
 "status": {
   "code": 200,
   "message": "Success"
 }
}

Response 200 (application/json) when modelDetails=true

{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/objects/model"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "model": {
       "id": "FC12345678912343455667",
       "name": "PF&A",
       "activeState": "UNLOCKED",
       "lastSavedSerialNumber": 2000000,
       "modelTransactionRunning": false,
       "lastModifiedByUserGuid": "5c8f44f65d3a11ea95e4026d2ec6a15d",
       "memoryUsage": 474900,
       "currentWorkspaceId": "8a8b8c8d8e8f8g8i",
       "currentWorkspaceName": "Financial Planning",
   "modelUrl": "https://rt.anaplan.com/anaplan/rt?selectedWorkspaceId\8a8b8c8d8e8f8g8i\u0026selectedModelId\FC12345678912343455667",
       "categoryValues": [],
       "isoCreationDate": "2022-02-10T19:14:23.000+0000",
       "lastModified": "2022-02-10T19:14:24.000+0000"
   }
}