Loading ...

REST API: Add Task | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Tasks » REST API: Add Task
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 1

REST API: Add Task

0 
 /5
0 (0votes)

Add Task

POST /api/tasks

Add a new task in a task list. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
POST
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
Task JSON Used in the request body JSON representing the task.
TaskName Used in the request body The task name.
TaskListID Used in the request body ID of the task list to add the task to.
SpaceID Used in the request body ID of the space the task list is in.
Optional Parameters How to use Description
TaskDescription Used in the request body The task description.
AssignedToUserID Used in the request body ID of the user to assign the task to.
TaskStatusID Used in the request body ID of the task status to set.
TaskPriorityID Used in the request body ID of the task priority to set.
TaskDueDate Used in the request body The task due date.
TaskEstimatedHours Used in the request body The task's estimated completion time in hours.
FollowerUserNamesCsv Used in the request body A comma-separated list of usernames of users to add as task followers.

Example Request

POST https://myintranet.communifire.com/api/tasks

Body:

{
   "TaskName": "Prepare benefits package",
   "TaskDescription": "Prepare benefits package for the new hires",
   "AssignedToUserID": 641,
   "TaskListID": 572,
   "TaskStatusID": 2389,
   "TaskPriorityID": 1667,
   "SpaceID": 285,
   "TaskDueDate": "9/5/2020",
   "TaskEstimatedHours": 2,
   "FollowerUserNamesCsv": "jenny,alice"
}

Example Response

Task JSON object is returned as ResponseData.

{
   "IsError": false,
   "ResponseMessage": "Your new task has been created.",
   "ResponseData": {
      "TaskID": 576,
      "TaskName": "Prepare benefits package",
      "TaskDescription": "Prepare benefits package for the new hires",
      "IssueDescriptionUnprocessed": "Prepare benefits package for the new hires",
      "TaskSortOrder": 0,
      "TaskListID": 572,
      "IsCompleted": false,
      "SpaceID": 285,
      "AssignedToUserID": 641,
      "TaskDueDate": "2020-09-05T00:00:00",
      "PastDue": false,
      "AssignedToUserDisplayName": "Alexis Fox",
      "TaskStatusTypeID": 0,
      "TaskStatusID": 2389,
      "TaskPriorityID": 1667,
      "DateCreated": "2020-09-03T22:45:30.2139042Z",
      "ReportedByUserID": 641,
      "DateUpdated": "2020-09-03T22:45:30.2139042Z",
      "FollowerUserNamesCsv": "jenny,alice",
      "ReferencedEntityID": 0,
      "ReferencedEntityType": 0,
      "TaskEstimatedHours": 2,
      "TaskURL": "/spaces/285/human-resources/tasks?&taskid=576",
      "TenantID": 0
   }
}

 

Please Note The content type that you pass in the header of your request should be application/json.

Wiki Index

Pages

Intranet Software