pp108 : getChildUnits

getChildUnits

This method returns the child units of a unit along with the roles of the child unit, as per the specified hierarchy.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <getChildUnits xmlns="http://schemas.cordys.com/orgmodel/runtime/OrgModel/1.0">
            <WorkspaceID>002481F0-8E9F-11E2-EE36-A5EED1105F38</WorkspaceID>
            <unitName>Production</unitName>
            <hierarchyDepth>1</hierarchyDepth>
            <includeRoles>cn=Production Engineer,cn=organizational roles,o=UserTeamAPI,cn=cordys,cn=build250,o=vanenburg.com</includeRoles>
        </getChildUnits>
    </SOAP:Body>
</SOAP:Envelope>
Request Parameters

Parameter

Description

Mandatory

Accepted Input Value
WorkspaceID Unique and valid ID of the Collaborative Workspace (CWS) No GUID or null

unitName

Name of the unit

Yes

ID or qualified name of the unit

hierarchyDepth

Number of child levels to be returned

No

Hierarchy depth

includeRoles

Roles of the units that need to returned

Yes

true or false

SOAP Response

<getChildUnitsResponse xmlns="http://schemas.cordys.com/orgmodel/runtime/OrgModel/1.0">
    <getChildUnits>
        <ChildUnitDetails>
            <UnitInfo depth="1">
                <UnitID>001C23B0-2B17-11E0-EC3A-1371C2E4D748</UnitID>
                <UnitQName>Teams/Production</UnitQName>
                <UnitDescription>Production</UnitDescription>
                <LeadRoleDN>cn=Production Manager,cn=organizational roles,o=UserTeamAPI,cn=cordys,cn=build250,o=vanenburg.com</LeadRoleDN>
                <Roles>
                    <Role>cn=Production Engineer,cn=organizational roles,o=UserTeamAPI,cn=cordys,cn=build250,o=vanenburg.com</Role>
                </Roles>
                <ChildUnits>
                    <ChildUnitQName>Teams/TestTeam</ChildUnitQName>
                </ChildUnits>
                <ParentUnitQName>Teams/MainOffice</ParentUnitQName>
            </UnitInfo>
            <UnitInfo>
        ...
      </UnitInfo>
      ...
    </ChildUnitDetails>
    </getChildUnits>
</getChildUnitsResponse>
Response Parameters

Parameter

Description

depth

Child level starting from 1

UnitID

ID of the unit document

UnitQName

Qualified name of the unit

UnitDescription

Description about the unit

LeadRoleDN

Role DN of the lead role

Roles

Roles within the unit, except the lead role DN

Role

DN of the role. For example, cn=My_role,cn=my-isvp,cn=cordys,cn=Env1,o=cordys.com

ChildUnits

Child units

ChildUnitQName

Qualified name of the child unit

ParentUnitQName

Qualified name of the parent unit