Class: GetDataViewDetailsRequestType

tibco.objectapi.bds.GetDataViewDetailsRequestType

new GetDataViewDetailsRequestType()

Details required to retrieve Data View(s). Constructs a new GetDataViewDetailsRequestType.

The following features are supported:

Members

appDetails :tibco.objectapi.bds.AppDetails

This property holds the value of the 'App Details' containment reference.
Type:

caseClassDetails :tibco.objectapi.bds.CaseClassDetails

This property holds the value of the 'Case Class Details' containment reference.
Type:

category :Array.<tibco.objectapi.bds.CategorySearchDetails>

This property holds the value of the 'Category' containment reference list.
Type:

includeAppDetails :boolean

If present and set true, this will cause inclusion of an 'appDetails' element within each 'result' element of the response. This property holds the value of the 'Include App Details' attribute.
Type:
  • boolean

includeCategories :boolean

If present and set true, this will cause inclusion of which category or categories each view belongs to (default: false). If the caller intends to subsequently update a view via the editDataView API, then this information will be required. This property holds the value of the 'Include Categories' attribute.
Type:
  • boolean

uncategorized :tibco.objectapi.bds.Uncategorized

Empty element indicates that views that do NOT belong to any category should be matched. This property holds the value of the 'Uncategorized' containment reference.
Type:

viewDetailsRequirement :tibco.objectapi.bds.ViewDetailsRequirementEnum

Determines which elements are required for each view in the response: Either NAME, NAME_AND_DESCRIPTION, NAME_AND_PARAMETERS or NAME_DESCRIPTION_AND_PARAMETERS. If this element is omitted, then all details will be returned (except parameters as they are present in the condition tree itself) This property holds the value of the 'View Details Requirement' attribute.
Type:

viewID :string

This property holds the value of the 'View ID' attribute.
Type:
  • string

viewName :string

May use the %_*? wildcard characters (escape with '\'), so can match multiple views This property holds the value of the 'View Name' attribute.
Type:
  • string