TaskProgress
An object that represents a task's progress details.
Supported API Calls: List | Add
Object Properties
Property |
Type |
Description |
Id |
integer |
A unique ID for a TaskProgress object. When adding a new TaskProgress object the value must be 0. |
TaskId |
integer |
The ID of the parent task. |
UserId |
integer |
ID of the user who has added progress to the task. This value is optional. |
OwnerId |
integer |
The ID of the user who owns this object. |
Comment |
string (100) |
The progress comment. |
Status |
string (100) |
The status to be added. Values are from the TaskStatus lookup value. |
ContactId |
integer |
If the task is assigned to a Contact, the ID of the contact. |
ContactName |
string (100) |
Name of the contact. |
DisplayInNote |
boolean |
Indicates if the comment text should be displayed as a note for the task object's parent object. |
AccountId |
integer |
ID of the associated organization. |
AccountName |
string (100) |
Name of the associated organization. |
StartDate |
DateTime |
New task start date. |
EndDate |
DateTime |
New task end date. |
CreationDate |
DateTime |
Date the progress was created. |
AttachmentList |
List<AttachmentAssociate> |
A list of any attachment objects. |
PhoneNumber |
string (100) |
Phone number the call was made to. |
AddContact |
boolean |
Flag to indicate contact name entered should be used to create a new contact. |
AddAccount |
boolean |
Flag to indicate organization name entered should be used to create a new organization. |
Name |
string (100) |
Name of the user doing the progress update. |
TaskName |
string (100) |
Name of the task this update is associated with. |
List
Description
Returns a task's progress.
URL
https://{company}.bluecamroo.com/api/taskprogress/list?taskid={taskid}
HTTP Method
GET
Data Return
Returns a list of task progresses in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Add
Description
Adds the task progress.
URL
https://{company}.bluecamroo.com/api/taskprogress/add
HTTP Method
POST
Parameters
A taskprogress object
Data Return
Returns the taskprogress in the requested format (e.g., JSON or XML)
HTTP Return Status Code
201: Created
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)