API for Issues (Feedback)
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 feedbacks in zipBoard.
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 Feedback
GET https://app.zipboard.co/api/v1/issues/comments/
- To get the corresponding feedback related to the project of files.
HEADERS
Content-Type application/json
Authorization Authorization token
URL Params
Required:
None
Optional:
id: String id of the feedback for comments.
Body Params
Required:
At least one of the following is required: projectid, fileid.
Optional:
projectid String id of the project whose feedback are to be fetched
fileid String id of the file whose feedback are to be fetched
Request
var http = require('http');
Http.request({
method: 'GET',
url: `https://app.zipboard.co/api/v1/isssues/comments`,
body: {
projectid:"rC9Ym63SgYKurDuWk"
},
});
Response
{
"status": "Success",
"status code": 200,
"data": [
{
"_id": "15c604bfc3f3603c8a2a02f7",
"screenId": -1,
"fileId": -1,
"commentId": "15c604bfc3f3603c8a2a02f7",
"commentType": "comment",
"commentCreatedAt": "2019-01-25T05:51:35.501Z",
"updatedAt": "2019-01-25T05:51:35.501Z",
"commentText": "Feedback-001",
"userId": "N6dRgcj2RkAwBu948",
"userName": "Rahil",
"commentCategory": "Open Comment",
"browsername": "Chrome 71.0.3578.98",
"osName": "Windows 8.1",
"phaseId": "",
"phase_name": "",
"type": "DISCUSSION",
"project_title": "XYZ",
"project_id": "rC9Ym63SgYKurDuWk"
}
]
}
Create Feedback
POST https://app.zipboard.co/api/v1/issues/comments
- Creates new feedback for the user, data required (title, project id).
- To add feedback to the project, the role of the current user should be ‘Owner’ or ‘Manager’ or ‘Reviewer’ in the project.
- Returns the data of newly created feedback.
HEADERS
Content-Type application/json
Authorization Authorization token
URL Params
Required:
None
Optional:
None
Body Params
Required:
projectid String id of the project where we want to create the feedback
Optional:
title String task title
description String task description
Request
var http = require('http');
Http.request({
method: 'POST',
url: `https://app.zipboard.co/api/v1/issues/comments`,
body: {
projectid: "rC9Ym63SgYKurDuWk",
title: "Feedback-002"
},
});
Response
{
"status": "Success",
"status code": 200,
"message": "New FeedBack Created",
"data": {
"_id": "95b0e31447d7b2eda92f0a97",
"commentId": "95b0e31447d7b2eda92f0a97",
"commentType": "comment",
"commentCreatedAt": "2019-01-25T06:07:58.929Z",
"updatedAt": "2019-01-25T06:07:58.929Z",
"commentText": "Feedback-002",
"commentLeft": "",
"commentTop": "",
"userId": "N6dRgcj2RkAwBu948",
"userName": "Rahil",
"taskId": "T00002",
"taskDescription": "",
"taskUrl": "http://localhost:3000/NaNrC9Ym63SgYKurDuWk/-1/comments/-1/95b0e31447d7b2eda92f0a97",
"browsername": "",
"osName": "",
"phaseId": "",
"phase_name": "",
"fileId": "-1",
"screenId": "-1",
"screenResolution": "",
"type": "DISCUSSION",
"project_title": "XYZ",
"project_id": "rC9Ym63SgYKurDuWk",
"taskFeed": [
{
"taskFeedId": "98ae8c0ab3e67259767b276d",
"taskFeedCreatedAt": "2019-01-25T06:07:58.929Z",
"taskFeedCreatedBy": "N6dRgcj2RkAwBu948",
"taskFeedText": "Rahil created the task"
}
]
}
}
Update Feedback
PUT https://app.zipboard.co/api/v1/issues/comments/:id
- Updates the existing feedback for the user, data required (project _id).
- To update feedback, the role of the current user should be Owner or Manager or reviewer.
- Returns the updated feedback message.
HEADERS
Content-Type application/json
Authorization Authorization token
URL Params
Required:
id: String id of the feedback to be updated (string)
Optional:
Body Params
Required:
title String feedback title (string)
Optional:
description String feedback description (string)
Request
var http = require('http');
Http.request({
method: 'PUT',
url: `https://app.zipboard.co/api/v1/issues/comments/d53d9871b9810d5757c90a2e`,
body: {
title: "task-003",
},
});
Response
{
"status": "Success",
"status code": 200,
"message": "FeedBack successfully updated.",
"data": [
{
"_id": "d53d9871b9810d5757c90a2e",
"screenId": -1,
"fileId": -1,
"commentId": "d53d9871b9810d5757c90a2e",
"commentType": "comment",
"commentCreatedAt": "2019-01-25T09:59:36.635Z",
"updatedAt": "2019-01-25T10:00:18.252Z",
"commentText": "Feedback-1",
"userId": "N6dRgcj2RkAwBu948",
"userName": "Rahil",
"commentCategory": "Open Comment",
"browsername": "Chrome 71.0.3578.98",
"osName": "Windows 8.1",
"phaseId": "",
"phase_name": "",
"type": "DISCUSSION",
"project_title": "project 1",
"project_id": "hoPjX5nfZomWKPsiw",
"taskDescription": null,
"taskFeed": [
{
"taskFeedId": "6408abe8981730a67924f919",
"taskFeedCreatedAt": "2019-01-25T10:00:18.252Z",
"taskFeedCreatedBy": "N6dRgcj2RkAwBu948",
"taskFeedText": " Rahil updated updated the task title."
}
]
}
]
}
Delete Feedback
DEL https://app.zipboard.co/api/v1/issues/comments/:id
- Deletes the existing feedbacks from the user, data required (issues id for the task).
- To delete feedbacks, the role of the current user should be ‘Owner’ or ‘Manager’ or ‘task creator’.
- Returns the deleted feedback message.
HEADERS
Content-Type application/json
Authorization Authorization token
URL Params
Required:
id: String id of the feedback to be deleted (string)
Optional:
None
Body Params
{
}
Request
var http = require('http');
Http.request({
method: 'DELETE',
url: `https://app.zipboard.co/api/v1/issues/comments/4a51b3e911d200be2db711c2`,
});
Response
{
"status": "Success",
"status code": 200,
"message": "Feedback Successfully deleted"
}
If you have any questions, you can check out our Forum.