Tasks API

Common objects - Task object

OVERVIEW

Parameter Type Description

taskid

Integer

This will be used in response for the get all task API.

ID of the Task
siteid

Integer

This will used in response for the get all task and get task API.

Parameter to indicate which site the task belongs to.
title
 

String

This will be used in request for the add task and edit task API.

 For add task, title is mandatory.

 For edit task, title is optional.

This will be used in response for the get all task and get task API.

 Title of the task 
description

String

This will be used in request for the add task and edit task API.

description is optional for add task and edit task API.

This will be used in response for the get task API.

A CDATA field to send the description of the task.
duedate

Date

This will be used in request for the add task and edit task API.

duedate is optional for add task and edit task API.

This will be used in response for the get all task and get task API.

 A UTC date indicating the due date for the task. The format should be the same as used in the web based interface.
list

Object

This will be used in request for the edit task API.

list is optional for edit task API.

This will be used in response for the get all task and get task API.

 Object for a task list. The list should already exist, if a new list is required then the task list API endpoint should be called to create a new task list
assignees

Object

This will be used in request for the add task and edit task API.

assignees is optional for add task and edit task API.

This will be used in response for the get all task and get task API.

 Object of users / groups to which the task should be assigned to
priority

Object

This will be used in request for the add task and edit task API.

For add task, priority is mandatory.

For edit task, priority is optional.

This will be used in response for the get all task and get task API. 

Object for priority which consist of priorityid, must be an integer value representing one of the possible values:

Low (1), Normal (2) , High (3) .

Default is Normal (2)
status

Object

This will be used in request for the add task and edit task API.

For add task, status is mandatory.

For edit task, status is optional.

This will be used in response for the get all task and get task API.

Object for status consist of statusid, must be an Integer value representing one of the possible values: 

Not started, In Progress, Complete and other custom statuses 
tags

Object

This will be used in request for the add task and edit task API.

tags is optional for add task and edit task API.

This will be used in response for the get task API.

Object for tags which consists of a list of tags.
reminders

Object

This will be used in the request for add task and edit task API.

reminders is optional for add task and edit task API.

This will be used in the response for the get task API.

Object for reminders which consist of a list of reminders.
attachments 

Object

This will be used in request for the add task and edit task API.

attachments is optional for add task and edit task API.

This will be used in response for the get all task and get task API.

 Object for attachments which consists of a list of attachments.

createdby

Object

This will be used in response for the get all task and get task API.

Object which consists of information for the user who created the task.

startdate

 

Object

This will be used in the request for the add task and edit task API.

startdate is optional for add and edit task API.

This will be used in the response for the get all task and get task API.

A UTC date indicating the start date for the task. The format should be the same as used in the web based interface.

Note: This will only work with API version 4. If a user tries to use this API with version 3 when the timeline view is enabled it will be ignored and the task start date will be "No start date"
remindertype (Supported in Collaborate 4.4 and above)

Object

This will be used in the request for add task and edit task API

remindertype is optional.

if

no remindertype then by default it will be before due date

blank remindertype then by default it will be before due date

remindertype = 1 then it will be before start date

remindertype = 2 then it will be before due date

Object for reminders which consist of a list of reminders

Note: For this API version 4 will work. If you try to add a reminder for start date(remindertype = 1) using API version 3 then reminder would be ignored and task will be added without reminder on start date

 

<tasks> <!-- Only for get all task-->

     <task>

           <taskid>121</taskid>    <!-- Only for get All task API-->

          <siteid>1</siteid>      <!-- Only for get task and get All task API-->

          <title>TaskName</title>

          <description>This is a test task</description>

          <duedate></duedate>

          <startdate></startdate> --- It will work with API version 4

          <list>

                 <listid>1</listid>
                 <listname>None</listname>  <!-- only for get task and get all task -->
        </list>

          <assignees>

                <assignee>

                        <assigneeid>102</assigneeid>

                         <assigneetypeid>1</assigneetypeid>  <!-- 1 for user -->

                </assignee>

                <assignee>

                        <assigneeid>3</assigneeid>

                        <assigneetypeid>2</assigneetypeid>  <!-- 2 for group -->

                </assignee>

          </assignees>

          <priority>

                 <priorityid>2</priorityid>

                 <priorityname>Normal</priorityname> <!-- only for get task and get all task-->

          </priority>

           <status>
                 <statusid>125</statusid>
                  <statusname>In progress</statusname> <!-- only for get task and get all task-->
           </status>

          <tags> 

               <tag> 

                     <tagname>good</tagname>

               </tag>

                <tag>

                     <tagname>very good</tagname>

               </tag>

          </tags>

          <reminders>

                  <reminder>

                        <reminderid>133</reminderid>  <!-- only for get task-->

                        <remindertype>for start date 1 and for due date 2</remindertype> -- It will work with API version 4

                        <daysbefore>1</daysbefore>

                  </reminder>

                    <reminder>

                        <reminderid>134</reminderid>  <!-- only for get task-->

                        <remindertype>for start date 1 and for due date 2</remindertype> -- It will work with API version 4

                        <daysbefore>5</daysbefore>

                  </reminder>      

               </reminders>      

              <createdby>   <!-- only for get task and get all task-->
                       <firstname>Tom</firstname>
                      <lastname>Chick</lastname>
                      <email>tom.chick@highq.com</email>
                      <userid>102</userid>        
               </createdby>

            <attachments> {The file should be uploaded to attachments folder before it can be associated with the task}
               <attachment>
                       <attachmentname>filename1</attachmentname>  <!-- only for get task and get all task-->
                       <attachmenturl>https://domain.com/instance/adminDocumentsPage.action?&metaData.siteID=3&metaData.parentFolderID=0</attachmenturl> <!-- only for get task and get all task-->
                       <fileid>5</fileid>
               </attachment>

               <attachment>
                       <attachmentname>filename1</attachmentname><!-- only for get task and get all task-->
                       <attachmenturl>https://domain.com/instance/adminDocumentsPage.action</attachmenturl> <!-- only for get task and get all task-->
                       <fileid>2</fileid>
               </attachment>
          </attachments>

     </task>

</tasks>

Comments


0 Comments

Last Updated: Jun 10,2023