workItemFilterSortFields

Syntax

com.tibco.wcc.base.Requests.workItemFilterSortFields(requestId);

Parameters

• requestId - (String) Uniquely identifies the request. For more information, see Submitting Server Requests.

Returns

Returns an <ap:Field> element for each filterable and sortable field. The <ap:Field> element contains the following elements:

• <ap:ID> - Identifies the field in this list. The ID starts at 1 and increases by 1 for each field in the list returned by the workItemFilterSortFields request.
• <ap:Name> - The name of the field.
• <ap:Description> - The description of the field.
• <ap:Type> - Describes the type of data in the field: COL_STRING, COL_NUMERIC, COL_DATETIME, COL_BOOLEAN, COL_STATE, or COL_DISTSTRATEGY.
• <ap:IsSortField> - true = field is sortable; false = field is not sortable.
• <ap:IsFilterField> - true = field is filterable; false = field is not filterable.

For example:

<ap:Requests>
   <ap:Fields Id="ApiSample.workItemFilterSortFields">
      <ap:Field>
         <ap:ID>1</ap:ID>
         <ap:Name>id</ap:Name>
         <ap:Description>The integer value that denotes the ID of the work item.         </ap:Description>
         <ap:Type>COL_NUMERIC</ap:Type>
         <ap:IsSortField>true</ap:IsSortField>
         <ap:IsFilterField>true</ap:IsFilterField>
      </ap:Field>
              .
              .
              .
   </ap:Fields>
</ap:Requests>