Class: ListCategoriesRequest

tibco.objectapi.service.request.ListCategoriesRequest

new ListCategoriesRequest()

Object ListCategoriesRequest Usage: RestApiService.getBusinessServiceService().listCategories(request, callback);
Since:
  • 4.0.0

Members

channelId :string

Query parameter: 'channelid' Identifies the presentation channel.
Type:
  • string
Since:
  • 4.0.0

filter :string

Query parameter: 'filter' (optional) Filter criteria.
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = ""

getTotalCount :boolean

Query parameter: 'gettotal' (optional) Specifies whether the Page Flow Engine builds a count of the total number of items in the list. If "false", getTotalCount is set to -1.
Type:
  • boolean
Since:
  • 4.0.0
Default Value:
  • = true

includeFormalParam :boolean

Query parameter: 'includeparam' (optional) Specifies whether the response should include items that have formal parameters.
Type:
  • boolean
Since:
  • 4.0.0
Default Value:
  • = true

numberOfItems :number

Query parameter: 'total' (Java type: long) (optional) Number of items (in the list) to include in this page.
Type:
  • number
Since:
  • 4.0.0
Default Value:
  • = 100

order :string

Query parameter: 'order' (optional) Sort criteria.
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = ""

startPosition :number

Query parameter: 'start' (Java type: long) (optional) Position in the list from which to start this page.
Type:
  • number
Since:
  • 4.0.0
Default Value:
  • = 0