Virima API Specification - TaskService Services

The requests documented in this section are directed to TaskService resources, which represent .

Contents

1 addTask POST Interface
2 editTask POST Interface
3 getAllTask GET Interface
4 getAllAssignedTasks GET Interface
5 getAllAssignedGroupTasks GET Interface
6 getAllTaskNames GET Interface
7 archiveTask POST Interface
8 completeTask POST Interface

addTask POST Interface

Method: POST

Relative URL: task/add

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
task	AddTask

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDTASK 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "entityId":?,
   "entity":"?",
   "customerId":"?",
   "userId":"?",
   "taskType":"?",
   "taskValue":"?",
   "dueDate":?,
   "assignee":?,
   "groupAssignee":?,
   "status":"?",
   "totalTimeSpent":?,
   "sentItemId":?,
   "notes":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

editTask POST Interface

Method: POST

Relative URL: task/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
updateTask	UpdateTask

Response Structure:

Field Name	Type	Description
task	Task

Example Request:

EDITTASK 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "entityId":?,
   "entity":"?",
   "taskType":"?",
   "customerId":"?",
   "userId":"?",
   "taskValue":"?",
   "dueDate":?,
   "assignee":?,
   "groupAssignee":?,
   "status":"?",
   "completed":?,
   "archive":?,
   "sentItemId":?,
   "allowTemporaryAccess":?,
   "notes":"?"
}

Example Response:

{
   "id":2147483647,
   "entityId":?,
   "entity":"?",
   "taskType":"?",
   "taskValue":"?",
   "dueDate":?,
   "assignee":"?",
   "groupAssignee":"?",
   "status":"?",
   "lastModifiedBy":"?",
   "createdBy":"?",
   "createdOn":?,
   "lastModifiedOn":?,
   "completed":?,
   "totalTimeSpent":?,
   "sentItemId":?,
   "url":"?",
   "reAssignRestricted":?,
   "notes":"?"
}

getAllTask GET Interface

Method: GET

Relative URL: task/get-all/entity-i-d/entity

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
tasks	ArrayOfTask

Example Request:

Example Response:

{
   "id":2147483647,
   "totalTime":?,
   "tasks":[
      {
         "id":2147483647,
         "entityId":?,
         "entity":"?",
         "taskType":"?",
         "taskValue":"?",
         "dueDate":?,
         "assignee":"?",
         "groupAssignee":"?",
         "status":"?",
         "lastModifiedBy":"?",
         "createdBy":"?",
         "createdOn":?,
         "lastModifiedOn":?,
         "completed":?,
         "totalTimeSpent":?,
         "sentItemId":?,
         "url":"?",
         "reAssignRestricted":?,
         "notes":"?"
      }   ]
}

getAllAssignedTasks GET Interface

Method: GET

Relative URL: task/get-all-assigned-tasks/entity-i-d

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
tasks	ArrayOfTask

Example Request:

Example Response:

{
   "id":2147483647,
   "totalTime":?,
   "tasks":[
      {
         "id":2147483647,
         "entityId":?,
         "entity":"?",
         "taskType":"?",
         "taskValue":"?",
         "dueDate":?,
         "assignee":"?",
         "groupAssignee":"?",
         "status":"?",
         "lastModifiedBy":"?",
         "createdBy":"?",
         "createdOn":?,
         "lastModifiedOn":?,
         "completed":?,
         "totalTimeSpent":?,
         "sentItemId":?,
         "url":"?",
         "reAssignRestricted":?,
         "notes":"?"
      }   ]
}

getAllAssignedGroupTasks GET Interface

Method: GET

Relative URL: task/get-all-assigned-group-tasks/entity-i-d

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
tasks	ArrayOfTask

Example Request:

Example Response:

{
   "id":2147483647,
   "totalTime":?,
   "tasks":[
      {
         "id":1205666220,
         "entityId":?,
         "entity":"?",
         "taskType":"?",
         "taskValue":"?",
         "dueDate":?,
         "assignee":"?",
         "groupAssignee":"?",
         "status":"?",
         "lastModifiedBy":"?",
         "createdBy":"?",
         "createdOn":?,
         "lastModifiedOn":?,
         "completed":?,
         "totalTimeSpent":?,
         "sentItemId":?,
         "url":"?",
         "reAssignRestricted":?,
         "notes":"?"
      }   ]
}

getAllTaskNames GET Interface

Method: GET

Relative URL: task/get-all-task-names/entity-i-d/entity

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
tasks	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

archiveTask POST Interface

Method: POST

Relative URL: task/archive

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
taskId	ArrayOfTaskId

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ARCHIVETASK 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "customerId":"?",
   "userId":"?",
   "tasks":[
      {
         "taskId":?
      }   ]
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

completeTask POST Interface

Method: POST

Relative URL: task/complete-task

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
taskData	UpdateTask

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

COMPLETETASK 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "entityId":?,
   "entity":"?",
   "taskType":"?",
   "customerId":"?",
   "userId":"?",
   "taskValue":"?",
   "dueDate":?,
   "assignee":?,
   "groupAssignee":?,
   "status":"?",
   "completed":?,
   "archive":?,
   "sentItemId":?,
   "allowTemporaryAccess":?,
   "notes":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}