The Task Object
Object Property | Required | Object Type | Description | Max Character Length |
---|
TaskName | Yes | String | Name Of Task | 200 |
AccountProjectId | Yes | Integer | Project Id Of Task | 10 |
AccountProjectTaskId | No | Integer | Unique Task Id Of Task | 10 |
ParentAccountProjectTaskId | No | Integer | Parent Task Id Of Task | 10 |
TaskDescription | No | String | Task Description Of Task | 4000 |
AccountTaskTypeId | No | Integer | Task Type Id Of Task | 10 |
Duration | No | Decimal | Duration Of Task | 10 |
DurationUnit | No | String | Duration Unit Of Task | 20 |
DeadlineDate | No | Date Time | Deadline Date Of Task | 19 |
CompletedPercent | No | Float | Completed Percent Of Task | 10 |
Completed | No | Boolean | Completed Of Task | 1 |
IsParentTask | No | Boolean | Parent Task Status Of Task | 1 |
IsForAllEmployees | No | Boolean | Task is for All Employee Status Of Task | 1 |
AccountPriorityId | No | Integer | Priority Id Of Task | 10 |
TaskStatusId | No | Integer | Status Id Of Task | 10 |
AccountProjectMilestoneId | No | Integer | Milestone Id Of Task | 10 |
IsReOpen | No | Boolean | ReOpen Status Of Task | 1 |
EstimatedCost | No | Float | Estimated Cost Of Task | 10 |
EstimatedTimeSpent | No | Float | Estimated Time Spent Of Task | 10 |
EstimatedTimeSpentUnit | No | String | Estimated Time Spent Unit Of Task | 20 |
IsBillable | No | Boolean | Billable Status Of Task | 1 |
IsDisabled | No | Boolean | Disabled Status Of Task | 1 |
AccountBillingRateId | No | Integer | Billing Rate Id Of Task | 10 |
IsForAllProjectTask | No | Boolean | All Project Task Status Of Task | 1 |
TaskCode | No | String | Task Code Of Task | 30 |
AccountProjectTaskTemplateId | No | Integer | Project Task Template Id Of Task | 10 |
EstimatedCurrencyId | No | Integer | Estimate Currency Id Of Task | 10 |
StartDate | No | Date Time | Start Date Of Task | 19 |
Predecessors | No | String | Predecessors Of Task | 50 |
CustomField1 | No | String | CustomField 1 Of Task | 2000 |
CustomField2 | No | String | CustomField 2 Of Task | 2000 |
CustomField3 | No | String | CustomField 3 Of Task | 2000 |
CustomField4 | No | String | CustomField 4 Of Task | 2000 |
CustomField5 | No | String | CustomField 5 Of Task | 2000 |
CustomField6 | No | String | CustomField 6 Of Task | 2000 |
CustomField7 | No | String | CustomField 7 Of Task | 2000 |
CustomField8 | No | String | CustomField 8 Of Task | 2000 |
CustomField9 | No | String | CustomField 9 Of Task | 2000 |
CustomField10 | No | String | CustomField 10 Of Task | 2000 |
CustomField11 | No | String | CustomField 11 Of Task | 2000 |
CustomField12 | No | String | CustomField 12 Of Task | 2000 |
CustomField13 | No | String | CustomField 13 Of Task | 2000 |
CustomField14 | No | String | CustomField 14 Of Task | 2000 |
CustomField15 | No | String | CustomField 15 Of Task | 2000 |
FixedCost | No | Float | Fixed Cost Of Task | 10 |
List All Tasks
Returns a list of your all Tasks in your UNItekTIME account.
GET /API/Tasks
Example Request
curl "https://demo.unitektime.com/api/Tasks" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "Content-Type: application/json" \
-H "User-Agent: MyApp (yourname@example.com)"
Example Response
[
{
"AccountProjectId": 00001,
"TaskName": "gather requirements",
"TaskDescription": "Sample requirements for project",
"CompletedPercent": 0,
"AccountProjectTaskId": 00001,
"CreatedOn": "2017-12-29T12:39:14.813+00:00",
"ModifiedOn": "2017-12-29T12:39:14.813+00:00",
"Duration": 0,
"DurationUnit": "Hours",
"DeadlineDate": "2017-12-29T00:00:00+00:00",
"EstimatedCost": 0,
"EstimatedTimeSpentUnit": null,
"EstimatedTimeSpent": 0,
"TaskCode": "GR",
"StartDate": "2017-12-29T00:00:00+00:00",
"CustomField1": null,
"CustomField2": null,
"CustomField3": null,
"CustomField4": null,
"CustomField5": null,
"CustomField6": null,
"CustomField7": null,
"CustomField8": null,
"CustomField9": null,
"CustomField10": null,
"CustomField11": null,
"CustomField12": null,
"CustomField13": null,
"CustomField14": null,
"CustomField15": null,
"Completed": "No",
"IsParentTask": "No",
"IsForAllEmployees": "No",
"IsBillable": "No"
}
]
Create a Task
Creates a Task in your UNItekTIME account and returns the Response Message.
POST /API/Tasks
Object Property | Required | Object Type | Description | Max Character Length |
---|
TaskName | Yes | String | Name Of Task | 200 |
AccountProjectId | Yes | Integer | Project Id Of Task | 10 |
Example Request
curl "https://demo.unitektime.com/api/Tasks" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "User-Agent: MyApp (yourname@example.com)" \
-X POST \
-H "Content-Type: application/json" \
-d "{'AccountProjectId':00001,'TaskName':'Demo Task'}"
Example Response
[
{
"id": "00003",
"message": "Task Added Successfully"
}
]
Update a Task
Update an Task in your UNItekTIME account and returns the Response Message.
POST /API/Tasks/{Task_ID}
Example Request
curl "https://demo.unitektime.com/api/Tasks/00001" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "User-Agent: MyApp (yourname@example.com)" \
-X POST \
-H "Content-Type: application/json" \
-d "{'TaskDescription':'Sample Description for Task'}"
Example Response
[
{
"id": "00001",
"message": "Task Updated Successfully"
}
]
Delete a Task
Delete a Task. Returns a 200 OK response code if the call succeeded.
DELETE /API/Task/{Task_ID}
Example Request
curl "https://demo.unitektime.com/api/Tasks/00003" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "User-Agent: MyApp (yourname@example.com)" \
-X DELETE \
-H "Content-Type: application/json"
Example Response
[
{
"id": "00003",
"message": "Task Deleted Successfully"
}
]
Get Employees Assigned in a Task
Show Employees in a Task. Returns a 200 OK response code if the call succeeded.
GET /API/Tasks/{Task_ID}/Team
Example Request
curl "https://demo.unitektime.com/api/Tasks/2153/Team" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "User-Agent: MyApp (yourname@example.com)" \
-X GET \
-H "Content-Type: application/json"
Example Response
[
{
"AccountProjectTaskEmployeeId": 3731104,
"AccountProjectId": 323166,
"AccountProjectTaskId": 2153,
"AccountEmployeeId": 93166,
"TaskName": "Demo issue",
"FirstName": "John",
"LastName": "Doe"
}
]
Add Employee in a Task
Adds an Employee in a Task. Returns a 200 OK response code if the call succeeded.
POST /API/Tasks/InsertTaskEmployee/{Task_ID}/{Employee_ID}
Example Request
curl "https://demo.unitektime.com/api/Tasks/InsertTaskEmployee/2153/65415" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "User-Agent: MyApp (yourname@example.com)" \
-X POST \
-H "Content-Type: application/json"
Example Response
[
{
"Id": "2153"
"Message": "Employee with Id '65415' is Successfully added to Task"
}
]
Remove Employee from a Task
Removes an Employee in a Task. Returns a 200 OK response code if the call succeeded.
DELETE /API/Tasks/RemoveTaskEmployee/{Task_ID}/{Employee_ID}
Example Request
curl "https://demo.unitektime.com/api/Tasks/RemoveTaskEmployee/2153/65415" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "User-Agent: MyApp (yourname@example.com)" \
-X DELETE \
-H "Content-Type: application/json"
Example Response
[
{
"Id": "65415"
"Message": "Employee with Id '65415' is Successfully Removed from Task"
}
]
List All Tasks in a Project
Returns a list of your all Tasks that have been added under a specific project.
GET /API/Tasks/Projects/{Project Id}
Example Request
curl "https://demo.unitektime.com/api/Tasks/Projects/1" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "Content-Type: application/json" \
-H "User-Agent: MyApp (yourname@example.com)"
Example Response
[
{
"AccountProjectId": 00001,
"TaskName": "gather requirements",
"TaskDescription": "Sample requirements for project",
"CompletedPercent": 0,
"AccountProjectTaskId": 00001,
"CreatedOn": "2017-12-29T12:39:14.813+00:00",
"ModifiedOn": "2017-12-29T12:39:14.813+00:00",
"Duration": 0,
"DurationUnit": "Hours",
"DeadlineDate": "2017-12-29T00:00:00+00:00",
"EstimatedCost": 0,
"EstimatedTimeSpentUnit": null,
"EstimatedTimeSpent": 0,
"TaskCode": "GR",
"StartDate": "2017-12-29T00:00:00+00:00",
"CustomField1": null,
"CustomField2": null,
"CustomField3": null,
"CustomField4": null,
"CustomField5": null,
"CustomField6": null,
"CustomField7": null,
"CustomField8": null,
"CustomField9": null,
"CustomField10": null,
"CustomField11": null,
"CustomField12": null,
"CustomField13": null,
"CustomField14": null,
"CustomField15": null,
"Completed": "No",
"IsParentTask": "No",
"IsForAllEmployees": "No",
"IsBillable": "No"
}
]