SOAP API - calcDeadline

The table summarizes the SOAP API - calcDeadline.

Request Uses the calcDeadline element (from the BusinessDeadlineService schema)
Parameter notes
  • start-date-time  the date and time when the task begins, specified as UTC.
  • duration  the duration of the task, defined as in RFC-5545. A duration that does not include a time element — hours, minutes, or seconds — is assumed to be in working days. See Duration Definitions .
  • calendar-lookup  there may be any number of calendar-lookup entries, and each of them contains a calendar-ref and optionally an org-model entity.
    • calendar-ref  a calendar reference. See resolveReferences for details.
    • org-model entity  Information to identify an organizational entity. These are used to determine what base and overlay calendars should be used in the calculation.
      • dynamic-id-attr - When the holder of the calendar is a dynamically generated organization entity, the GUID in the request is that of the Dynamic Org-Template entity from which the dynamic entity was generated, and the request must include name/value pairs in <dynamic-id-attr> in order to identify the particular dynamically generated organization entity.

        The names of these additional attributes are defined on the Dynamic Organization Template, at design time (Dynamic Organization Identifiers); and the values must match those for a particular generated instance.

        Although the values are optional, if no value is given it will only match against a dynamic organizational entity with a null value for the same attribute.

Response Returns a calcDeadlineResponse element (from the BusinessDeadlineService schema).
  • end-date-time  the date and time when the task should end, specified as UTC.
Example Request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dead="http://deadline.api.dac.n2.tibco.com">
   <soapenv:Header />
   <soapenv:Body>
      <dead:calcDeadline start-date-time="2017-10-31T10:30:00" duration="P2D">
         <calendar-lookup>
            <org-model-entity model-version="1" entity-type="MODEL_POSITION" guid="__a7z4OoLEeaHwJBHuGSOmw">
               <dynamic-id-attr name="city" value="London" />
            </org-model-entity>
         </calendar-lookup>
      </dead:calcDeadline>
   </soapenv:Body>
</soapenv:Envelope>
Response: 
<SOAP-ENV:Body>
      <calcDeadlineResponse end-date-time="2017-10-31T10:30:00" xmlns="http://deadline.api.dac.n2.tibco.com"/>
</SOAP-ENV:Body>