modelEntity
| Namespace: | http://fico.com/xpress/insight/rest/v1 |
The definition of an entity in a ModelSchema
XML
Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| name (string) | 0/1 | The name of this entity |
| abbreviatedName (string) | 0/1 | The abbreviated name of this entity |
| alias (string) | 0/1 | The alias of this entity |
| constant (boolean) | 1/1 | Indicates if this entity is a constant |
| labelsEntity (boolean) | 1/1 | Indicates if this entity is used as the labels for another entity |
| indexGrouping (boolean) | 1/1 | Indicates if this entity is used to group an index |
| labelsEntityName (string) | 0/1 | The name of the entity that holds the labels for this entity |
| dataType (string) | 0/1 | The data type of this entity For valid values see com.fico.xpress.insight.data.XPRIDataType |
| projectId (string) | 0/1 | The id of the project that owns this Entity |
| indexSets (string) | 0/unbounded | The name of the index sets that index this array |
| managementType (string) | 0/1 | Indicates whether entity is part of the input or the results data For valid values see com.fico.xpress.insight.resources.EntityManagementType |
| elementType (string) | 0/1 | The type of elements this array or set contains For valid values see com.fico.xpress.insight.data.XPRIDataType. |
| indexGroupings (string) | 0/unbounded | The index groupings for this set |
| relaxable (boolean) | 1/1 | Indicates if the entity is a constraint that is relaxable |
| disableable (boolean) | 1/1 | Indicates if the entity is a constraint that is disposable |
| violationUpperBoundEntity (string) | 0/1 | The violation upper bound entity |
| violationCostEntity (string) | 0/1 | The violation cost entity |
| hidden (boolean) | 1/1 | Indicates if this entity is hidden |
| alwaysHidden (boolean) | 1/1 | Indicates if this entity is always hidden |
| format (string) | 0/1 | Indicates formatting of this entity |
JSON
| property | type | description |
|---|---|---|
| name | name (string) | The name of this entity |
| abbreviatedName | abbreviatedName (string) | The abbreviated name of this entity |
| alias | alias (string) | The alias of this entity |
| constant | constant (boolean) | Indicates if this entity is a constant |
| labelsEntity | labelsEntity (boolean) | Indicates if this entity is used as the labels for another entity |
| indexGrouping | indexGrouping (boolean) | Indicates if this entity is used to group an index |
| labelsEntityName | labelsEntityName (string) | The name of the entity that holds the labels for this entity |
| dataType | dataType (string) | The data type of this entity For valid values see com.fico.xpress.insight.data.XPRIDataType |
| projectId | projectId (string) | The id of the project that owns this Entity |
| indexSets | array of indexSets (string) | The name of the index sets that index this array |
| managementType | managementType (string) | Indicates whether entity is part of the input or the results data For valid values see com.fico.xpress.insight.resources.EntityManagementType |
| elementType | elementType (string) | The type of elements this array or set contains For valid values see com.fico.xpress.insight.data.XPRIDataType. |
| indexGroupings | array of indexGroupings (string) | The index groupings for this set |
| relaxable | relaxable (boolean) | Indicates if the entity is a constraint that is relaxable |
| disableable | disableable (boolean) | Indicates if the entity is a constraint that is disposable |
| violationUpperBoundEntity | violationUpperBoundEntity (string) | The violation upper bound entity |
| violationCostEntity | violationCostEntity (string) | The violation cost entity |
| hidden | hidden (boolean) | Indicates if this entity is hidden |
| alwaysHidden | alwaysHidden (boolean) | Indicates if this entity is always hidden |
| format | format (string) | Indicates formatting of this entity |
© 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.