pp108 : getUnitDetails

getUnitDetails

This method returns the details of a unit. The details consists of unit ID, name, description, qualified name, and space, where it is deployed and the lead role DN.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <getUnitDetails xmlns="http://schemas.cordys.com/orgmodel/runtime/OrgModel/1.0">
            <WorkspaceID>002481F0-8E9F-11E2-EE36-A5EED1105F38</WorkspaceID>
            <unitId>001CC438-906D-11E2-EE38-EEEA14C33636</unitId>
            <unitQName>organization unit/college</unitQName>
            <hierarchyDepth>2</hierarchyDepth>
        </getUnitDetails>
    </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

unitID

Document ID of the unit

Yes. Either UnitID or UnitQName.

GUID. If it is provided, returns the unit corresponding to the given UnitID

unitQName

Fully Qualified Name (FQN) of the unit

Yes. Either UnitID or UnitQName.

If both UnitID and UnitQName are specified, it returns the unit corresponding to the given UnitID. However, if no unit exists for the given UnitID, it returns the unit corresponding to the given UnitQName.

hierarchyDepth

Number of sequential parent units that need to be retrieved from the hierarchy

No

If the value is greater than zero, the hierarchy is retrieved depending on the specified depth such as the parent, grand-parent, and so on.

SOAP Response

<getUnitDetailsResponse xmlns="http://schemas.cordys.com/orgmodel/runtime/OrgModel/1.0">
    <getUnitDetails>
        <UnitDetails>
            <UnitInfo>
                <UnitID>001CC438-906D-11E2-EE38-EEEA14C33636</UnitID>
                <UnitName>college</UnitName>
                <UnitQName>organization unit/college</UnitQName>
                <UnitDescription>college</UnitDescription>
                <Space>organization</Space>
                <LeadRoleDN>cn=principal,cn=organizational roles,o=system,cn=cordys,cn=defaultInst,o=vanenburg.com</LeadRoleDN>
                <ChildUnits/>
            </UnitInfo>
        </UnitDetails>
    </getUnitDetails>
</getUnitDetailsResponse>
Response Parameters

Parameter

Description

UnitID

ID of the unit document

UnitName

Unit name

UnitQName

Unit qualified name

UnitDescription

Unit description

Space

Space where the unit is deployed ('organization' or 'isv')

LeadRoleDN

DN of the lead role in the following format: cn=My_role,cn=my-isvp,cn=cordys,cn=Env1,o=cordys.com

ChildUnitID

Document ID of the child unit

ParentUnitID

Document ID of the parent unit