Visit djangoplay.org ↗
djangoplay-web / API / DjangoPlay API — Issues
DocsDjangoPlay WebAPIDjangoPlay API — Issues

DjangoPlay API — Issues

Version: v1

1 min readApplies to v1.2.2
On this page ▾
  1. Overview
  2. Endpoints
  3. List Issues
  4. Create Issue
  5. Get Issue
  6. Update Issue
  7. Change Status
  8. Add Comment
  9. Sync Issue
  10. Issue Status
  11. Notes

Overview

This document describes the Issue Tracker API endpoints used for issue tracking integration.

Endpoints

List Issues

plaintext
GET /api/v1/issues/

Create Issue

plaintext
POST /api/v1/issues/

Request:

plaintext
{
"title": "Bug in invoice",
"description": "Invoice calculation incorrect",
"priority": "HIGH"
}

Get Issue

plaintext
GET /api/v1/issues/{id}/

Update Issue

plaintext
PUT /api/v1/issues/{id}/

Change Status

plaintext
POST /api/v1/issues/{id}/status/

Add Comment

plaintext
POST /api/v1/issues/{id}/comments/

Sync Issue

plaintext
POST /api/v1/issues/{id}/sync/

This syncs the issue with external issue tracker.

Issue Status

Status Description
OPEN Open issue
IN_PROGRESS Being worked
RESOLVED Fixed
CLOSED Closed
REOPENED Reopened

Notes

Issues may be linked to:

  • Helpdesk tickets
  • Entities
  • Invoices
  • Users
  • External issue tracker