listOrgModelOverview

Syntax

com.tibco.wcc.base.Requests.listOrgModelOverview(requestId,
                                                 modelGuid);

Parameters

• requestId - (String) Uniquely identifies the request. For more information, see Submitting Server Requests.
• modelGuid - (String) The GUID of the organization model version to be returned. Passing -1 causes the latest version to be returned.

Returns

An <ap:Node> element is returned for each entity in the organization model. These nodes are nested according to the hierarchy of the organization model (for instance, positions are subordinate to organization units). The <ap:Node> element contains the following elements:

• <ap:Type> - The type of organizational entity: “ORGANIZATION”, “ORGANIZATIONAL_UNIT”, “POSITION”, “GROUP”, or “LOCATION”.
• <ap:Guid> - The GUID for the organizational entity.
• <ap:Name> - The name of the organizational entity.
• <ap:AllocationMethod> - Indicates how work items are allocated to user. This is either one of the following:
  • ANY - Random
  • NEXT - Round Robin
• <ap:LocationGuid> - The GUID of the location to which the organizational entity is associated.
• <ap:ResourceCount> - The number of resources currently mapped to the organizational entity.
• <ap:IdealNumber> - The ideal number of resources that should be assigned to the position (only applicable to positions) as defined in TIBCO Business Studio.

For example:

<ap:Requests>
  <ap:ListOrgModelOverview Id="ApiSample.listOrgModelOverview">
    <ap:OrgModelOverview ModelVersion="-1">
      <ap:Node>
        <ap:Type>ORGANIZATION</ap:Type>
        <ap:Guid>_iPYXscpPEd64gM7QE8RwxA</ap:Guid>
        <ap:Name>Acme</ap:Name>
        <ap:AllocationMethod>ANY</ap:AllocationMethod>
        <ap:LocationGuid>_gqt1EMpREd64gM7QE8RwxA</ap:LocationGuid>
        <ap:ResourceCount>0</ap:ResourceCount>
        <ap:IdealNumber>0</ap:IdealNumber>
        <ap:Node>
          <ap:Type>ORGANIZATIONAL_UNIT</ap:Type>
          <ap:Guid>_oA-4AMpREd64gM7QE8RwxA</ap:Guid>
          <ap:Name>AcmeInsurance</ap:Name>
          <ap:AllocationMethod>ANY</ap:AllocationMethod>
          <ap:LocationGuid>_iqRSAMpREd64gM7QE8RwxA</ap:LocationGuid>
          <ap:ResourceCount>0</ap:ResourceCount>
          <ap:IdealNumber>0</ap:IdealNumber>
          <ap:Node>
            <ap:Type>ORGANIZATIONAL_UNIT</ap:Type>
            <ap:Guid>_sXK1IMpREd64gM7QE8RwxA</ap:Guid>
            <ap:Name>IT</ap:Name>
            <ap:AllocationMethod>ANY</ap:AllocationMethod>
            <ap:LocationGuid>_gqt1EMpREd64gM7QE8RwxA</ap:LocationGuid>
            <ap:ResourceCount>0</ap:ResourceCount>
            <ap:IdealNumber>0</ap:IdealNumber>
                 .
                 .
                 .
    </ap:OrgModelOverview>
  </ap:ListOrgModelOverview>
</ap:Requests>