listSupervisedWorkItems

Syntax

com.tibco.wcc.base.Requests.listSupervisedWorkItems(requestId,
                                            numStartIndex,
                                            numReturnCount,
                                            txtFilter,
                                            txtSort,
                                            txtEntityType,
                                            txtEntityGuid,
                                            selSupervisedWorkItemState,
                                            txtEntityModelVersion,
                                            txtEntityQualifier);

Parameters

• requestId - (String) Uniquely identifies the request. For more information, see Submitting Server Requests.
• numStartIndex - (Number) Index of the first item to return.
• numReturnCount - (Number) The number of work items to return.
• txtFilter - (String) The filter expression to apply to determine the work items to return. For information about filter syntax, see the "Sorting and Filtering Work Item Lists" topic in the developer's guide for your BPM runtime environment.

  For example:

  startDate < 2011-03-11T00:00:00.000-08:00

• txtSort - (String) The sort order to apply to the work items returned. Specify the sort field, following by either ASC or DESC, for ascending or descending, respectively. Separate multiple sort fields with commas. For example:

  priority ASC, startDate DESC

  Use the following sort field names in the txtSort parameter:

  Attribute	Sort field name
  Attribute #1 - Attribute #40	attribute1 - attribute40
  Distribution Strategy	distributionStrategy
  Target Date	endDate
  Instance Description	appInstanceDescription
  ID	appInstance
  Priority	priority
  Process Template	appName
  Start Date	startDate
  Work Item ID	id

• txtEntityType - (String) Identifies the type of supervised organizational entity (RESOURCE, GROUP, POSITION, ORGANIZATION_UNIT or ORGANIZATION).
• txtEntityGuid - (String) The GUID for the organizational entity.
• selSupervisedWorkItemState - (String) - Identifies the state of the work items that are to be returned: 'Allocated' or 'Offered'.
• txtEntityModelVersion - (String) The version of the organizational model that contains the organizational entity — not applicable to the RESOURCE entity type. Passing -1 causes it to use the most recent version.
• txtEntityQualifier - (String) This is not currently used.

Returns

This request returns the same elements as the listWorkItems request — for information, see listWorkItems.

For example:

<ap:Requests>
  <ap:ListWorkItems Id="ApiSample.listSupervisedWorkItems">
    <ap:StartPosition>0</ap:StartPosition>
    <ap:EndPosition>3</ap:EndPosition>
    <ap:TotalItems>4</ap:TotalItems>
    <ap:WorkItems>
      <ap:WorkItem>
        <ap:ID>7</ap:ID>
        <ap:Version>10</ap:Version>
        <ap:Name>ConfirmResolution</ap:Name>
        <ap:Description>Confirm Resolution</ap:Description>
        <ap:StartDate>2011-02-23T17:08:11.780-08:00</ap:StartDate>
        <ap:EndDate />
        <ap:DistributionStrategy>OFFER</ap:DistributionStrategy>
        <ap:Priority>50</ap:Priority>
        <ap:GroupID>0</ap:GroupID>
        <ap:ActivityID>pvm:001iv</ap:ActivityID>
        <ap:ActivityName>ConfirmResolution</ap:ActivityName>
        <ap:AppID>_-rTukV60Ed-KqJmYNEw8ow</ap:AppID>
        <ap:AppInstance>pvm:0a123</ap:AppInstance>
        <ap:AppInstanceDescription />
        <ap:AppName>HelpDeskProcess</ap:AppName>
        <ap:ScheduleStatus>DURING</ap:ScheduleStatus>
        <ap:State>OFFERED</ap:State>
        <ap:WorkTypeID />
        <ap:WorkTypeUID />
        <ap:WorkTypeVersion />
        <ap:WorkTypeDescription />
        <ap:Visible>true</ap:Visible>
        <ap:Attributes />
      </ap:WorkItem>
             .
             .
             .
    </ap:WorkItems>
  </ap:ListWorkItems>
</ap:Requests>