Updating Push Destinations for Organizational Entities

Calls to OrgModelService APIs can be used to update push destinations for organizational entities.

See also: OrgModelService

Updating Push Destinations for Organizational Entities

The following step-by-step descriptions correspond to the numbered steps in Figure 10. Note that the descriptions are from a web service operation point of view, and provide an example of performing the operations using the web service API (SOAP). (For an equivalent example using the Service Connector API (Java), see Updating Push Destinations for Organizational Entities — Service Connector API Example (Java).)

Procedure

  1. Use the getOrgModel operation to get details about the entities in an organization model.

    The request identifies the major version number of the organization model, which can be obtained using the listOrgModelVersions operation.

    The response from the getOrgModel operation provides GUIDs for all entities in the specified version of the organization model. 

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:org="http://orgmodel.api.de.bpm.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <org:getOrgModel model-version="9" include-resource-counts="false" include-calendar-alias="false"/>
   </soapenv:Body>
</soapenv:Envelope>
    		 
    <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <getOrgModelResponse model-version="9" xmlns="http://orgmodel.api.de.bpm.tibco.com">
         <organization guid="_uxf9UcoOEeG-IPt6GUFXxA" label="Acme Incorporated" name="AcmeIncorporated" xmlns="">
            <allocation-method method="ANY"/>
            <org-unit guid="_36QRkMoOEeG-IPt6GUFXxA" label="Sales" name="Sales">
               <allocation-method method="ANY"/>
               <position guid="_-j8iYMoOEeG-IPt6GUFXxA" ideal-number="1" label="Sales Rep" name="SalesRep">
                  <allocation-method method="ANY"/>
               </position>
               <position guid="_8lLvoMoOEeG-IPt6GUFXxA" ideal-number="1" label="Sales Manager" name="SalesManager">
                  <allocation-method method="ANY"/>
               </position>
            </org-unit>
            <org-unit guid="_DFy88MoPEeG-IPt6GUFXxA" label="Support" name="Support">
               <allocation-method method="ANY"/>
                     .
                     .
                     .
               </position>
               <position guid="_RcJ-gMoPEeG-IPt6GUFXxA" ideal-number="1" label="IT Rep" name="ITRep">
                  <allocation-method method="ANY"/>
               </position>
            </org-unit>
         </organization>
      </getOrgModelResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  2. Use the updatePushDestinations operation to set push destinations for the desired organizational entities.

    An empty response indicates a successful execution. 

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:org="http://orgmodel.api.de.bpm.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <org:updatePushDestinations model-version="9" entity-type="POSITION" guid="_8lLvoMoOEeG-IPt6GUFXxA"  > <set-destination name="Office" channel-type="EmailChannel" channel-id="openspaceEmailPush_DefaultChannel" enabled="true" > <value > salesMrg@megaCorp.com</value > </set-destination > </org:updatePushDestinations
   </soapenv:Body>
</soapenv:Envelope>
    		 
    <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <updatePushDestinationsResponse xmlns="http://orgmodel.api.de.bpm.tibco.com"/>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>