pp108 : GetUnitsForAssignments

GetUnitsForAssignments

This method returns organization units of a particular assignment. You can apply filters using any strings, for example, unit name, or can use regular expressions, to easily find the required units.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <GetUnitsForAssignments xmlns="http://schemas.cordys.com/userassignment/UserAssignmentService/1.0">
            <WorkspaceID>002481F0-8E9F-11E2-EE36-A5EED1105F38</WorkspaceID>
            <AssignmentRoot>[Assignment Root]</AssignmentRoot>
            <Filter/>
            <UseRegEx>false</UseRegEx>
        </GetUnitsForAssignments>
    </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

AssignmentRoot

Assignment root ID. GUID retrieved from InitializeAssignmentRoot must be used.

Yes

GUID

Filter

Filter used to select a subset of the organization units. It is applied on the name of the unit.

No

String or Regular expression

UseRegEx

Regular expression is defined in the Filter element

Yes

If the value provided is:

  • true - filter provided in the request is considered as a regular expression.
  • false - filter provided in the request is considered as a string, and not as a regular expression.

SOAP Response

<GetUnitsForAssignmentsResponse xmlns="http://schemas.cordys.com/userassignment/UserAssignmentService/1.0">
    <GetUnitsForAssignments>
        <dataset xmlns="http://schemas.cordys.com/userassignment/UserAssignmentService/1.0">
            <tuple>
                <old>
                    <Unit>
                        <ID>001CC438-906D-11E2-EECC-49936ED1DF4B</ID>
                        <Name>college</Name>
                        <QName>teams/college</QName>
                        <Description>college</Description>
                        <Deleted>false</Deleted>
                        <Space>organization</Space>
                    </Unit>
                </old>
            </tuple>
            <tuple>
                <old>
                    <Unit>
                        <ID>001CC438-906D-11E2-EECC-49936ED0DF4B</ID>
                        <Name>school</Name>
                        <QName>teams/school</QName>
                        <Description>school</Description>
                        <Deleted>false</Deleted>
                        <Space>organization</Space>
                    </Unit>
                </old>
            </tuple>
        </dataset>
    </GetUnitsForAssignments>
</GetUnitsForAssignmentsResponse>
Response Parameters

Parameter

Description

ID

ID of the organization unit

Name

Name of the organization unit

QName

Fully Qualified Name (FQN) of the organization unit

Description

Description of the unit as provided when it is defined

Deleted

Organization unit is available or undeployed. If the value is 'true', it indicates that the unit has been undeployed.

Space

Deployment space of the organization unit. For example: 'organization' or 'isv'.