;

Skip to main content

 

  • arrow icon
Language Selector

  1. Other Languages

    (machine translation)

 

Planview Customer Success Center

Getting Multiple Variables

  1. Last updated
  2. Save as PDF

Example Request URL

  https://<URL>/FactVariableService/varlist/proj/{modelid}/{tempid}/{vars}

The modelid is the ID of the project where you to get the variables. The tempid is the template ID and vars is a comma-delineated list of variable identifiers.

Example Response

The response is a JSON with the following structure:

totalVariables: integer - the number of the variable fetched
errors: array of strings - the identifiers of variables that failed fetching.
time: string with the time of fetching. YYYY-MM-DDThh:mm:ss.#######TZ
dataList: an object of variable facts (each with structure based on its node type), keyed by variable identifiers.

The variable record structure depends on the variable type.

Table variables have the following JSON structure:

name: string - the node identifier
title: string - the node title
description: string - the node description
indexes: object keyed by index identifiers of arrays of index string entries.
data: an array of strings with cell values in the canonical Analytica order
indexOrder: array of string of index identifiers ordered by the Analytica canonical order.
indexNames: an object of index identifier - index name pairs.
indexFilters: an object of 1 and 0 arrays keyed by index identifiers for each index with filters that indexes the table.
simpleFlags: an object that supports simple flag (flags with attr and value properties only). For each flag on the node there will be a flag_attr:flag_value pair in the object. Currently supported are default_column_index and default_row_index.

 Scalar variables have the following structure:

name: string - the node identifier
title: string - the node title
description: string - the node description
data: string - the scalar value
metadata: for input nodes