SOAP API - updatePushDestinations

The table summarizes the SOAP API - updatePushDestinations.

Request Uses the updatePushDestinations element (from the OrgModelService schema)
Parameter notes
  • model-version: Can be obtained using listOrgModelVersions .
  • guid: Can be obtained using getOrgModel and getCalendarReferences .
  • channel-type: An enumerated value associated with that channel type, for example, EmailChannel, MobileChannel, and openspaceChannel. For more information, see Identifying the Client Channel in a Service Call .
  • channel-id: Uniquely identifies the presentation channel to use when pushing work items. The channel ID is defined when a presentation channel is defined in TIBCO Business Studio. For more information, see the TIBCO Business Studio documentation, as well as Identifying the Client Channel in a Service Call and "Configuring the Email Presentation Channel" in the TIBCO ActiveMatrix BPM - BPM Administration guide.
Response Returns an updatePushDestinationsResponse element (from the OrgModelService schema)
Example 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:updatePushDestinations model-version="9" entity-type="RESOURCE" guid="27F2BC92-816E-4C7E-A4B7-23018E151873" >
         <set-destination name="Office" channel-type="EmailChannel" channel-id="openspaceEmailPush_DefaultChannel" enabled="true">
            <value>supportMrg@megaCorp.com</value>
         </set-destination>
      </org:updatePushDestinations>
   </soapenv:Body>
</soapenv:Envelope>
Response:
<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>