pp108 : InitializeAssignmentRoot

InitializeAssignmentRoot

This method returns an assignment root ID based on the assignment root name. The assignment root ID is required in many of the User Assignment APIs. The details on the assignment root can be found here.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <InitializeAssignmentRoot xmlns="http://schemas.cordys.com/userassignment/UserAssignmentService/1.0">
            <WorkspaceID>002481F0-8E9F-11E2-EE36-A5EED1105F38</WorkspaceID>
            <AssignmentRoot>CIUIROOT</AssignmentRoot>
            <Create>true</Create>
        </InitializeAssignmentRoot>
    </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

ID Assignment root

Yes

Accepts all string values but in the standard Process Platform installation, the assignment root named CIUIRoot is used

Create

Creation of the assignment root

Yes

If the value provided is:

  • true - creates an assignment root if it does not exist
  • false - does not create the assignment root if it does not exist

SOAP Response

<InitializeAssignmentRootResponse xmlns="http://schemas.cordys.com/userassignment/UserAssignmentService/1.0">
    <InitializeAssignmentRoot>001CC438-906D-11E2-EECD-7A0F8E477F4B</InitializeAssignmentRoot>
</InitializeAssignmentRootResponse>
Response Parameters

Parameter

Description

InitializeAssignmentRoot

ID of the assignment root (GUID)

This ID is used in all User Assignment APIs.