Service: zimbraMail
Namespace: "urn:zimbraMail"
CompleteTaskInstance SOAP Command

Complete a task instance

Authorization token required true
Admin Authorization token required false

CompleteTaskInstanceRequest

    <CompleteTaskInstanceRequest id="{id}"> ## CompleteTaskInstanceRequest
        <exceptId [d="{YYYYMMDD['T'HHMMSS[Z]]}"] [tz="{timezone-identifier}"] [u="{utc-time} (Long)"] /> ## DtTimeInfo
        <tz id="{timezone-id}" stdoff="{timezone-std-offset} (Integer)" dayoff="{timezone-daylight-offset} (Integer)"
                [stdname="..."] [dayname="..."]> ## CalTZInfo
            <standard [week="{tzonset-week} (Integer)"] [wkday="{tzonset-day-of-week} (Integer)"]
                          mon="{tzonset-month} (Integer)" [mday="{tzonset-day-of-month} (Integer)"]
                          hour="{tzonset-hour} (Integer)" min="{tzonset-minute} (Integer)" sec="{tzonset-second} (Integer)" /> ## TzOnsetInfo
            <daylight ... /> ## See /tz/standard [ ## TzOnsetInfo]
         </tz>
    </CompleteTaskInstanceRequest>

The following table describes elements and attributes you can define within a <CompleteTaskInstanceRequest> element:

XPath Required / Optional Description
@id Required (only 1) Type:String
ID
/exceptId Required (only 1) Exception ID
/exceptId@d Optional (0 or 1) Type:String
Date and/or time. Format is : YYYYMMDD['T'HHMMSS[Z]]
where:
     YYYY - 4 digit year
     MM   - 2 digit month
     DD   - 2 digit day
 Optionally:
     'T' the literal char "T" then
     HH - 2 digit hour (00-23)
     MM - 2 digit minute (00-59)
     SS - 2 digit second (00-59)
     ...and finally an optional "Z" meaning that the time is UTC,
     otherwise the tz="TIMEZONE" param MUST be specified with the DATETIME
     e.g:
         20050612  June 12, 2005
         20050315T18302305Z  March 15, 2005 6:30:23.05 PM UTC
 
/exceptId@tz Optional (0 or 1) Type:String
Java timezone identifier
/exceptId@u Optional (0 or 1) Type:Long
UTC time as milliseconds since the epoch. Set if non-all-day
/tz Optional (0 or 1) Timezone information
/tz@id Required (only 1) Type:String
Timezone ID. If this is the only detail present then this should be an existing server-known timezone's ID Otherwise, it must be present, although it will be ignored by the server
/tz@stdoff Required (only 1) Type:Integer
Standard Time's offset in minutes from UTC; local = UTC + offset
/tz@dayoff Required (only 1) Type:Integer
Daylight Saving Time's offset in minutes from UTC; present only if DST is used
/tz@stdname Optional (0 or 1) Type:String
Standard Time component's timezone name
/tz@dayname Optional (0 or 1) Type:String
Daylight Saving Time component's timezone name
/tz/standard Optional (0 or 1) Time/rule for transitioning from daylight time to standard time. Either specify week/wkday combo, or mday.
/tz/standard@week Optional (0 or 1) Type:Integer
Week number; 1=first, 2=second, 3=third, 4=fourth, -1=last
/tz/standard@wkday Optional (0 or 1) Type:Integer
Day of week; 1=Sunday, 2=Monday, etc.
/tz/standard@mon Required (only 1) Type:Integer
Month; 1=January, 2=February, etc.
/tz/standard@mday Optional (0 or 1) Type:Integer
Day of month (1..31)
/tz/standard@hour Required (only 1) Type:Integer
Transition hour (0..23)
/tz/standard@min Required (only 1) Type:Integer
Transition minute (0..59)
/tz/standard@sec Required (only 1) Type:Integer
Transition second; 0..59, usually 0
/tz/daylight Optional (0 or 1) Time/rule for transitioning from standard time to daylight time
See /tz/standard for more details.

CompleteTaskInstanceResponse

    <CompleteTaskInstanceResponse /> ## CompleteTaskInstanceResponse