listBusinessServiceCategories

This request returns a list of all valid business service categories.

Syntax

com.tibco.wcc.base.Requests.listBusinessServiceCategories(requestId,
                                                          channelId,
                                                          includeFormalParams);

Parameters

  • requestId - (String) Uniquely identifies the request. For more information, see Submitting Server Requests.
  • channelId - (String) Identifies the presentation channel. Note that for WCC applications, always pass the results of this.getChannelId() in this parameter.
  • includeFormalParams - (boolean) (optional: default = false) If true, business services with formal parameters are included in the result.

Returns

Returns an <ap:Category> element for each business service category. Each <ap:Category> element contains the following elements:

  • <ap:Name> - The name of the business service category.
  • <ap:ChildCategories> - This element can contain additional <ap:Category> elements for nested business service categories.

For example:

<ap:Requests>
  <ap:ListBusinessServiceCategories Id="ApiSample.listBusinessServiceCategories">
    <ap:Categories>
      <ap:Category>
        ap:Name>Acme</ap:Name>
        <ap:ChildCategories>
          <ap:Category>
            <ap:Name>Common Fields</ap:Name>
            <ap:ChildCategories />
          </ap:Category>
        </ap:ChildCategories>
      </ap:Category>
              .
              .
              .
    </ap:Categories>
  </ap:ListBusinessServiceCategories>
</ap:Requests>