|
TaskStatus
TaskStatus is a property of the Task object. It represents a Task Status lookup value.
Supported API Calls: List | Add | Update | Delete
Object Properties
TaskStatus shares all properties with its base LookupValue object. Plus the following unique flags:
|
Property |
Type |
Description |
|
IsClosed |
boolean |
Indicates if the task status represents a closed condition. |
|
IsCancelled |
boolean |
Indicates if the task status represents a cancelled condition. |
|
IsStarted |
boolean |
Indicates if the task status represents a started condition. |
|
IsOnhold |
boolean |
Indicates if the task status represents an on hold condition. |
List
Description
Returns a list of task status lookup values.
URL
https://{company}.bluecamroo.com/api/taskstatus/list
HTTP Method
GET
Data Return
Returns a list of existing taskstatus objects 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 taskstatus object to the list of task status lookup values.
URL
https://{company}.bluecamroo.com/api/taskstatus/add
HTTP Method
POST
Parameters
Taskstatus object
Data Return
Returns the taskstatus 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)
Update
Description
Pass a taskstatus object to replace the specified task status.
URL
https://{company}.bluecamroo.com/api/taskstatus/update
HTTP Method
PUT
Parameters
Taskstatus object
Data Return
Returns the taskstatus 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)
Delete
Description
Deletes the specified task status. The task status type to delete is specified by Id value.
URL
https://{company}.bluecamroo.com/api/taskstatus/delete/{id}
HTTP Method
DELETE
Parameters
None
Data Return
None
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)
|