Unfuddle STACK API
Comments
Introduction
Comments are available on both Messages and Tickets.
Comments
The collection represents all Comments for the given Project, Message or Ticket.
- URL:
- /api/v1/projects/{id}/messages/{id}/comments[GET, POST]
- /api/v1/projects/{id}/messages/{id}/comments/{id}[GET, PUT, DELETE]
- /api/v1/projects/{id}/tickets/{id}/comments[GET, POST]
- /api/v1/projects/{id}/tickets/{id}/comments/{id}[GET, PUT, DELETE]
- Response Formats:
- XML, JSON, RSS
- Request/Response Body:
- See Comment Data Model
- Example:
-
curl -i -u username:password -X GET \\ -H 'Accept: application/xml' \\ 'https://mysubdomain.unfuddle.com/api/v1/projects/87776/tickets/98444/comments.xml?formatted=true'
Convenience Resources
While comments for an entire project could be retrieved by iterating through all tickets and messages, this would be highly inefficient. These resources are provided as a convenience to allow for the querying of comments across an entire Project as a whole, for both the Messages or Tickets collections.
- URL:
- /api/v1/projects/{id}/comments[GET]
- /api/v1/projects/{id}/messages/comments[GET]
- /api/v1/projects/{id}/tickets/comments[GET]
- Response Formats:
- XML, JSON, RSS
- Parameters (via query string or request body):
-
<request> <!-- specifies the inclusive start date of the query --> <start-date>2007/1/1</start-date> <!-- specifies the inclusive end date of the query --> <end-date>2007/12/31</end-date> </request>
- Request/Response Body:
- See Comment Data Model
- Example:
-
curl -i -u username:password -X GET \\ -H 'Accept: application/xml' \\ 'https://mysubdomain.unfuddle.com/api/v1/projects/87776/tickets/comments.xml?start_date=2007/1/1&end_date=2007/12/31'