SOAP API - getCalendarReferences

The table summarizes the SOAP API - getCalendarReferences.

Request Uses the getCalendarReferences element (from the OrgModelService schema)
Parameter notes
  • model-version: Can be obtained using listOrgModelVersions.
  • entity-type: Note that the getCalendarReferences element indicates that entity-type is a required parameter. However, you can omit entity-type and just identify the required organization model entity by its GUID. (This is because entity-type is defined within the XmlModelEntityId shared element. Its use is mandatory with other operations.)
  • guid: Can be obtained using getOrgModel.
Response Returns a getCalendarReferencesResponse 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:getCalendarReferences model-version="-1"  guid="_36QRkMoOEeG-IPt6GUFXxA">
      </org:getCalendarReferences>
   </soapenv:Body>
</soapenv:Envelope>
Response: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <getCalendarReferencesResponse xmlns="http://orgmodel.api.de.bpm.tibco.com">
         <calendar calendar-alias="standard" entity-guid="_36QRkMoOEeG-IPt6GUFXxA" entity-label="Sales" entity-name="Sales" entity-type="ORGANIZATIONAL_UNIT" model-version="9" xmlns=""/>
      </getCalendarReferencesResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>