pp108 : GetNrAssignments

GetNrAssignments

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

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP:Body>
    <GetNrAssignments 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=mnagarjuna,cn=organizational users,o=system,cn=cordys,o=orr.com</UserDN>
      <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

Number of assignments for this unit ID. If empty, returns the count for all units.

Yes

ID of a unit, usually GUID, which is retrieved using the getUnits API.

RoleDN

Number of assignments for this role DN. If empty, returns the count for all roles.

Yes

Distinguished Name of a role. For example, cn=cordysrole,cn=organizational roles,o=system,cn=cordys,cn=build1,o=vanenburg.com.

UserDN

Number of assignments for this user DN. If empty, returns the count for all users.

Yes

Distinguished Name of the user. For example, cn=cordysuser,cn=organizational users,o=development,cn=cordys,cn=build1,o=vanenburg.com.

EffectiveOnly

Count of the assignments are to be based on valid assignments.

Yes
  • If true - counts only valid assignments
  • If false - counts all the assignments

SOAP Response

<GetNrAssignmentsResponse xmlns="http://schemas.cordys.com/userassignment/UserAssignmentService/1.0">
    <GetNrAssignments>1</GetNrAssignments>
</GetNrAssignmentsResponse>
Response Parameters

Parameter

Description

GetNrAssignments

Number of assignments found