API for Issues (Task)

Welcome to the zipBoard platform REST API reference. This API is essential for connecting remotely with zipBoard, regardless of whether you are building an application, scripting interactions with zipBoard or building some other integration. 

This page documents the REST resources available in the zipBoard platform, along with the expected HTTP response codes and sample requests for interacting with zipBoard Tasks.

Before you start working with the API, you will need to generate an API key and also get an idea of the URI Structure that needs to be followed. Please follow this article for more information on that.

Get Tasks

GET https://app.zipboard.co/api/v1/issues/tasks/

  • To get the corresponding tasks related to the project of files.
  • For tasks to be visible, the user must be logged in and authenticated. If no user is logged in, the tasks will not be visible.
  • To get corresponding tasks related to the project of files.
  • Task Status values (Open, Waiting on Client, In Progress, Defer, Resolved/Fixed, QA Verify, Won’t Fix, Duplicate, Reopen).
  • Task Priority values (Critical, High, Medium, Low).
  • Task Type values (Bug, Enhancement, Feature, Task).

HEADERS

Content-Type                          application/json

Authorization                          Authorization token

URL Params
        Required:

None

        Optional:

id:                                     String                                         id of the task to fetch

Body Prams

        Required:

                At least one is required, either projectid or fileid.

        Optional:

                projectid                         String                                          id of the project whose task to fetch

fileid                                String                                          id of the file whose task to fetch

status                              String                                          fetch task by status

priority                             String                                          fetch task by priority

type                                 String                                          fetch task by type

Request

var http = require('http');
Http.request({
   method: 'GET',
   url: `https://app.zipboard.co/api/v1/isssues/tasks`,
   body: {
        projectid:"rC9Ym63SgYKurDuWk"
   },
 });

Response

{
    "status": "Success",
    "status code": 200,
    "message": "Successfully retrieved tasks.",
    "data": [
        {
            "_id": "154557256f2795361c48caa1",
            "screenId": -1,
            "fileId": -1,
            "commentId": "154557256f2795361c48caa1",
            "commentType": "comment",
            "commentCreatedAt": "2019-01-25T05:08:32.827Z",
            "updatedAt": "2019-01-25T05:08:32.827Z",
            "commentText": "Task-1",
            "userId": "N6dRgcj2RkAwBu948",
            "userName": "Rahil",
            "taskId": "T00001",
            "taskDescription": "",
            "taskType": "Bug",
            "taskStatus": "Open",
            "taskPriority": "Low",
            "taskAssignedToId": "",
            "taskAssignedToName": "Unassigned",
            "taskUrl": "http://localhost:3000/project/rC9Ym63SgYKurDuWk/-1/tasks/-1",
            "browsername": "Chrome 71.0.3578.98",
            "osName": "Windows 8.1",
            "commentCategory": "Open Comment",
            "phaseId": "",
            "phase_name": "",
            "type": "TASK",
            "project_title": "XYZ",
            "project_id": "rC9Ym63SgYKurDuWk",
            "taskFeed": [
                {
                    "taskFeedId": "c8e4a8c96d949cc9d649d855",
                    "taskFeedCreatedAt": "2019-01-25T05:08:32.827Z",
                    "taskFeedCreatedBy": "N6dRgcj2RkAwBu948",
                    "taskFeedText": "Rahil created the task"
                }
            ]
        }
    ]
}

Create Tasks 

POST https://app.zipboard.co/api/v1/issues/tasks

  • Creates new tasks for the user, data required (title, projectid).
  • To add a task to the project, the role of the current user should be ‘Owner’ or ‘Manager’ or ‘Reviewer’ in the project.
  • Returns the data of the newly created task.

HEADERS

Content-Type                          application/json

Authorization                          Authorization token

URL Params
        Required:

None

        Optional:

None

Body Prams

        Required:

                projectid                        String                                                id of the project where task should be created

title                                String                                                Title of the task

        Optional:

                type                              String                                                task type 

priority                          String                                                task priority 

status                           String                                                task status 

description                   String                                                task description 

Request

var http = require('http');
Http.request({
   method: 'POST',
   url: `https://app.zipboard.co/api/v1/issues/tasks`,
   body: {
     projectid: "rC9Ym63SgYKurDuWk",  
          title: "Task-002"
   },
 });

Response

 {
    "status": "Success",
    "status code": 201,
    "message": "New Task Created",
    "data": [
        {
            "_id": "f3966b74b9c9f03663593116",
            "commentId": "f3966b74b9c9f03663593116",
            "commentType": "comment",
            "commentCreatedAt": "2019-01-25T05:21:02.871Z",
            "updatedAt": "2019-01-25T05:21:02.871Z",
            "commentText": "Task-002",
            "commentLeft": "",
            "commentTop": "",
            "userId": "N6dRgcj2RkAwBu948",
            "userName": "Rahil",
            "taskId": "T00002",
            "taskDescription": "",
            "taskType": "Bug",
            "taskStatus": "Open",
            "taskPriority": "Low",
            "taskAssignedToId": "",
            "taskAssignedToName": "Unassigned",
            "taskUrl": "http://localhost:3000/NaNrC9Ym63SgYKurDuWk/-1/tasks/-1/f3966b74b9c9f03663593116",
            "browsername": "",
            "osName": "",
            "phaseId": "",
            "phase_name": "",
            "fileId": "-1",
            "screenId": "-1",
            "screenResolution": "",
            "type": "TASK",
            "project_title": "XYZ",
            "project_id": "rC9Ym63SgYKurDuWk",
            "taskFeed": [
                {
                    "taskFeedId": "005e144a1442fb13c89a44ff",
                    "taskFeedCreatedAt": "2019-01-25T05:21:02.871Z",
                    "taskFeedCreatedBy": "N6dRgcj2RkAwBu948",
                    "taskFeedText": "Rahil created the task"
                }
            ]
        }
    ]
}

 

Update Task       

PUT https://app.zipboard.co/api/v1/issues/tasks/:id

  • Updates the existing task for the user, data required (project id).
  • To update the task, the role of the current user should be ‘Owner’ or ‘Manager’ or ‘Reviewer’.
  • Returns the updated task message.

HEADERS

Content-Type                          application/json

Authorization                          Authorization token

URL Params
        Required:

id:                            String                                              id of the task to be updated(string)

        Optional:

Body Prams

        Required:

              At least one is required from optional Body Params.

        Optional:

                     title                            String                                              task title

                type                          String                                               task type

priority                       String                                               task priority

status                        String                                               task status

description                String                                               task description

Request        

var http = require('http');
Http.request({
   method: 'PUT',
   url: `https://app.zipboard.co/api/v1/issues/tasks/1a9615b1d57d3e12e555c561`,
   body: {
     title: "task-003",  
       },
 });

Response

  {
    "status": "Success",
    "status code": 200,
    "message": "Task successfully updated.",
    "data": [
        {
            "_id": "1a9615b1d57d3e12e555c561",
            "screenId": -1,
            "fileId": -1,
            "commentId": "1a9615b1d57d3e12e555c561",
            "commentType": "comment",
            "commentCreatedAt": "2019-01-25T09:56:17.089Z",
            "updatedAt": "2019-01-25T09:57:26.610Z",
            "commentText": "Issue-1",
            "userId": "N6dRgcj2RkAwBu948",
            "userName": "Rahil",
            "taskId": "T00003",
            "taskDescription": "",
            "taskType": "Bug",
            "taskStatus": "Open",
            "taskPriority": "Low",
            "taskAssignedToId": "",
            "taskAssignedToName": "Unassigned",
            "taskUrl": "http://localhost:3000/project/hoPjX5nfZomWKPsiw/-1/tasks/-1",
            "browsername": "Chrome 71.0.3578.98",
            "osName": "Windows 8.1",
            "commentCategory": "Open Comment",
            "phaseId": "",
            "phase_name": "",
            "type": "TASK",
            "project_title": "project 1",
            "project_id": "hoPjX5nfZomWKPsiw",
            "taskFeed": [
                {
                    "taskFeedId": "adb17cb99df7f08df5db2dbe",
                    "taskFeedCreatedAt": "2019-01-25T09:56:17.089Z",
                    "taskFeedCreatedBy": "N6dRgcj2RkAwBu948",
                    "taskFeedText": "Rahil created the task"
                },
                {
                    "taskFeedId": "9c6e38e52edf040fd52fe122",
                    "taskFeedCreatedAt": "2019-01-25T09:57:26.610Z",
                    "taskFeedCreatedBy": "N6dRgcj2RkAwBu948",
                    "taskFeedText": " Rahil updated updated the task title."
                }
            ]
        }
    ]
}

Delete Task       

DEL https://app.zipboard.co/api/v1/issues/tasks/:id

  • Deletes the existing tasks for the user, data required (issues id for the task).
  • To delete a task, the role of the current user should be ‘Owner’ or ‘Manager’ or ‘task creator’.
  • Returns the project data of the deleted project.

HEADERS

Content-Type                         application/json

Authorization                          Authorization token

URL Params
        Required:

id:                           String                                             id of the task to be deleted

        Optional:

none

Request

var http = require('http');
Http.request({
   method: 'DELETE',
   url: `https://app.zipboard.co/api/v1/issues/tasks/6a965c2c258bf7d41596fdc2`,
 });

Response

{
    "status": "Success",
    "status code": 200,
    "message": "Task successfully deleted"
}

If you have any questions, you can check out our Forum.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us