Authorization

Basic authentication scheme is used for authentication.Basic auth username is provided in format accountId@instanceName.atlassian. net. instanceName is the part of your Jira Cloud site name before the ".atlassian.net". You can get accountId via Jira Cloud REST API. For that go to You can also use Table Grid Cloud postman collection for that.

• email:Email of your account

• jiraAPIToken:Get it on https://id.atlassian.com/manage-profile/security/api-tokens

curl --request GET \
  --url 'https://<instanceName>.atlassian.net/rest/api/3/user/search?query=<username>' \
  --user '<email@example.com>:<token>' \
  --header 'Accept: application/json'

• username: Username of your account (type your e-mail address)

• instanceName is the part of your Jira Cloud site name before the ".atlassian.net".

• tgcApiToken: Get it on "API Tokens" tab on "Manage your apps" page

• accountId: Select “Get account id” request → Click “Send” button.

Image Added

Then there will be a JSON will contain accountId like the picture below:

Image Added

Basic auth password is a token generated on "API Tokens" page. You need to provide these credentials for every request in the the "Authorization" header. You will get 401 response code if If your credentials are incorrect, their will be a error request like the example below:

Image Added

Please note that user need to complete the Authorization first before creating any requests in Postman, or else it will return results show status 401: Unauthorized.

Image Added

Value Format

Values in columns are stored in the following format:

• Checkboxes are stored as booleans.

• Integers, Numbers, Dates, DateTimes and Times are stored as numbers. Values of Date, DateTime and Time columns are stored in Unix time format in milliseconds.

• Strings, Textareas, Single Select Lists and Sequences are stored as strings. Value of a single select list is a string containing a selected item's title.

• Multi Select Lists are stored as lists of strings containing titles of selected items.

• Formulas are stored as numbers or strings depending on return type.

• Userlists are stored as Maps with the following entries:

  • "accountId" contains user's account id, which uniquely identifies a user.
    "accountId" may be missing from the result of "Read Grid Data" method call if a user could not be found.
    When using "Add Grid Data" or "Update Grid Data" methods, "accountId" MUST be provided, and the rest of the entries are optional.

  • "value" contains user's full name.

  • "avatar" contains a link to user's avatar.

The term empty value refers to nulls, empty strings and empty lists.

Get Grids

API call: GET https://databuckets.net/rest/tgc/api/v1/grids

Description: Returns all grids in a Jira Cloud instance

Responses

Read Grid Data

API call: GET https://databuckets.net/rest/tgc/api/v1/grids/{gridId}/issue/{issueIdOrKey}

Description: Returns all the rows for a grid custom field and an issue

Request

PATH PARAMETERS

gridId 

string

Grid id.

issueIdOrKey 

string

The ID or key of the issue.

QUERY PARAMETERS

columnIds

Array<string>

A list of columns' ids to return for the Grid. This parameter accepts a comma-separated list.

Note: All columns are returned by default. 

Responses

Add Grid Data

API call: POST https://databuckets.net/rest/tgc/api/v1/grids/{gridId}/issue/{issueIdOrKey}

Description: Add rows to the Grid custom field

Request

PATH PARAMETERS

gridId 

string

Grid id.

issueIdOrKey 

string

The ID or key of the issue.

BODY

Example (application/json)

{ 
   "rows":[ 
      { 
         "status":"Open",
         "user":"Stephen Curry",
         "summary":"New row"
      }
   ]
}

Responses

Update Grid Data

API call: PUT https://databuckets.net/rest/tgc/api/v1/grids/{gridId}/issue/{issueIdOrKey}

Description: Update rows of the Grid custom field

Request

PATH PARAMETERS

gridId 

string

Grid id.

issueIdOrKey 

string

The ID or key of the issue.

BODY

Example (application/json)

{ 
   "rows":[
      { 
         "rowId":"row_b089f167-9475-401b-88bd-2c2d25052196",
         "columns":{ 
            "status":"Open",
            "user":"Blake Griffin",
            "summary":"Updated value"
         }
      }
   ]
}

Responses

Delete Grid Data

API call: DELETE https://databuckets.net/rest/tgc/api/v1/grids/{gridId}/issue/{issueIdOrKey}

Description: Delete rows of the Grid custom field

Request

PATH PARAMETERS

gridId 

string

Grid id.

issueIdOrKey 

string

The ID or key of the issue.

BODY

Example (application/json)

{ 
   "rows":[
      "rowId_823e747c-a38a-4f14-8fe4-2ee565124503",
      "rowId_7424bd1a-4c1f-404c-988b-1059756f3d72"
   ]
}

Responses