Zoho Projects API for Developers

Bugs API

All Bugs
GET  /portal/[PORTALID]/projects/[PROJECTID]/bugs/
Bug Details
GET  /portal/[PORTALID]/projects/[PROJECTID]/bugs/[BUGID]/
Create a Bug
POST  /portal/[PORTALID]/projects/[PROJECTID]/bugs/
Update a Bug
POST  /portal/[PORTALID]/projects/[PROJECTID]/bugs/[BUGID]/
Delete a Bug
DELETE /portal/[PORTALID]/projects/[PROJECTID]/bugs/[BUGID]/
Bugs Default Fields
GET  /portal/[PORTALID]/projects/[PROJECTID]/bugs/defaultfields/
Bugs Custom Fields
GET  /portal/[PORTALID]/projects/[PROJECTID]/bugs/customfields/

All Bugs

GET  /portal/[PORTALID]/projects/[PROJECTID]/bugs/

Gets all the bugs in the given project.

Request Parameters

index int Index number of the bug.
range int Range of the bugs.
statustype String Type of the status must be provided as open or closed.

Sample Response

Status: 200 Success
Content Type: application/json;charset=utf-8
{
"bugs": [{
"module": {
"id": 170876000000494013,
"name": "ERP Phase I"
},
"created_time_long": 1400012857000,
"customfields": [{
"label_name": "SNo",
"value": "81",
"column_name": "LONG1"
}, {
"label_name": "Sub Module",
"value": "Finance",
"column_name": "CHAR3"
}, {
"label_name": "Browser",
"value": "Chrome",
"column_name": "CHAR2"
}, {
"label_name": "Product",
"value": "Code Manager",
"column_name": "CHAR1"
}],
"status": {
"id": 170876000000065048,
"type": "InProgress"
},
"reproducible": {
"id": 170876000000133005,
"type": "Always"
},
"link": {
"self": {
"url": "https://projects.zoho.com/restapi/portal/2063927/projects/
170876000000147021/bugs/170876000001834047/"
},
"timesheet": {
"url": "https://projects.zoho.com/restapi/portal/2063927/projects/
170876000000147021/bugs/170876000001834047/logs/"
}
},
"severity": {
"id": 170876000000065005,
"type": "Major"
},
"reported_person": "Patricia Boyle",
"id": 170876000001834047,
"title": "Tilt causes crash",
"flag": "Internal",
"assignee_name": "Not Assigned",
"reporter_id": "2060758",
"classification": {
"id": 170876000000133041,
"type": "Feature(New)"
},
"created_time_format": "05-13-2014 05:57 PM",
"closed": false,
"created_time": "05-13-2014",
"key": 541
}]
}

Bug Details

GET  /portal/[PORTALID]/projects/[PROJECTID]/bugs/[BUGID]/

Gets the details of the bug.

Sample Response

Status: 200 Success
Content Type: application/json;charset=utf-8
{
"bugs": [{
"module": {
"id": 170876000000494013,
"name": "ERP Phase I"
},
"created_time_long": 1400012857000,
"customfields": [{
"label_name": "SNo",
"value": "81",
"column_name": "LONG1"
}, {
"label_name": "Sub Module",
"value": "Finance",
"column_name": "CHAR3"
}, {
"label_name": "Browser",
"value": "Chrome",
"column_name": "CHAR2"
}, {
"label_name": "Product",
"value": "Code Manager",
"column_name": "CHAR1"
}],
"status": {
"id": 170876000000065048,
"type": "InProgress"
},
"reproducible": {
"id": 170876000000133005,
"type": "Always"
},
"link": {
"self": {
"url": "https://projects.zoho.com/restapi/portal/2063927/
projects/170876000000147021/bugs/170876000001834047/"
},
"timesheet": {
"url": "https://projects.zoho.com/restapi/portal/2063927/
projects/170876000000147021/bugs/170876000001834047/logs/"
}
},
"severity": {
"id": 170876000000065005,
"type": "Major"
},
"reported_person": "Patricia Boyle",
"id": 170876000001834047,
"title": "Tilt causes crash",
"flag": "Internal",
"assignee_name": "Not Assigned",
"reporter_id": "2060758",
"classification": {
"id": 170876000000133041,
"type": "Feature(New)"
},
"created_time_format": "05-13-2014 05:57 PM",
"closed": false,
"created_time": "05-13-2014",
"key": 541
}]
}

Create a Bug

POST  /portal/[PORTALID]/projects/[PROJECTID]/bugs/

Creates a bug.

Request Parameters

title* String Name of the bug.
description String Description of the bug.
assignee Long  Assignee for the bug.
flag String Bug flag must be Internal or External.
classification_id  Long  Classification ID of the project.
milestone_id  Long  Milestone ID of the project.
due_date  String [MM-DD-YYYY]  Due date of the bug.
module_id  Long  Module ID of the project.
severity_id  Long  Severity ID of the project.
reproducible_id  Long  Reproducible ID of the project.

Sample Response

Status: 201 Created
Content Type: application/json;charset=utf-8
{
"bugs": [{
"id": 170876000001851001,
"key": "543",
"project": {
"id": 170876000000147021
},
"flag": "Internal",
"title": "UI issue in Status text box",
"reporter_id": "2060758",
"reported_person": "Patricia Boyle",
"created_time": "05-27-2014 08:38 AM",
"created_time_long": 1401188920000,
"assignee_name": "Not Assigned",
"classification": {
"id": 170876000000133041,
"type": "Feature(New)"
},
"severity": {
"id": 170876000000065005,
"type": "Major"
},
"status": {
"id": 170876000001077429,
"type": "known limitation"
},
"closed": false,
"reproducible": {
"id": 170876000000133005,
"type": "Always"
},
"module": {
"id": 170876000000494013,
"name": "ERP Phase I"
},
"link": {
"self": {
"url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/
170876000000147021/bugs/170876000001851001/"
},
"timesheet": {
"url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/
170876000000147021/bugs/170876000001851001/logs/"
}
}
}]
}

Update a Bug

POST  /portal/[PORTALID]/projects/[PROJECTID]/bugs/[BUGID]/

Updates the bug.

Request Parameters

title* String Name of the bug.
description String Description of the bug.
assignee Long  Assignee for the bug.
flag String Bug flag must be Internal or External.
classification_id  Long  Classification ID of the project.
milestone_id  Long  Milestone ID of the project.
due_date  String [MM-DD-YYYY]  Due date of the bug.
module_id  Long  Module ID of the project.
severity_id  Long  Severity ID of the project.
reproducible_id  Long  Reproducible ID of the project.
status_id Long Status ID of the project.

Sample Response

Status: 200 Success
Content Type: application/json;charset=utf-8
{
"bugs": [{
"id": 170876000001851001,
"key": "543",
"project": {
"id": 170876000000147021
},
"flag": "Internal",
"title": "UI issue in Status options",
"reporter_id": "2060758",
"reported_person": "Patricia Boyle",
"created_time": "05-27-2014 08:38 AM",
"created_time_long": 1401188920000,
"assignee_name": "Not Assigned",
"classification": {
"id": 170876000000133041,
"type": "Feature(New)"
},
"severity": {
"id": 170876000000065005,
"type": "Major"
},
"status": {
"id": 170876000001077429,
"type": "known limitation"
},
"closed": false,
"reproducible": {
"id": 170876000000133005,
"type": "Always"
},
"module": {
"id": 170876000000494013,
"name": "ERP Phase I"
},
"link": {
"self": {
"url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/
170876000000147021/bugs/170876000001851001/"
},
"timesheet": {
"url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/
170876000000147021/bugs/170876000001851001/logs/"
}
}
}]
} }

Delete a Bug

DELETE /portal/[PORTALID]/projects/[PROJECTID]/bugs/[BUGID]/

Deletes the bug.

Sample Response

Status: 200 Success
Content Type: application/json;charset=utf-8
{
"response": "Bug Deleted Successfully"
}

Bugs Default Fields

GET  /portal/[PORTALID]/projects/[PROJECTID]/bugs/defaultfields/

Gets all the default fields in the given project.

Sample Response

Status: 200 Success
Content Type: application/json;charset=utf-8
{
"defaultfields": {
"severity_details": [{
"severity_id": "170876000000559001",
"severity_name": "Show stopper"
}, {
"severity_id": "170876000000065003",
"severity_name": "Critical"
}, {
"severity_id": "170876000000065005",
"severity_name": "Major"
}, {
"severity_id": "170876000000065007",
"severity_name": "Minor"
}, {
"severity_id": "170876000000553001",
"severity_name": "Show Stopper"
}],
"status_deatils": [{
"isdefault": false,
"status_name": "Open",
"status_id": "170876000000065045",
"closed": false
}, {
"isdefault": false,
"status_name": "Assigned",
"status_id": "170876000000553005",
"closed": false
}, {
"isdefault": false,
"status_name": "To test",
"status_id": "170876000000587011",
"closed": false
}, {
"isdefault": false,
"status_name": "To be fixed",
"status_id": "170876000001834225",
"closed": false
}, {
"isdefault": false,
"status_name": "InProgress",
"status_id": "170876000000065048",
"closed": false
}, {
"isdefault": false,
"status_name": "Reopen",
"status_id": "170876000000065057",
"closed": false
}, {
"isdefault": false,
"status_name": "Closed",
"status_id": "170876000000065054",
"closed": true
}, {
"isdefault": false,
"status_name": "To be analyzed",
"status_id": "170876000000584017",
"closed": false
}, {
"isdefault": false,
"status_name": "Not an issue",
"status_id": "170876000001071093",
"closed": true
}, {
"isdefault": false,
"status_name": "Failed Issues",
"status_id": "170876000001077005",
"closed": false
}, {
"isdefault": true,
"status_name": "known limitation",
"status_id": "170876000001077429",
"closed": true
}],
"module_details": [{
"module_id": "170876000000170057",
"module_name": "ERP Phase III"
}, {
"module_id": "170876000000494013",
"module_name": "ERP Phase I"
}, {
"module_id": "170876000001023026",
"module_name": "Post Release - Project 4.0 Feedback"
}, {
"module_id": "170876000001829185",
"module_name": "SAP Phase"
}],
"priority_details": [{
"priority_id": "170876000000133005",
"priority_name": "Always"
}, {
"priority_id": "170876000000133007",
"priority_name": "Sometimes"
}, {
"priority_id": "170876000000133009",
"priority_name": "Rarely"
}, {
"priority_id": "170876000000133011",
"priority_name": "Unable"
}, {
"priority_id": "170876000000133013",
"priority_name": "NeverTried"
}, {
"priority_id": "170876000000133015",
"priority_name": "NotApplicable"
}],
"classification_details": [{
"classification_id": "170876000000133029",
"classification_name": "Security"
}, {
"classification_id": "170876000001829163",
"classification_name": "Not a bug"
}, {
"classification_id": "170876000000133031",
"classification_name": "Crash/Hang"
}, {
"classification_id": "170876000000133033",
"classification_name": "DataLoss"
}, {
"classification_id": "170876000000133035",
"classification_name": "Performance"
}, {
"classification_id": "170876000000133037",
"classification_name": "UI/Usabililty"
}, {
"classification_id": "170876000000133039",
"classification_name": "OtherBug"
}, {
"classification_id": "170876000000133041",
"classification_name": "Feature(New)"
}, {
"classification_id": "170876000000133043",
"classification_name": "Enhancement"
}, {
"classification_id": "170876000001023022",
"classification_name": "Support Request"
}]
}
}

Bugs Custom Fields

GET  /portal/[PORTALID]/projects/[PROJECTID]/bugs/customfields/

Gets all the custom fields in the given project.

Sample Response

Status: 200 Success
Content Type: application/json;charset=utf-8
{
"customfields": [{
"label_name": "SNo",
"column_name": "LONG1"
}, {
"label_name": "Sub Module",
"default_Value": "Sales",
"column_name": "CHAR3"
}, {
"label_name": "Browser",
"default_Value": "Chrome",
"picklist_values": ["Chrome", "Firefox", "IE", "Safari", "Major"],
"column_name": "CHAR2"
}, {
"label_name": "Product",
"default_Value": "Code Manager",
"picklist_values": ["Mapping Manager", "Code Manager"],
"column_name": "CHAR1"
}]
}

Top