A ProjectTask object represents an agile task, to do list, or appointment that belongs to a project in QAComplete. Using the QAComplete SOAP API, you can add, load, modify, and delete these items.
To manage agile tasks, to do lists and appointments in a project, you need a user account that belongs to a security group that has the following privileges:
-
Read, Add, Update and Delete for Agile Tasks.
You can view and set privileges in > Setup > Security > Security Group > Manage Security Rights.
Properties
Custom1 … Custom10 : string (max 8000 chars)
Values of custom fields 1 to 10.
Custom11 … Custom90 : string (max 100 chars)
Values of custom fields 11 to 90.
CustomFieldName1 … CustomFieldName90 : string (max 30 chars)
The names of custom fields.
CustomFields : array of strings
An array of custom field values.
CustomFieldNames : array of strings
An array of custom field names.
TaskId : integer
The unique identifier of the agile task, to do list or appointment.
TaskTypeCode : string (max 100 chars)
The type of the item. Possible values:
- To Do List (default)
- ProjectTasks
- Appointment
Title : string (max 100 chars)
The short description of the agile task, to do list, or appointment.
MLSId : integer
Reserved.
DateBegin : dateTime
Specifies date and time when the appointment or to do list starts. Not used for agile tasks.
DateEnd : dateTime
The date and time when the appointment finishes. Not used for agile tasks.
DateDue : dateTime
The date and time when the to do list must be completed. Not used for agile tasks.
PctComplete : integer
Percentage of the agile task or to do list completing. Default : 0.
EstHrs : decimal
Estimated hours required to finish the agile task. Default: 0.
ActualHrs : decimal
Actual hours spent working on the agile task. Default : 0.
EstCost : decimal
The estimated cost of working on the agile task. Default : 0.
ActualCost : decimal
The actual cost of working on the agile task. Default : 0.
RequestedBy : string (max 30 chars)
The name of the user who requested the agile task, in the Last name, First name format. Not used for appointments. 0 if no user requested the item.
OwnerUserId : integer
The ID of the user who owns the agile task, to do list or appointment. 0 if no user owns the item.
AssigneeUserId : integer
The ID of the user to whom the agile task, to do list or appointment is assigned. 0 if the item is not assigned to anyone.
PriorityCode : string (max 100 chars)
The item priority based on the choice list. If no priority is assigned, empty string. Not used for appointments.
StatusCode : string (max 100 chars)
The status of the agile task. Possible values are based on the choice list. If no status is assigned, empty string. Not used for appointments.
Grouping : string (max 50 chars)
The mechanism of task grouping.
Subgrouping : string (max 50 chars)
The mechanism of task grouping.
Keywords : string (max 200 chars)
The list of keywords for searching the agile task.
SortOrder : integer
The ordinal number of the agile task specified in the project. Default: 0.
OtherReminderEmails : string (max 1000 chars)
Not used by agile tasks.
DateOtherReminder : dateTime
Not used by agile tasks.
Description : string (max 8000 chars)
The description of the agile task, to do list or appointment. Can include HTML markup. Default value: empty string.
IsOnActivityRpt : string (max 1 char)
Reserved.
TaskUnits : integer
The length of the appointment. Default: 0. Not used for agile tasks.
TaskDuration : string (max 10 chars)
Specifies whether the appointment length is measured in hours or minutes. Available values are Hour(s) and Minute(s). Not used for agile tasks.
ShowTimeAs : string (max 30 chars)
Specifies how the appointment’s time is shown in the calendar. Not used for agile tasks. Available values are:
- Busy
- Free
- Blocked
IsRecurring : string (max 1 chars)
Specifies whether the appointment is recurring. Not used for agile tasks.
IsMeeting : string (max 1 chars)
Specifies whether the appointment is meeting. Not used for agile tasks.
FirstRecurTaskId : integer
The ID of the first recurrence of the appointment. Not used for agile tasks.
FirstMeetingTaskId : integer
Reserved.
FolderId : integer
The ID of the folder to which the agile task belongs. 0 if the task does not belong to any folder.
OutlookId : integer
Reserved.
AssignedToName : string (max 78 chars)
The name of the user, to whom the agile task, appointment, or to do list is assigned, in the Last name, First name format.
DateCreated : dateTime
The Date and time when the agile task, appointment, or to do list was created.
DateUpdated : dateTime
The date and time when the agile task, appointment, or to do list was last updated.
EntityCode : string (max 100 chars)
The entity code of the agile task, appointment, or to do list.
EventType : string (max 300 chars)
The type of the item. Possible values are:
- Project Task
- To Do List
- Appointment
FKId : integer
The foreign key.
FolderName : string (max 511 chars)
The name of the folder to which the agile task belongs.
ImportId : integer
The ID of the operation that imported the agile task from an external file. If the task was not imported, 0. Not used for appointments.
NbrEvents : integer
The number of calendar events attached to the agile task. Default: 0.
NbrFiles : integer
The number of files attached to the agile task, appointment, or to do list. Default: 0.
NbrNotes : integer
The number of notes attached to the agile task, appointment, or to do list. Default: 0.
NbrTasks : integer
The number of tasks attached to the agile task, appointment, or to do list. Default: 0.
NotesDescription : string (max 255 chars)
The latest note attached to the agile task, appointment, or to do list. Can include HTML markup.
OriginalId : integer
The original ID of the agile task as it was specified in the external file from which it was imported. If the task was not imported, 0.
OwnerName : string (max 78 chars)
The name of the user, who owns the agile task, appointment, or to do list, in the Last name, First name format.
ProjId : integer
The ID of the QAComplete project to which the agile task, appointment, or to do list belongs.
ScheduledEventId : integer
The ID of the scheduled event linked to the agile task, appointment, or to do list.
UpdateUserId : integer
The ID of the last user who updated the agile task, appointment, or to do list.
UserName : string (max 78 chars)
The name of the last user, who updated the agile task, appointment, or to do list, in the Last name, First name format.
ActStart : dateTime
Actual date when working on the agile task starts. Not used for appointments.
ActFinish : dateTime
Actual date when working on the agile task finishes. Not used for appointments.
EstStart : dateTime
Estimated date and time when working on the agile task starts. Not used for appointments.
EstFinish : dateTime
Estimated date and time when working on the agile task finishes. Not used for appointments.
ActFinish : dateTime
Actual date when working on the agile task finishes. Not used for appointments.
ActStart : dateTime
Actual date when working on the agile task starts. Not used for appointments.
ActualCost : decimal
The actual cost of working on the agile task. Default : 0.
ActualHrs : decimal
Actual hours spent working on the agile task. Default : 0.
AssignedToName : string (max 78 chars)
The name of the user, to whom the agile task, appointment, or to do list is assigned, in the Last name, First name format.
AssigneeUserId : integer
The ID of the user to whom the agile task, to do list or appointment is assigned. 0 if the item is not assigned to anyone.
Custom1 … Custom10 : string (max 8000 chars)
Values of custom fields 1 to 10.
Custom11 … Custom90 : string (max 100 chars)
Values of custom fields 11 to 90.
CustomFieldName1 … CustomFieldName90 : string (max 30 chars)
The names of custom fields.
CustomFieldNames : array of strings
An array of custom field names.
CustomFields : array of strings
An array of custom field values.
DateBegin : dateTime
Specifies date and time when the appointment or to do list starts. Not used for agile tasks.
DateCreated : dateTime
The Date and time when the agile task, appointment, or to do list was created.
DateDue : dateTime
The date and time when the to do list must be completed. Not used for agile tasks.
DateEnd : dateTime
The date and time when the appointment finishes. Not used for agile tasks.
DateOtherReminder : dateTime
Not used by agile tasks.
DateUpdated : dateTime
The date and time when the agile task, appointment, or to do list was last updated.
Description : string (max 8000 chars)
The description of the agile task, to do list or appointment. Can include HTML markup. Default value: empty string.
EntityCode : string (max 100 chars)
The entity code of the agile task, appointment, or to do list.
EstCost : decimal
The estimated cost of working on the agile task. Default : 0.
EstFinish : dateTime
Estimated date and time when working on the agile task finishes. Not used for appointments.
EstHrs : decimal
Estimated hours required to finish the agile task. Default: 0.
EstStart : dateTime
Estimated date and time when working on the agile task starts. Not used for appointments.
EventType : string (max 300 chars)
The type of the item. Possible values are:
- Project Task
- To Do List
- Appointment
FirstMeetingTaskId : integer
Reserved.
FirstRecurTaskId : integer
The ID of the first recurrence of the appointment. Not used for agile tasks.
FKId : integer
The foreign key.
FolderId : integer
The ID of the folder to which the agile task belongs. 0 if the task does not belong to any folder.
FolderName : string (max 511 chars)
The name of the folder to which the agile task belongs.
Grouping : string (max 50 chars)
The mechanism of task grouping.
ImportId : integer
The ID of the operation that imported the agile task from an external file. If the task was not imported, 0. Not used for appointments.
IsMeeting : string (max 1 chars)
Specifies whether the appointment is meeting. Not used for agile tasks.
IsOnActivityRpt : string (max 1 char)
Reserved.
IsRecurring : string (max 1 chars)
Specifies whether the appointment is recurring. Not used for agile tasks.
Keywords : string (max 200 chars)
The list of keywords for searching the agile task.
MLSId : integer
Reserved.
NbrEvents : integer
The number of calendar events attached to the agile task. Default: 0.
NbrFiles : integer
The number of files attached to the agile task, appointment, or to do list. Default: 0.
NbrNotes : integer
The number of notes attached to the agile task, appointment, or to do list. Default: 0.
NbrTasks : integer
The number of tasks attached to the agile task, appointment, or to do list. Default: 0.
NotesDescription : string (max 255 chars)
The latest note attached to the agile task, appointment, or to do list. Can include HTML markup.
OriginalId : integer
The original ID of the agile task as it was specified in the external file from which it was imported. If the task was not imported, 0.
OtherReminderEmails : string (max 1000 chars)
Not used by agile tasks.
OutlookId : integer
Reserved.
OwnerName : string (max 78 chars)
The name of the user, who owns the agile task, appointment, or to do list, in the Last name, First name format.
OwnerUserId : integer
The ID of the user who owns the agile task, to do list or appointment. 0 if no user owns the item.
PctComplete : integer
Percentage of the agile task or to do list completing. Default : 0.
PriorityCode : string (max 100 chars)
The item priority based on the choice list. If no priority is assigned, empty string. Not used for appointments.
ProjId : integer
The ID of the QAComplete project to which the agile task, appointment, or to do list belongs.
RequestedBy : string (max 30 chars)
The name of the user who requested the agile task, in the Last name, First name format. Not used for appointments. 0 if no user requested the item.
ScheduledEventId : integer
The ID of the scheduled event linked to the agile task, appointment, or to do list.
ShowTimeAs : string (max 30 chars)
Specifies how the appointment’s time is shown in the calendar. Not used for agile tasks. Available values are:
- Busy
- Free
- Blocked
SortOrder : integer
The ordinal number of the agile task specified in the project. Default: 0.
StatusCode : string (max 100 chars)
The status of the agile task. Possible values are based on the choice list. If no status is assigned, empty string. Not used for appointments.
Subgrouping : string (max 50 chars)
The mechanism of task grouping.
TaskDuration : string (max 10 chars)
Specifies whether the appointment length is measured in hours or minutes. Available values are Hour(s) and Minute(s). Not used for agile tasks.
TaskId : integer
The unique identifier of the agile task, to do list or appointment.
TaskTypeCode : string (max 100 chars)
The type of the item. Possible values:
- To Do List (default)
- ProjectTasks
- Appointment
TaskUnits : integer
The length of the appointment. Default: 0. Not used for agile tasks.
Title : string (max 100 chars)
The short description of the agile task, to do list, or appointment.
UpdateUserId : integer
The ID of the last user who updated the agile task, appointment, or to do list.
UserName : string (max 78 chars)
The name of the last user, who updated the agile task, appointment, or to do list, in the Last name, First name format.
Relevant Operations
Remarks
-
Some string property values are based on choice lists defined in your QAComplete project. You can find these values in Agile Tasks > Actions > Manage Choice Lists.
-
Unassigned date/time values (for example, in
EstStart) are represented as0001-01-01T00:00:00.
Example
XML
<ProjectTask>
<CustomFields>
<string>value</string>
…
</CustomFields>
<CustomFieldNames>
<string>CustomField1</string>
…
</CustomFieldNames>
<TaskId>1<TaskId>
<TaskTypeCode>ProjectTasks<TaskTypeCode>
<Title>Created from a bug<Title>
<MLSId>0<MLSId>
<DateBegin>0001-01-01T00:00:00</DateBegin>
<DateEnd>0001-01-01T00:00:00</DateEnd>
<DateDue>0001-01-01T00:00:00</DateDue>
<PctComplete>0</b><PctComplete>
<EstHrs>10.000</b><EstHrs>
<ActualHrs>0</ActualHrs>
<EstCost>0</EstCos>
<ActualCost>0</ActualCost>
<RequestedBy>Doe, John</RequestedBy>
<OwnerUserId>24661</OwnerUserId>
<AssigneeUserId>24661</AssigneeUserId>
<PriorityCode>2-Medium</PriorityCode>
<StatusCode>Active</StatusCode>
<SortOrder>0</SortOrder>
<DateOtherReminder>0001-01-01T00:00:00<DateOtherReminder>
<Description>Test 1 failed. This task was automatically generated.</Description>
<IsOnActivityRpt>N</IsOnActivityRpt>
<TaskUnits>1</TaskUnits>
<TaskDuration>Hour(s)</TaskDuration>
<ShowTimeAs>Busy</ShowTimeAs>
<IsRecurring>N</IsRecurring>
<IsMeeting>N</IsMeeting>
<FirstRecurTaskId>0</FirstRecurTaskId>
<FirstMeetingTaskId>0</FirstMeetingTaskId>
<FolderId>0</FolderId>
<OutlookId>0</OutlookId>
<AssignedToName>Doe, John</AssignedToName>
<DateCreated>2014-07-01T07:57:10.187</DateCreated>
<DateUpdated>2014-07-24T05:31:16</DateUpdated>
<EventType>Project Task</EventType>
<FKId>0</FKId>
<ImportId>0</ImportId>
<NbrEvents>0</NbrEvents>
<NbrFiles>0</NbrFiles>
<NbrNotes>0</NbrNotes>
<NbrTasks>0</NbrTasks>
<OriginalId>0</OriginalId>
<OwnerName>Doe, John</OwnerName>
<ProjId>11873</ProjId>
<ScheduledEventId>0</ScheduledEventId>
<UpdateUserId>24661</UpdateUserId>
<UserName>Doe, John</UserName>
<ActStart>0</ActStart>
<ActFinish>0</ActFinish>
<EstStart>2014-08-01T00:00:00</EstStart>
<EstFinish>2014-08-04T00:00:00</EstFinish>
</ProjectTask>
See Also
ProjectTasks_Add Operation
ProjectTasks_Load Operation
Agile Tasks Operations