Retrieve a list of members and their properties within a specific dimension.
This process enables organizations to extract dimension-related data, enabling more targeted insights and decision-making. Organizations can seamlessly integrate the dimension details into their chosen applications, such as reporting or planning tools, ensuring that the analysis is contextually relevant and aligned with the designated financial model.
Method and endpoint
/metadata/Dimensions/{dimensionName}
Parameters
Parameter | Type | Description | Example |
{dimensionName} | String | The name of a dimension within a tenant. | Account |
Page | Numerical | Specifies the desired query page to retrieve | Page=1 |
PageSize | Numerical | Specifies how many rows to fetch for the page defined. | PageSize=100 |
Curl example
This example requests the properties for the DataView
dimension, and uses a filter query parameter to page the response.
curl --location 'https://fluenceapi-prod.fluence.app/api/v2305.1/metadata/Dimensions/DataView?Page=1&PageSize=100' \
--header 'TENANT: CustomerTenant' \
--header 'X-API-TOKEN: 73ca5973-ce3e-4cc6-b2d4-b09a99770ccf
Response
{
"dimensionMembers": [
{
"memberName": "No DataView",
"memberTag": null,
"memberCaption": "No DataView",
"ancestors": "DataView|No DataView12",
"translations": [],
"parentMemberName": "",
"sortOrder": 1,
"isLeaf": true,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": "False"
},
{
"propertyName": "Converted",
"propertyValue": "False"
},
{
"propertyName": "DataviewType",
"propertyValue": null
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
},
{
"memberName": "All_Values",
"memberTag": "#AllDataViews#",
"memberCaption": "All_Values",
"ancestors": "DataView|All_Values69",
"translations": [],
"parentMemberName": "",
"sortOrder": 2,
"isLeaf": false,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": "False"
},
{
"propertyName": "Converted",
"propertyValue": "False"
},
{
"propertyName": "DataviewType",
"propertyValue": null
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
},
{
"memberName": "@ Budget Rate",
"memberTag": null,
"memberCaption": "@ Budget Rate",
"ancestors": "DataView|@ Budget Rate57",
"translations": [],
"parentMemberName": "",
"sortOrder": 10,
"isLeaf": true,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": "False"
},
{
"propertyName": "Converted",
"propertyValue": "False"
},
{
"propertyName": "DataviewType",
"propertyValue": "Credit"
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
},
{
"memberName": "Simulation Conversion",
"memberTag": null,
"memberCaption": "Simulation Conversion",
"ancestors": "DataView|Simulation Conversion60",
"translations": [],
"parentMemberName": "",
"sortOrder": 12,
"isLeaf": false,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": "False"
},
{
"propertyName": "Converted",
"propertyValue": "False"
},
{
"propertyName": "DataviewType",
"propertyValue": null
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
},
{
"memberName": "Simulation Consolidation",
"memberTag": null,
"memberCaption": "Simulation Consolidation",
"ancestors": "DataView|Simulation Consolidation63",
"translations": [],
"parentMemberName": "",
"sortOrder": 16,
"isLeaf": false,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": "False"
},
{
"propertyName": "Converted",
"propertyValue": "False"
},
{
"propertyName": "DataviewType",
"propertyValue": null
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
},
{
"memberName": "Depreciation",
"memberTag": null,
"memberCaption": "Depreciation",
"ancestors": "DataView|Depreciation81",
"translations": [],
"parentMemberName": "",
"sortOrder": 37,
"isLeaf": true,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": "False"
},
{
"propertyName": "Converted",
"propertyValue": "False"
},
{
"propertyName": "DataviewType",
"propertyValue": null
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
},
{
"memberName": "Account_Reconciliation",
"memberTag": null,
"memberCaption": "Account_Reconciliation",
"ancestors": "DataView|Account_Reconciliation82",
"translations": [],
"parentMemberName": "",
"sortOrder": 82,
"isLeaf": false,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": "False"
},
{
"propertyName": "Converted",
"propertyValue": "False"
},
{
"propertyName": "DataviewType",
"propertyValue": null
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
},
{
"memberName": "TransactionCurrency",
"memberTag": "",
"memberCaption": "Transaction Currency",
"ancestors": "DataView|TransactionCurrency92",
"translations": [],
"parentMemberName": "",
"sortOrder": 83,
"isLeaf": true,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": null
},
{
"propertyName": "Converted",
"propertyValue": null
},
{
"propertyName": "DataviewType",
"propertyValue": "TransactionCurrency"
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
},
{
"memberName": "Conversion_S001",
"memberTag": null,
"memberCaption": "Conversion_S001",
"ancestors": "DataView|Simulation Conversion60|Conversion_S00158",
"translations": [],
"parentMemberName": "Simulation Conversion60",
"sortOrder": 13,
"isLeaf": true,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": "False"
},
{
"propertyName": "Converted",
"propertyValue": "False"
},
{
"propertyName": "DataviewType",
"propertyValue": "SimulationConversion"
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
},
{
"memberName": "Conversion_S002",
"memberTag": null,
"memberCaption": "Conversion_S002",
"ancestors": "DataView|Simulation Conversion60|Conversion_S00261",
"translations": [],
"parentMemberName": "Simulation Conversion60",
"sortOrder": 14,
"isLeaf": true,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": "False"
},
{
"propertyName": "Converted",
"propertyValue": "False"
},
{
"propertyName": "DataviewType",
"propertyValue": "SimulationConversion"
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
},
{
"memberName": "Conversion_S003",
"memberTag": null,
"memberCaption": "Conversion_S003",
"ancestors": "DataView|Simulation Conversion60|Conversion_S00362",
"translations": [],
"parentMemberName": "Simulation Conversion60",
"sortOrder": 15,
"isLeaf": true,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": "False"
},
{
"propertyName": "Converted",
"propertyValue": "False"
},
{
"propertyName": "DataviewType",
"propertyValue": "SimulationConversion"
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
},
{
"memberName": "Consolidation_S001",
"memberTag": null,
"memberCaption": "Consolidation_S001",
"ancestors": "DataView|Simulation Consolidation63|Consolidation_S00159",
"translations": [],
"parentMemberName": "Simulation Consolidation63",
"sortOrder": 17,
"isLeaf": true,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": "False"
},
{
"propertyName": "Converted",
"propertyValue": "False"
},
{
"propertyName": "DataviewType",
"propertyValue": "SimulationConsolidation"
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
},
{
"memberName": "Consolidation_S002",
"memberTag": null,
"memberCaption": "Consolidation_S002",
"ancestors": "DataView|Simulation Consolidation63|Consolidation_S00264",
"translations": [],
"parentMemberName": "Simulation Consolidation63",
"sortOrder": 18,
"isLeaf": true,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": "False"
},
{
"propertyName": "Converted",
"propertyValue": "False"
},
{
"propertyName": "DataviewType",
"propertyValue": "SimulationConsolidation"
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
},
{
"memberName": "Consolidation_S003",
"memberTag": null,
"memberCaption": "Consolidation_S003",
"ancestors": "DataView|Simulation Consolidation63|Consolidation_S00365",
"translations": [],
"parentMemberName": "Simulation Consolidation63",
"sortOrder": 19,
"isLeaf": true,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": "False"
},
{
"propertyName": "Converted",
"propertyValue": "False"
},
{
"propertyName": "DataviewType",
"propertyValue": "SimulationConsolidation"
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
},
{
"memberName": "Value",
"memberTag": "#Value#",
"memberCaption": "Value",
"ancestors": "DataView|All_Values69|Value1",
"translations": [],
"parentMemberName": "All_Values69",
"sortOrder": 3,
"isLeaf": true,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": "True"
},
{
"propertyName": "Converted",
"propertyValue": "True"
},
{
"propertyName": "DataviewType",
"propertyValue": "Value"
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
},
{
"memberName": "Conversion",
"memberTag": null,
"memberCaption": "Conversion",
"ancestors": "DataView|All_Values69|Conversion6",
"translations": [],
"parentMemberName": "All_Values69",
"sortOrder": 5,
"isLeaf": true,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": "True"
},
{
"propertyName": "Converted",
"propertyValue": "False"
},
{
"propertyName": "DataviewType",
"propertyValue": "Conversion"
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
},
{
"memberName": "Consolidation",
"memberTag": null,
"memberCaption": "Consolidation",
"ancestors": "DataView|All_Values69|Consolidation4",
"translations": [],
"parentMemberName": "All_Values69",
"sortOrder": 6,
"isLeaf": true,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": "False"
},
{
"propertyName": "Converted",
"propertyValue": "False"
},
{
"propertyName": "DataviewType",
"propertyValue": "Consolidation"
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
},
{
"memberName": "Calculation",
"memberTag": null,
"memberCaption": "Calculation",
"ancestors": "DataView|All_Values69|Calculation7",
"translations": [],
"parentMemberName": "All_Values69",
"sortOrder": 7,
"isLeaf": true,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": "False"
},
{
"propertyName": "Converted",
"propertyValue": "False"
},
{
"propertyName": "DataviewType",
"propertyValue": "Calculation"
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
},
{
"memberName": "ValueCalc",
"memberTag": "#",
"memberCaption": "ValueCalc",
"ancestors": "DataView|All_Values69|ValueCalc93",
"translations": [],
"parentMemberName": "All_Values69",
"sortOrder": 8,
"isLeaf": true,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": "True"
},
{
"propertyName": "Converted",
"propertyValue": "True"
},
{
"propertyName": "DataviewType",
"propertyValue": "Value"
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
},
{
"memberName": "Acct_Rec_Amount",
"memberTag": null,
"memberCaption": "Amount",
"ancestors": "DataView|Account_Reconciliation82|Acct_Rec_Amount83",
"translations": [],
"parentMemberName": "Account_Reconciliation82",
"sortOrder": 83,
"isLeaf": true,
"operator": null,
"startDate": null,
"endDate": null,
"memberStorage": "Stored",
"properties": [
{
"propertyName": "Consolidated",
"propertyValue": "False"
},
{
"propertyName": "Converted",
"propertyValue": "False"
},
{
"propertyName": "DataviewType",
"propertyValue": null
},
{
"propertyName": "IgnoreTimebased",
"propertyValue": null
},
{
"propertyName": "IsLocked",
"propertyValue": "False"
}
]
}
],
"totalRows": 28,
"currentPage": 1,
"totalPages": 2
}