SOAP API - setCandidateQueries

The table summarizes the SOAP API - setCandidateQueries.

Request Uses the setCandidateQueries element (from the OrgModelService schema)
Parameter notes Use getOrgModel with the include-candidate-queries parameter set to "true" to get parameters needed for setCandidateQueries.
Response Returns a setCandidateQueriesResponse element (from the OrgModelService schema)
Example

Assigning
Candidate
Query

 Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:org="http://orgmodel.api.de.bpm.tibco.com">

   <soapenv:Header/>

   <soapenv:Body>

      <org:setCandidateQueries>

         <assignment container-id="73" query="(objectclass=person)" base-dn="ou=London" search-scope="ONELEVEL">

            <position>_aPaNYHnvEeOXwIHqtnmxgg</position>

         </assignment>

         <assignment container-id="73" query="(objectclass=person)" base-dn="ou=Swindon" search-scope="ONELEVEL">

            <group>_E33q8GfOEeOiGOb4k4LDUg</group>

         </assignment>

      </org:setCandidateQueries>

   </soapenv:Body>

</soapenv:Envelope>
Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

   <SOAP-ENV:Header/>

<SOAP-ENV:Body>

      <setCandidateQueriesResponse xmlns="http://orgmodel.api.de.bpm.tibco.com"/>

   </SOAP-ENV:Body>

</SOAP-ENV:Envelope>
Example

Removing
Candidate
Query

 Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:org="http://orgmodel.api.de.bpm.tibco.com">

   <soapenv:Header/>

   <soapenv:Body>

      <org:setCandidateQueries>

         <remove>

            <group>_Jb8oYMpREd64gM7QE8RwxA</group>

         </remove>

      </org:setCandidateQueries>

   </soapenv:Body>

</soapenv:Envelope>
  Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

   <SOAP-ENV:Header/>

   <SOAP-ENV:Body>

      <setCandidateQueriesResponse xmlns="http://orgmodel.api.de.bpm.tibco.com"/>

   </SOAP-ENV:Body>

</SOAP-ENV:Envelope>
Contents
Search Results