Retrieve a comprehensive list of dimensions and their properties within a specific model.
After you retrieve the dimension and property information, you can use the Dimension properties glossary to identify the purpose and type of each property.
Method and endpoint
/metadata/models/{modelName}/Dimensions
Parameters
Parameter | Type | Description | Required |
{modelname} | String | The name of the model in your Anaplan Financial Consolidation tenant. | Yes |
Curl example
This curl example requests a list of dimensions and their properties from the Consolidation
model, in the Demo Sandbox
tenant.
curl --location 'https://fluenceapi-prod.fluence.app/api/v2305.1/metadata/models/Consolidation/Dimensions' \
--header 'TENANT: CustomerTenant' \
--header 'X-API-TOKEN: 73ca5973-ce3e-4cc6-b2d4-b09a99770ccf'
Response
[
{
"dimensionName": "Account",
"dimensionType": "Account",
"translations": "fr",
"relatedDimension": null,
"properties": [
{
"propertyName": "Classification",
"propertyType": "list",
"standardProperty": true,
"reportingProperty": true,
"readonlyProperty": false,
"processingStatus": 0,
"typeInfo": "Classification"
},
{
"propertyName": "Consolidation",
"propertyType": "list",
"standardProperty": true,
"reportingProperty": false,
"readonlyProperty": false,
"processingStatus": 0,
"typeInfo": "Consolidation"
},
{
"propertyName": "Conversion",
"propertyType": "list",
"standardProperty": true,
"reportingProperty": false,
"readonlyProperty": false,
"processingStatus": 0,
"typeInfo": "Conversion"
},
{
"propertyName": "CopyOpening",
"propertyType": "list",
"standardProperty": true,
"reportingProperty": false,
"readonlyProperty": false,
"processingStatus": 0,
"typeInfo": "CopyOpening"
},
{
"propertyName": "DebitCredit",
"propertyType": "list",
"standardProperty": true,
"reportingProperty": false,
"readonlyProperty": false,
"processingStatus": 0,
"typeInfo": "DebitCredit"
},
{
"propertyName": "IsLocked",
"propertyType": "bool",
"standardProperty": true,
"reportingProperty": false,
"readonlyProperty": false,
"processingStatus": 0,
"typeInfo": null
},
{
"propertyName": "Journal",
"propertyType": "Bit",
"standardProperty": true,
"reportingProperty": false,
"readonlyProperty": false,
"processingStatus": 0,
"typeInfo": null
},
{
"propertyName": "MovementClass",
"propertyType": "string",
"standardProperty": false,
"reportingProperty": false,
"readonlyProperty": false,
"processingStatus": 0,
"typeInfo": null
},
{
"propertyName": "SysName",
"propertyType": "List",
"standardProperty": true,
"reportingProperty": false,
"readonlyProperty": false,
"processingStatus": 0,
"typeInfo": null
},
{
"propertyName": "TimeBalance",
"propertyType": "string",
"standardProperty": true,
"reportingProperty": false,
"readonlyProperty": false,
"processingStatus": 0,
"typeInfo": null
},
{
"propertyName": "Variation",
"propertyType": "Bit",
"standardProperty": true,
"reportingProperty": false,
"readonlyProperty": false,
"processingStatus": 0,
"typeInfo": null
}
]
"processingStatus": null
}
]
Note: More results were returned but were removed for brevity.