Tasks v6



Important note about API versions

If you are using Dovico Timesheet version 13 or below, you should use API version 5. If using version 14, use API version 6.


This call has been updated to reflect the 6th version of the API.

The Tasks v5 call can be found using this link

The API calls listed below enable a person to view, create, and edit Tasks that they have been given security access to within DOVICO Timesheet or DOVICO Planning and Timesheet.

Examples are provided using cURL.cURL is a 3rd party tool used for transferring data with URL syntax.



Get all Tasks


GET Tasks/

Returns a list of all Tasks using pagination. Note: The $filter query string can optionally be included with this request.

Security Check:
The user must have Software Access set to All and have Read access to the Tasks view. Data will also be restricted based on limited access settings.

Example XML request:
 
        URI: https://api.dovico.com/Tasks/?version=6
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Tasks/?version=6" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/Tasks/?version=6
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Tasks/?version=6" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Tasks>
                <Task>
                    <ID>1754</ID>
                    <Project>
                        <ID>99</ID>
                        <Name>Leave/Absences</Name>
                        <GetItemURI>https://api.dovico.com/Projects/99/?version=6</GetItemURI>
                    </Project>
                    <Name>System Testing</Name>
                    <TaskGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </TaskGroup>
                    <Description></Description>
                    <ForceDescription>F</ForceDescription>
                    <RSTask>F</RSTask>
                    <WBS></WBS>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Task>
                <Task>
                    ...
                </Task>
            </Tasks>
            <PrevPageURI>https://api.dovico.com/Tasks/?prev=1754&version=6</PrevPageURI>
            <NextPageURI>https://api.dovico.com/Tasks/?next=1794&version=6</NextPageURI>
        </Result>

Fields for Result
Tasks (will return zero or more Task nodes)
PrevPageURI (string. Will be 'N/A' if there is no previous page of data)
NextPageURI (string. Will be 'N/A' if there is no next page of data)


Fields for Task
ID (long)
Project (node containing information about the Project associated with this task)
Name (string)
TaskGroup (node containing information about the Task Group associated with this task)
Description (string)
ForceDescription (string - 'T' or 'F')
RSTask (string - 'T' or 'F')
WBS (string)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)


Fields for Project
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Project)


Fields for TaskGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Task Group)

NOTE: The ID will be 0 if the task has no task group specified. The URI will be 'N/A'.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value nodes)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values node
Value (string, date, or double - based on the custom template's type)

Example JSON response:
 
        {
        "Tasks":
            [
                {
                    "ID":"1754",
                    "Project":
                    {
                        "ID":"99",
                        "Name":"Leave\/Absences",
                        "GetItemURI":"https:\/\/api.dovico.com\/Projects\/99\/?version=6"
                    },
                    "Name":"System Testing",
                    "TaskGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Description":"",
                    "ForceDescription":"F",
                    "RSTask":"F",
                    "WBS":"",
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1631",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                        },
                        {
                            ...
                        }
                    ]
                },
                {
                    ...
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/Tasks\/?prev=1754&version=6",
        "NextPageURI":"https:\/\/api.dovico.com\/Tasks\/?next=1794&version=6"
        }


Fields
Tasks (will return zero or more Task objects)
PrevPageURI (string. Will be 'N/A' if there is no previous page of data)
NextPageURI (string. Will be 'N/A' if there is no next page of data)


Fields for Task
ID (long)
Project (object containing information about the Project associated with this task)
Name (string)
TaskGroup (object containing information about the Task Group associated with this task)
Description (string)
ForceDescription (string - 'T' or 'F')
RSTask (string - 'T' or 'F')
WBS (string)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)


Fields for Project
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Project)


Fields for TaskGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Task Group)

NOTE: The ID will be 0 if the task has no task group specified. The URI will be 'N/A'.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value objects)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values object
Value (string, date, or double - based on the custom template's type)




Get a Task


GET Tasks/{sTaskID}/

Returns the Task requested.

Security Check:
The user must have Software Access set to All and have Read access to the Tasks view. Data will also be restricted based on limited access settings.

Example XML request:
 
        URI: https://api.dovico.com/Tasks/{TaskID}/?version=6
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Tasks/1754/?version=6" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/Tasks/{TaskID}/?version=6
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Tasks/1754/?version=6" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Tasks>
                <Task>
                    <ID>1754</ID>
                    <Project>
                        <ID>99</ID>
                        <Name>Leave/Absences</Name>
                        <GetItemURI>https://api.dovico.com/Projects/99/?version=6</GetItemURI>
                    </Project>
                    <Name>System Testing</Name>
                    <TaskGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </TaskGroup>
                    <Description></Description>
                    <ForceDescription>F</ForceDescription>
                    <RSTask>F</RSTask>
                    <WBS></WBS>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Task>
            </Tasks>
        </Result>


Fields for Result
Tasks (will return zero Task nodes if the requested item does not exist. Will return one Task node if the requested item does exist. In the case of a POST, will return one Task node for each Task item POSTed.)


Fields for Task
ID (long)
Project (node containing information about the Project associated with this task)
Name (string)
TaskGroup (node containing information about the Task Group associated with this task)
Description (string)
ForceDescription (string - 'T' or 'F')
RSTask (string - 'T' or 'F')
WBS (string)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)


Fields for Project
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Project)


Fields for TaskGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Task Group)

NOTE: The ID will be 0 if the task has no task group specified. The URI will be 'N/A'.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value nodes)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values node
Value (string, date, or double - based on the custom template's type)

Example JSON response:
 
        {
        "Tasks":
            [
                {
                    "ID":"1754",
                    "Project":
                    {
                        "ID":"99",
                        "Name":"Leave\/Absences",
                        "GetItemURI":"https:\/\/api.dovico.com\/Projects\/99\/?version=6"
                    },
                    "Name":"System Testing",
                    "TaskGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Description":"",
                    "ForceDescription":"F",
                    "RSTask":"F",
                    "WBS":"",
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1631",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }


Fields
Tasks (will return zero Task objects if the requested item does not exist. Will return one Task object if the requested item does exist. In the case of a POST, will return one Task object for each Task item POSTed.)


Fields for Task
ID (long)
Project (object containing information about the Project associated with this task)
Name (string)
TaskGroup (object containing information about the Task Group associated with this task)
Description (string)
ForceDescription (string - 'T' or 'F')
RSTask (string - 'T' or 'F')
WBS (string)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)


Fields for Project
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Project)


Fields for TaskGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Task Group)

NOTE: The ID will be 0 if the task has no task group specified. The URI will be 'N/A'.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value objects)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values object
Value (string, date, or double - based on the custom template's type)




Insert


POST Tasks/

Creates the Tasks specified.

Security Check:
The user must have Software Access set to All and have Read and Modify access to the Tasks view.

Example XML request:
 
        URI: https://api.dovico.com/Tasks/?version=6
        Method: POST
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Tasks/?version=6" --request POST -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: text/xml" --data "<Tasks><Task><ProjectID>99</ProjectID><Name>System Testing</Name></Task></Tasks>"

Fields for Tasks
*Task (required - at least one Task node is required but more than one can be provided)


Fields for Task
*ProjectID (required - long - the ID of the project that the task is for)
*Name (required - string with a maximum length of 250 characters)
Description (optional - string with a maximum length of 250 characters)
ForceDescription (optional - string 'T' or 'F')
WBS (optional - string with a maximum length of 250 characters)
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, do not include a root INT element.)
CustomFields (optional - zero or more CustomField nodes)



Fields for CustomField
*ID (required - long - specify -1 in this case)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - zero or more Value nodes)



Fields for Value
Value (optional - string, date, or double depending on the Custom Template's type)


Example JSON request:
 
        URI: https://api.dovico.com/Tasks/?version=6
        Method: POST
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Tasks/?version=6" --request POST -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: application/json" --data "[{""ProjectID"":""99"",""Name"":""System Testing""}]"


Fields
*An array containing at least one Task object (required)


Fields for Task
*ProjectID (required - long - the ID of the project that the task is for)
*Name (required - string with a maximum length of 250 characters)
Description (optional - string with a maximum length of 250 characters)
ForceDescription (optional - string 'T' or 'F')
WBS (optional - string with a maximum length of 250 characters)
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, do not include a root INT element.)
CustomFields (optional - an array of zero or more CustomField objects)



Fields for CustomField
*ID (required - long - specify -1 in this case)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - an array of zero or more Value objects)



Fields for Value
Value (optional - string, date, or double depending on the Custom Template's type)

Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Tasks>
                <Task>
                    <ID>1754</ID>
                    <Project>
                        <ID>99</ID>
                        <Name>Leave/Absences</Name>
                        <GetItemURI>https://api.dovico.com/Projects/99/?version=6</GetItemURI>
                    </Project>
                    <Name>System Testing</Name>
                    <TaskGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </TaskGroup>
                    <Description></Description>
                    <ForceDescription>F</ForceDescription>
                    <RSTask>F</RSTask>
                    <WBS></WBS>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Task>
            </Tasks>
        </Result>

Fields for Result
Tasks (will return zero Task nodes if the requested item does not exist. Will return one Task node if the requested item does exist. In the case of a POST, will return one Task node for each Task item POSTed.)


Fields for Task
ID (long)
Project (node containing information about the Project associated with this task)
Name (string)
TaskGroup (node containing information about the Task Group associated with this task)
Description (string)
ForceDescription (string - 'T' or 'F')
RSTask (string - 'T' or 'F')
WBS (string)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)


Fields for Project
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Project)


Fields for TaskGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Task Group)

NOTE: The ID will be 0 if the task has no task group specified. The URI will be 'N/A'.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value nodes)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values node
Value (string, date, or double - based on the custom template's type)

Example JSON response:
 
        {
        "Tasks":
            [
                {
                    "ID":"1754",
                    "Project":
                    {
                        "ID":"99",
                        "Name":"Leave\/Absences",
                        "GetItemURI":"https:\/\/api.dovico.com\/Projects\/99\/?version=6"
                    },
                    "Name":"System Testing",
                    "TaskGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Description":"",
                    "ForceDescription":"F",
                    "RSTask":"F",
                    "WBS":"",
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1631",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }

Fields
Tasks (will return zero Task objects if the requested item does not exist. Will return one Task object if the requested item does exist. In the case of a POST, will return one Task object for each Task item POSTed.)


Fields for Task
ID (long)
Project (object containing information about the Project associated with this task)
Name (string)
TaskGroup (object containing information about the Task Group associated with this task)
Description (string)
ForceDescription (string - 'T' or 'F')
RSTask (string - 'T' or 'F')
WBS (string)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)


Fields for Project
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Project)


Fields for TaskGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Task Group)

NOTE: The ID will be 0 if the task has no task group specified. The URI will be 'N/A'.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value objects)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values object
Value (string, date, or double - based on the custom template's type)





Update (bulk)


PUT Tasks/

Updates the Tasks specified.

Security Check:
The user must have Software Access set to All and have Read and Modify access to the Tasks view.
Example XML request:
 
        URI: https://api.dovico.com/Tasks/?version=6
        Method: PUT
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Tasks/?version=6" --request PUT -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: text/xml" --data "<Tasks><Task><ID>1754</ID><Name>System Testing</Name></Task></Tasks>"
Fields for Tasks
*Task (required - at least one Task node is required but more than one can be provided)


Fields for Task
*ID (required - long - the ID of the task record to update)
Name (optional - string with a maximum length of 250 characters)
Description (optional - string with a maximum length of 250 characters)
ForceDescription (optional - string 'T' or 'F')
WBS (optional - string with a maximum length of 250 characters)
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, do not include a root INT element.)
DeleteIntegrateElement (optional - string containing the name of the element to be removed from the Integrate field)
CustomFields (optional - zero or more CustomField nodes)

WARNING: The Integrate field is used by several of DOVICO Software's integration solutions. If this field contains a value, do not overwrite the value with a new value unless you intend for this record to no longer work with the solution(s) it was integrated with.


Fields for CustomField
*ID (required - long)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - zero or more Value nodes)


Fields for Value
Value (optional - string, date, or double depending on the Custom Template's type)

Example JSON request:
 
        URI: https://api.dovico.com/Tasks/?version=6
        Method: PUT
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Tasks/?version=6" --request PUT -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: application/json" --data "[{""ID"":""1754"",""Name"":""System Testing""}]"

Fields
*An array containing at least one Task object (required)



Fields for Task
*ID (required - long - the ID of the task record to update)
Name (optional - string with a maximum length of 250 characters)
Description (optional - string with a maximum length of 250 characters)
ForceDescription (optional - string 'T' or 'F')
WBS (optional - string with a maximum length of 250 characters)
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, do not include a root INT element.)
DeleteIntegrateElement (optional - string containing the name of the element to be removed from the Integrate field)
CustomFields (optional - an array of zero or more CustomField objects)

WARNING: The Integrate field is used by several of DOVICO Software's integration solutions. If this field contains a value, do not overwrite the value with a new value unless you intend for this record to no longer work with the solution(s) it was integrated with.


Fields for CustomField
*ID (required - long)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - an array of zero or more Value objects)


Fields for Value
Value (optional - string, date, or double depending on the Custom Template's type)

Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Tasks>
                <Task>
                    <ID>1754</ID>
                    <Project>
                        <ID>99</ID>
                        <Name>Leave/Absences</Name>
                        <GetItemURI>https://api.dovico.com/Projects/99/?version=6</GetItemURI>
                    </Project>
                    <Name>System Testing</Name>
                    <TaskGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </TaskGroup>
                    <Description></Description>
                    <ForceDescription>F</ForceDescription>
                    <RSTask>F</RSTask>
                    <WBS></WBS>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Task>
            </Tasks>
        </Result>


Fields for Result
Tasks (will return zero Task nodes if the requested item does not exist. Will return one Task node if the requested item does exist. In the case of a POST, will return one Task node for each Task item POSTed.)


Fields for Task
ID (long)
Project (node containing information about the Project associated with this task)
Name (string)
TaskGroup (node containing information about the Task Group associated with this task)
Description (string)
ForceDescription (string - 'T' or 'F')
RSTask (string - 'T' or 'F')
WBS (string)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)


Fields for Project
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Project)


Fields for TaskGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Task Group)

NOTE: The ID will be 0 if the task has no task group specified. The URI will be 'N/A'.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value nodes)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values node
Value (string, date, or double - based on the custom template's type)

Example JSON response:
 
        {
        "Tasks":
            [
                {
                    "ID":"1754",
                    "Project":
                    {
                        "ID":"99",
                        "Name":"Leave\/Absences",
                        "GetItemURI":"https:\/\/api.dovico.com\/Projects\/99\/?version=6"
                    },
                    "Name":"System Testing",
                    "TaskGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Description":"",
                    "ForceDescription":"F",
                    "RSTask":"F",
                    "WBS":"",
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1631",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }


Fields
Tasks (will return zero Task objects if the requested item does not exist. Will return one Task object if the requested item does exist. In the case of a POST, will return one Task object for each Task item POSTed.)


Fields for Task
ID (long)
Project (object containing information about the Project associated with this task)
Name (string)
TaskGroup (object containing information about the Task Group associated with this task)
Description (string)
ForceDescription (string - 'T' or 'F')
RSTask (string - 'T' or 'F')
WBS (string)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)


Fields for Project
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Project)


Fields for TaskGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Task Group)

NOTE: The ID will be 0 if the task has no task group specified. The URI will be 'N/A'.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value objects)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values object
Value (string, date, or double - based on the custom template's type)





Update


PUT Tasks/{sTaskID}/

Updates the Task specified.

Security Check:
The user must have Software Access set to All and have Read and Modify access to the Tasks view.

Example XML request:
 
        URI: https://api.dovico.com/Tasks/{TaskID}/?version=6
        Method: PUT
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Tasks/1754/?version=6" --request PUT -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: text/xml" --data "<Task><Name>System Testing</Name></Task>"

Fields for Task
Name (optional - string with a maximum length of 250 characters)
Description (optional - string with a maximum length of 250 characters)
ForceDescription (optional - string 'T' or 'F')
WBS (optional - string with a maximum length of 250 characters)
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, do not include a root INT element.)
DeleteIntegrateElement (optional - string containing the name of the element to be removed from the Integrate field)
CustomFields (optional - zero or more CustomField nodes)

NOTE: All fields are optional but at least one must be specified


WARNING: The Integrate field is used by several of DOVICO Software's integration solutions. If this field contains a value, do not overwrite the value with a new value unless you intend for this record to no longer work with the solution(s) it was integrated with.


Fields for CustomField
*ID (required - long)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - zero or more Value nodes)


Fields for Value
Value (optional - string, date, or double depending on the Custom Template's type)

Example JSON request:
 
        URI: https://api.dovico.com/Tasks/{TaskID}/?version=6
        Method: PUT
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Tasks/1754/?version=6" --request PUT -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: application/json" --data "{""Name"":""System Testing""}"

Fields for Task
Name (optional - string with a maximum length of 250 characters)
Description (optional - string with a maximum length of 250 characters)
ForceDescription (optional - string 'T' or 'F')
WBS (optional - string with a maximum length of 250 characters)
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, do not include a root INT element.)
DeleteIntegrateElement (optional - string containing the name of the element to be removed from the Integrate field)
CustomFields (optional - an array of zero or more CustomField objects)

NOTE: All fields are optional but at least one must be specified


WARNING: The Integrate field is used by several of DOVICO Software's integration solutions. If this field contains a value, do not overwrite the value with a new value unless you intend for this record to no longer work with the solution(s) it was integrated with.


Fields for CustomField
*ID (required - long)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - an array of zero or more Value objects)


Fields for Value
Value (optional - string, date, or double depending on the Custom Template's type)


Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Tasks>
                <Task>
                    <ID>1754</ID>
                    <Project>
                        <ID>99</ID>
                        <Name>Leave/Absences</Name>
                        <GetItemURI>https://api.dovico.com/Projects/99/?version=6</GetItemURI>
                    </Project>
                    <Name>System Testing</Name>
                    <TaskGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </TaskGroup>
                    <Description></Description>
                    <ForceDescription>F</ForceDescription>
                    <RSTask>F</RSTask>
                    <WBS></WBS>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Task>
            </Tasks>
        </Result>


Fields for Result
Tasks (will return zero Task nodes if the requested item does not exist. Will return one Task node if the requested item does exist. In the case of a POST, will return one Task node for each Task item POSTed.)


Fields for Task
ID (long)
Project (node containing information about the Project associated with this task)
Name (string)
TaskGroup (node containing information about the Task Group associated with this task)
Description (string)
ForceDescription (string - 'T' or 'F')
RSTask (string - 'T' or 'F')
WBS (string)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)


Fields for Project
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Project)


Fields for TaskGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Task Group)

NOTE: The ID will be 0 if the task has no task group specified. The URI will be 'N/A'.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value nodes)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values node
Value (string, date, or double - based on the custom template's type)

Example JSON response:
 
        {
        "Tasks":
            [
                {
                    "ID":"1754",
                    "Project":
                    {
                        "ID":"99",
                        "Name":"Leave\/Absences",
                        "GetItemURI":"https:\/\/api.dovico.com\/Projects\/99\/?version=6"
                    },
                    "Name":"System Testing",
                    "TaskGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Description":"",
                    "ForceDescription":"F",
                    "RSTask":"F",
                    "WBS":"",
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1631",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }


Fields
Tasks (will return zero Task objects if the requested item does not exist. Will return one Task object if the requested item does exist. In the case of a POST, will return one Task object for each Task item POSTed.)


Fields for Task
ID (long)
Project (object containing information about the Project associated with this task)
Name (string)
TaskGroup (object containing information about the Task Group associated with this task)
Description (string)
ForceDescription (string - 'T' or 'F')
RSTask (string - 'T' or 'F')
WBS (string)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)


Fields for Project
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Project)


Fields for TaskGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Task Group)

NOTE: The ID will be 0 if the task has no task group specified. The URI will be 'N/A'.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value objects)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values object
Value (string, date, or double - based on the custom template's type)