Retrieves information about all models in the specified workspace.

This helps narrow model discovery to a known workspace and select the correct model for imports, exports, metadata reads, or process execution.

 Method and endpoint

GET

/workspaces/{workspaceId}/models?modelDetails=true

Parameters


ParameterDescription
workspaceId
  • Required
  • Type: string
  • Description: The workspace ID
  • Example: 8a8b8c8d8e8f8g8i
modelDetails
  • Optional
  • Type: Boolean
  • Description: When set to true, this call returns the available model memory usage in bytes. When set to false, or not defined, this call does not return the model memory usage.
  • Example: true

Curl example

curl -X GET \
https://api.anaplan.com/2/0/workspaces/{workspaceId}/models?modelDetails=true \
-H 'authorization: AnaplanAuthToken {anaplan_auth_token}'

Response

{
 "meta": {
   "schema": "https://api.anaplan.com/2/0/objects/model",
   "paging": {
     "currentPageSize": 4,
     "totalSize": 4,
     "offset": 0
   }
 },
 "status": {
   "code": 200,
   "message": "Success"
 },
 "models": [
   {
     "id": "8BA821045BB34083B467C0082781DA69",
     "name": "Budgeting, Planning and Forecasting",
     "activeState": "UNLOCKED",
     "lastSavedSerialNumber": 2010876,
     "lastModifiedByUserGuid": "8a80da97613fc3d50161443501710056",
     "memoryUsage": 163950621,
     "currentWorkspaceId": "8a8196a258539d4c0158b0f9abe70bfd",
     "currentWorkspaceName": "ZZZ Sorting",
     "modelUrl": "https://api.anaplan.com/anaplan/framework.jsp?selectedWorkspaceId=8a8196a258539d4c0158b0f9abe70bfd&selectedModelId=8BA821045BB34083B467C0082781DA69",
     "categoryValues": [
       {
         "id": "8a8208a36543ed8f01655aff2edf264a",
         "attribute": "Sales",
         "categoryId": "15f6fd454b3a11ea814a026d2ec6a15d",
         "categoryName": "Business Function",
         "customerId": "8a8208a36543ed8f01655aff2ed52645"
       }
     ],
     "isoCreationDate": "2017-11-13T21:20:10.000+0000",
     "lastModified": "2020-11-26T00:29:01.000+0000"
   },
   {
     "id": "E216CF62E3F84342879E8480236AE78E",
     "name": "zmodel",
     "activeState": "UNLOCKED",
     "lastSavedSerialNumber": 2000035,
     "lastModifiedByUserGuid": "8a80da97613fc3d50161443501710056",
     "memoryUsage": 763180,
     "currentWorkspaceId": "8a8196a258539d4c0158b0f9abe70bfd",
     "currentWorkspaceName": "ZZZ Sorting",
     "modelUrl": "https://api.anaplan.com/anaplan/framework.jsp?selectedWorkspaceId=8a8196a258539d4c0158b0f9abe70bfd&selectedModelId=E216CF62E3F84342879E8480236AE78E",
     "categoryValues": [
       {
         "id": "8a8208a36543ed8f01655aff2edf2655",
         "attribute": "Planning, Budgeting and Forecasting",
         "categoryId": "15f70a644b3a11ea814a026d2ec6a15d",
         "categoryName": "App",
         "customerId": "8a8208a36543ed8f01655aff2ed52645"
       },
       {
         "id": "8a8208a36543ed8f01655aff2edf264b",
         "attribute": "Finance",
         "categoryId": "15f6fd454b3a11ea814a026d2ec6a15d",
         "categoryName": "Business Function",
         "customerId": "8a8208a36543ed8f01655aff2ed52645"
       }
     ],
     "isoCreationDate": "2016-11-29T16:45:02.000+0000",
     "lastModified": "2020-11-30T19:46:53.000+0000"
   },
   {
     "id": "1A0D320FF0C644479E98A207A5003E1A",
     "name": "zz archive",
     "activeState": "ARCHIVED",
     "lastSavedSerialNumber": 2000013,
     "lastModifiedByUserGuid": "8a80da97613fc3d50161443501710056",
     "currentWorkspaceId": "8a8196a258539d4c0158b0f9abe70bfd",
     "currentWorkspaceName": "ZZZ Sorting",
     "modelUrl": "https://api.anaplan.com/anaplan/framework.jsp?selectedWorkspaceId=8a8196a258539d4c0158b0f9abe70bfd&selectedModelId=1A0D320FF0C644479E98A207A5003E1A",
     "categoryValues": [
       {
         "id": "8a8208a36543ed8f01655aff2edf264d",
         "attribute": "Marketing",
         "categoryId": "15f6fd454b3a11ea814a026d2ec6a15d",
         "categoryName": "Business Function",
         "customerId": "8a8208a36543ed8f01655aff2ed52645"
       }
     ],
     "isoCreationDate": "2018-09-25T18:26:00.000+0000",
     "lastModified": "2018-09-25T18:26:00.000+0000"
   },
   {
     "id": "71B2E50D32664AF1B60FBC0C72B339AF",
     "name": "ZZmodel_Archive",
     "activeState": "UNLOCKED",
     "lastSavedSerialNumber": 2000015,
     "lastModifiedByUserGuid": "8a80da97613fc3d50161443501710056",
     "memoryUsage": 672300,
     "currentWorkspaceId": "8a8196a258539d4c0158b0f9abe70bfd",
     "currentWorkspaceName": "ZZZ Sorting",
     "modelUrl": "https://api.anaplan.com/anaplan/framework.jsp?selectedWorkspaceId=8a8196a258539d4c0158b0f9abe70bfd&selectedModelId=71B2E50D32664AF1B60FBC0C72B339AF",
     "categoryValues": [
       {
         "id": "8a8208a36543ed8f01655aff2ede2646",
         "attribute": "IT",
         "categoryId": "15f6fd454b3a11ea814a026d2ec6a15d",
         "categoryName": "Business Function",
         "customerId": "8a8208a36543ed8f01655aff2ed52645"
       }
     ],
     "isoCreationDate": "2018-08-17T18:05:23.000+0000",
     "lastModified": "2020-09-29T01:04:08.000+0000"
   }
 ]
}