Initializing help system before first use

view

Extends: reference
Namespace: http://fico.com/xpress/insight/rest/v1

A view, used to present projects or scenarios.

XML

Elements

name (type) min/max
occurs
description
viewType (viewType) 0/1
projectId (string) 0/1 The id of the project that owns this view.
defaultView (boolean) 1/1 Indicates this view is the default view to use for this project.
authorities (string) 0/unbounded The authorities that have access to this view.
path (string) 0/1 The path to this view.
tableauWorkbookName (string) 0/1 The Tableau workbook name for this view.
tableauWorkbookId (string) 0/1 The Tableau workbook id for this view.
tableauViewId (string) 0/1 The Tableau view id for this view.
emptySelectionDefault (boolean) 1/1 Whether this is to be displayed when there is no selection.
lastModified (long) 1/1 The last modified date in milliseconds.
requiresScenariosLoaded (boolean) 1/1 Whether a view requires it scenarios to have input data.
viewGroupName (string) 0/1 View Group name reference. Mainly for stage 1 of View Groups in web client.
tableauGlobalFilterNames (string) 0/unbounded The array of Tableau global filters that can be applied to this view.
tableauParameters (tableauParameter) 0/unbounded

JSON

property type description
viewType viewType (viewType)
projectId projectId (string) The id of the project that owns this view.
defaultView defaultView (boolean) Indicates this view is the default view to use for this project.
authorities array of authorities (string) The authorities that have access to this view.
path path (string) The path to this view.
tableauWorkbookName tableauWorkbookName (string) The Tableau workbook name for this view.
tableauWorkbookId tableauWorkbookId (string) The Tableau workbook id for this view.
tableauViewId tableauViewId (string) The Tableau view id for this view.
emptySelectionDefault emptySelectionDefault (boolean) Whether this is to be displayed when there is no selection.
lastModified lastModified (long) The last modified date in milliseconds.
requiresScenariosLoaded requiresScenariosLoaded (boolean) Whether a view requires it scenarios to have input data.
viewGroupName viewGroupName (string) View Group name reference. Mainly for stage 1 of View Groups in web client.
tableauGlobalFilterNames array of tableauGlobalFilterNames (string) The array of Tableau global filters that can be applied to this view.
tableauParameters array of tableauParameters (tableauParameter)

© 2001-2020 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.