Tickets | Heeler User Guide

Get Jira Connections

get

Authorizations

Responses

200

Successful Response

application/json

404

Not found

get

GET /api/tickets/jira/connections HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "connection_id": 1,
    "name": "text"
  }
]

Get Jira Projects

get

Authorizations

Path parameters

connection_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

GET /api/tickets/jira/{connection_id}/projects HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "project_key": "text",
    "name": "text"
  }
]

Get Jira Issue Fields

get

Authorizations

Path parameters

connection_idintegerRequired

project_keystringRequired

Query parameters

issue_type_idany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

GET /api/tickets/jira/{connection_id}/projects/{project_key}/fields HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "type": "array",
    "allowed_values": [
      {
        "id": "text",
        "value": "text"
      }
    ],
    "use_autocomplete": false,
    "required": true,
    "multiline": false,
    "default_value": null
  }
]

Search Jira Issues

get

Authorizations

Path parameters

connection_idintegerRequired

Query parameters

searchstringRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

GET /api/tickets/jira/{connection_id}/search?search=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "issues": [
    {
      "issue_id": 1,
      "name": "text",
      "status": "text",
      "status_category": "text",
      "issue_type": "text",
      "issue_type_icon_url": "text",
      "url": "text",
      "summary": "text",
      "remediation_id": 1
    }
  ]
}

Create Jira Issue

post

Authorizations

Body

connection_idintegerRequired

project_idstringRequired

issue_typestringRequired

labelsany ofOptional

string[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

POST /api/tickets/jira HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "connection_id": 1,
  "project_id": "text",
  "issue_type": "text",
  "fields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "labels": [
    "text"
  ]
}

{
  "issue_id": 1,
  "name": "text",
  "status": "text",
  "status_category": "text",
  "issue_type": "text",
  "issue_type_icon_url": "text",
  "url": "text",
  "summary": "text",
  "remediation_id": 1
}