Skip to main content

Retrieve Plane Combinations for a Tabulation

GET 

/api/v1/workspace/:workspaceId/survey/:surveyCode/tabulation/:elementId/combinations

This method fetches the complete list of unique plane combinations (slices) that constitute the third dimension (PLANES) of a specific data cube. Each combination defines a unique 2D matrix slice that can be retrieved via the main tabulation endpoint, using the sliceId parameter.

Response Body

The response returns an object containing the total number of combinations and an array detailing each unique plane combination

PropertyTypeDescription
combinationsIntegerThe total number of available 2D slices in the data cube. This is the product of all items across all axes in the PLANES dimension.
itemCombinationsArrayA list where each object specifies a unique combination of items from the PLANES axes.
itemCombinations[i].itemsArrayThe list of specific items (one per axis in the PLANES dimension) that define this 2D slice.
itemCombinations[i].items[j].axisstringThe ID of the axis (e.g., STATISTICS or 3) to which the item belongs.
itemCombinations[i].items[j].itemObjectThe specific item object, including its id and label.
itemCombinations[i].sliceIdstringA unique identifier (sliceId) for this specific plane combination. This sliceId is used to request this exact slice in the main tabulation endpoint (GET /.../tabulation/{elementId}/{sliceId}).

Request​

Responses​

Tabulation retrieved successfully.