Arrays

Get detailed information about a specific array including all values and type-specific properties.

This endpoint returns array details with properties varying based on the array type:

  • Static Arrays: Returns a list of string values in order
  • Product Output Grouping Arrays: Returns the product output grouping ID
  • Calculated Range Arrays: Returns start/end/step value configurations (variable, constant, or time index)
  • Data Table Arrays: Returns the data table variable name and calculation level
  • Multi-Dimensional Arrays: Returns the IDs of both dimension arrays

This endpoint can be used with:

  • Production models (using a Workspace or Personal token)
  • Workspace models (using a Workspace or Personal token)

The user must have appropriate permissions to access the model containing the array.

get/api/v1/Arrays/{arrayId}

Request

Path parameters

arrayIdinteger required

The ID of the array to retrieve

The unique identifier of the array to retrieve.

Response

OK

idinteger
namestring nullable
arraySource'Static' | 'ProductOutputGrouping' | 'Range' | 'DataTable' | 'MultiDimensional' | 'List'
level'Product' | 'Portfolio' | 'Company'
valuesstring[] nullable
productOutputGroupingIdinteger nullable
variableNamestring nullable
dimension1ArrayIdinteger nullable
dimension2ArrayIdinteger nullable

Changes

No recorded changes to this operation across all 1 revision of this API.