List Tasks

readByQuery

<readByQuery>
    <object>TASK</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use TASK
fields Optional string Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
query Required string SQL-like query based on fields on the object. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Custom page size between 1 and 1000 items (Default: 100)

Get Task

read

<read>
    <object>TASK</object>
    <keys>1</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use TASK
keys Required string Department RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Create Task

create

<create>
    <TASK>
        <NAME>hello world</NAME>
        <PROJECTID>P1234</PROJECTID>
    </TASK>
</create>

Parameters

Name Required Type Description
TASK Optional object Object to create

TASK

Name Required Type Description
NAME Required string Task name to create
PROJECTID Required string Project ID
PBEGINDATE Optional string Project begin date in format mm/dd/yyyy
PENDDATE Optional string Project end date in format mm/dd/yyyy
CLASSID Optional string Class ID
ITEMID Optional string Item ID
BILLABLE Optional boolean Billable. Use false for No, true for Yes. (Default: false)
DESCRIPTION Optional string Description
ISMILESTONE Optional boolean Milestone. Use false for No, true for Yes. (Default: false)
UTILIZED Optional boolean Utilized. Use false for No, true for Yes. (Default: false)
PRIORITY Optional string Priority
TASKNO Optional string WBS code
TASKSTATUS Optional string Task status
PARENTKEY Optional integer Parent task RECORDNO
SUPDOCID Optional string Attachments ID
OBSPERCENTCOMPLETE Optional number Observed percent completed
BUDGETQTY Optional number Planned duration
ESTQTY Optional number Estimated duration
STATUS Optional string Task status. Use active for Active otherwise use inactive for Inactive. (Default: active)

Create Task (Legacy)

create_task

<create_task>
    <taskname>hello world</taskname>
    <projectid>P1234</projectid>
</create_task>

Parameters

Name Required Type Description
taskname Required string Task name to create
projectid Required string Project ID
pbegindate Optional object Project begin date
penddate Optional object Project end date
itemid Optional string Item ID
billable Optional boolean Billable. Use false for No, true for Yes. (Default: false)
taskdescription Optional string Description
ismilestone Optional boolean Milestone. Use false for No, true for Yes. (Default: false)
utilized Optional boolean Utilized. Use false for No, true for Yes. (Default: false)
priority Optional string Priority
taskno Optional string WBS code
taskstatus Optional string Task status
parentkey Optional integer Parent task RECORDNO
parenttaskname Optional string Parent task name
budgetqty Optional number Planned duration
estqty Optional number Estimated duration
timetype Optional string Time type
obspercentcomplete Optional number Observed percent completed
customfields Optional customfield[] Custom fields
classid Optional string Class ID
supdocid Optional string Attachments ID
dependentonkey Optional integer Dependent on task RECORDNO
dependentonname Optional string Dependent on task name

pbegindate

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

penddate

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

Update Task

update

<update>
    <TASK>
        <RECORDNO>10</RECORDNO>
        <PROJECTID>P1234</PROJECTID>
    </TASK>
</update>

Parameters

Name Required Type Description
TASK Optional object Object to update

TASK

Name Required Type Description
RECORDNO Required integer Task RECORDNO to update
NAME Optional string Task name
PROJECTID Optional string Project ID
PBEGINDATE Optional string Project begin date in format mm/dd/yyyy
PENDDATE Optional string Project end date in format mm/dd/yyyy
CLASSID Optional string Class ID
ITEMID Optional string Item ID
BILLABLE Optional boolean Billable. Use false for No, true for Yes. (Default: false)
DESCRIPTION Optional string Description
ISMILESTONE Optional boolean Milestone. Use false for No, true for Yes. (Default: false)
UTILIZED Optional boolean Utilized. Use false for No, true for Yes. (Default: false)
PRIORITY Optional string Priority
TASKNO Optional string WBS code
TASKSTATUS Optional string Task status
PARENTKEY Optional integer Parent task RECORDNO
SUPDOCID Optional string Attachments ID
OBSPERCENTCOMPLETE Optional number Observed percent completed
BUDGETQTY Optional number Planned duration
ESTQTY Optional number Estimated duration
STATUS Optional string Task status. Use active for Active otherwise use inactive for Inactive (Default: active)

Update Task (Legacy)

update_task

<update_task key="10">
    <projectid>P1234</projectid>
</update_task>

Parameters

Name Required Type Description
key Required integer Task RECORDNO to update
taskname Optional string Task name
projectid Optional string Project ID
pbegindate Optional object Project begin date
penddate Optional object Project end date
itemid Optional string Item ID
billable Optional boolean Billable. Use false for No, true for Yes.
taskdescription Optional string Description
ismilestone Optional boolean Milestone. Use false for No, true for Yes.
utilized Optional boolean Utilized. Use false for No, true for Yes.
priority Optional string Priority
taskno Optional string WBS code
taskstatus Optional string Task status
parentkey Optional integer Parent task RECORDNO
parenttaskname Optional string Parent task name
budgetqty Optional number Planned duration
estqty Optional number Estimated duration
timetype Optional string Time type
obspercentcomplete Optional number Observed percent completed
customfields Optional customfield[] Custom fields
classid Optional string Class ID
dependentonkey Optional integer Dependent on task RECORDNO
dependentonname Optional string Dependent on task name

pbegindate

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

penddate

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

Delete Task

delete

<delete>
    <object>TASK</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use TASK
keys Required string Task RECORDNO to delete

Delete Task (Legacy)

delete_task

<delete_task key="10"></delete_task>

Parameters

Name Required Type Description
key Required integer Task RECORDNO to delete

Provide feedback