REST API

BETA

This is the "Excel-like Tables for Jira" REST API.

The API uses Basic auth as the same as Jira REST API's Basic auth.

The method allows you to authenticate with the Jira user's account and its API token.

Common

Base URL: https://excel-like-tables-for-jira.herokuapp.com

Content type: application/json

GET /rest/api/table/meta/{issueKey}

Retrieve the meta-information of a table on the issue.

If the issue doesn't have a table, return 404.

It will take some time from receiving an issue-create an event to attaching a table. Using this API allows you to confirm the completion of attaching a table.

Path Parameters

issueKey: Jira issue key

Query Parameters

host: Jira hostname (e.g., xxxx.atlassian.net)

Response

200 OK
404 Not Found

GET /rest/api/table/{issueKey}

Retrieve the table data on the issue.

The data is base on the JSON format defined here.

Path Parameters

issueKey: Jira issue key

Query Parameters

host: Jira hostname (e.g., xxxx.atlassian.net)
version: (optional) version number of the table

Response

200 OK
400 Bad Request
404 Not Found

PUT /rest/api/table/{issueKey}

Set given data to the table on the issue.

The data is base on the JSON format defined here.

Path Parameters

issueKey: Jira issue key

Query Parameters

host: Jira hostname (e.g., xxxx.atlassian.net)

Request Body

JSON data that describes a table

Response

200 OK
400 Bad Request
404 Not Found

Examples

This example copies the table to another Jira issue.

CODE

<html>
<head>
  <script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
  <script src="https://cdn.jsdelivr.net/npm/umbrellajs@3.2.3/umbrella.min.js"></script>
</head>
<body>
<div id="msg"></div>
<script>
  // your Atlassian account user name and API token
  const auth = "Basic " + btoa("foo.bar@abcdefg.com:aiLia1F5JdGKE4OdFv8m57E3");

  // Jira hostname: your-jira.atlassian.net
  const srcUrl = `https://excel-like-tables-for-jira.herokuapp.com/rest/api/table/NEX-19?host=your-jira.atlassian.net`;

  // Retrieve the table data on issue NEX-19
  fetch(srcUrl, {
    headers: {
      'Authorization': auth,
    }
  })
  .then((data) => data.json())
  .then((json) => {

    u('#msg').html(`<pre>${JSON.stringify(json, null, 2)}</pre>`);

    // Store the table data to issue NEX-20
    const dstUrl = `https://excel-like-tables-for-jira.herokuapp.com/rest/api/table/NEX-20?host=your-jira.atlassian.net`;
    return fetch(dstUrl, {
      method: 'PUT',
      headers: {
        'Authorization': auth,
        'Content-Type': 'application/json',
      },
      body: JSON.stringify(json)
    })
  })
  .then(() => console.log('successed writing.'))
  .catch((err) => u('#msg').text(JSON.stringify(err, null, 2)));

</script>
</body>
</html>