pp108 : GetAssignments

GetAssignments

This method returns the user assignments. The assignments can be selected based on the unit, role, or user; or a combination of the three.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <GetAssignments xmlns="http://schemas.cordys.com/userassignment/UserAssignmentService/1.0">
            <WorkspaceID>002481F0-8E9F-11E2-EE36-A5EED1105F38</WorkspaceID>
            <AssignmentRoot>[Assignment Root]</AssignmentRoot>
            <UnitID>001CC438-906D-11E2-EECC-49936ED1DF4B</UnitID>
            <RoleDN>cn=principal,cn=organizational roles,o=system,cn=cordys,o=orr.com</RoleDN>
            <UserDN>cn=tester1,cn=organizational users,o=system,cn=cordys,o=orr.com</UserDN>
            <Filter/>
            <cursor/>
            <EffectiveOnly>false</EffectiveOnly>
        </GetAssignments>
    </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

UnitID

Assignments for this organization unit; if empty, it returns for all units

Yes

GUID

RoleDN

Assignments for this role DN; if empty, returns for all roles

Yes

DN cn=My_role,cn=my-isvp,cn=cordys,cn=Env1,o=cordys.com

UserDN

Assignments for this user DN; if empty, returns for all users

Yes

DN cn=$userName,cn=organizational users,o=system,cn=cordys,cn=$instanceName,o=$domain

Filter

Not used

No

Empty

cursor

Not used

No

Empty

EffectiveOnly

Effectiveness of assignments

Yes

If the value provided is:

  • true - command returns effective assignments only
  • false - command returns all assignments

SOAP Response

<GetAssignmentsResponse xmlns="http://schemas.cordys.com/userassignment/UserAssignmentService/1.0">
    <GetAssignments>
        <dataset xmlns="http://schemas.cordys.com/userassignment/UserAssignmentService/1.0">
            <tuple>
                <old>
                    <Assignment xmlns="http://schemas.cordys.com/userassignment/UserAssignmentService/1.0">
                        <ID>001CC438-906D-11E2-EECC-951E26303F4B</ID>
                        <UserDN>cn=tester1,cn=organizational users,o=system,cn=cordys,o=orr.com</UserDN>
                        <EffectiveDate>2013-02-13T00:00:00.0000</EffectiveDate>
                        <FinishDate>2013-02-22T05:09:05.000</FinishDate>
                        <IsPrincipalUnit>true</IsPrincipalUnit>
                        <IsEffective>yes</IsEffective>
                        <UnitID>001CC438-906D-11E2-EECC-49936ED1DF4B</UnitID>
                        <QName>teams/college</QName>
                        <Name>001CC438-906D-11E2-EECC-49936ED1DF4B</Name>
                        <RoleDN>cn=principal,cn=organizational roles,o=system,cn=cordys,o=orr.com</RoleDN>
                        <UnitRoleID>001CC438-906D-11E2-EECC-951E262FFF4B</UnitRoleID>
                        <IsLeadRole>true</IsLeadRole>
                        <AssignmentRoot>001CC438-906D-11E2-EECC-8FE3BE469F4B</AssignmentRoot>
                    </Assignment>
                </old>
            </tuple>
            <tuple>
                <old>
        ...
        </old>
            </tuple>
    ...
    </dataset>
    </GetAssignments>
</GetAssignmentsResponse>
Response Parameters

Parameter

Description

ID

ID of the Assignment

UserDN

DN of the User cn=$userName,cn=organizational users,o=system,cn=cordys,cn=$instanceName,o=$domain

EffectiveDate

Date on which the assignment starts. If there is no start date, the effective date is taken as the default date

FinishDate

Date on which when the assignment ends. If there is no finish date, the assignment does not end

IsPrincipalUnit

Organization unit is the principal unit of the user (true or false)

IsEffective

Assignment is valid, based on the calculations from the EffectiveDate and the FinishDate (true or false)

UnitID

ID of the organization unit

QName

 Fully Qualified Name (FQN) of the organization unit
Name Name of the organization unit

RoleDN

DN of the Role cn=My_role,cn=my-isvp,cn=cordys,cn=Env1,o=cordys.com

UnitRoleID

ID of the unit-role combination

IsLeadRole

Given role is lead role of this unit or not (true or false)

AssignmentRoot

ID of the Assignment root