Versions Compared

Old Version 22

changes.mady.by.user andrii (Deactivated)

Saved on

compared with

New Version Current

changes.mady.by.user Dam

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Excerpt

...

hiddentrue

...

REST API for the Table Grid Next Generation

Info

This page describes how to use REST APIs for Table Grid Next Generation for Jira Server / Datacenter. Our APIs endpoints are deployed within your Jira Platform, directly embed in our app.

Expand
titleValue format

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:

    • "key" contains user key, which uniquely identifies a user.
      "key" may be missing if a user could not be found.
      When using "Add Grid Data" or "Update Grid Data" methods, "key" MUST be provided, and the rest of the entries are optional.

    • "username" contains user's username.

    • "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.

Contents

Table of Contents
Expand
titleRead Grid Data

...

Read Grid Data

API call: GET /rest/idalko-grid/1.0/api/grid/{gridCustomFieldId}/issue/{issueIdOrKey}

...

Description: Read all rows of the Grid custom field

Request

PATH PARAMETERS

gridCustomFieldId 

Status
titleREQUIRED

string

The id of the Grid custom field.

issueIdOrKey 

Status
titleREQUIRED

string

The ID or key of the issue.

QUERY PARAMETERS

Responses

Auitabs
directionhorizontal


Auitabspage
title200

...




Auitabspage
title400

Returned if specified column id(s) does not exist.


Auitabspage
title401

Returned if the authentication credentials are incorrect or missing.


Auitabspage
title404

Returned if:

  • The issue is not found or the user does not have permission to view it.

  • The custom field is not found or it's not the Grid type.


Expand
titleAdd Grid Data

...

Add Grid Data

API call: POST /rest/idalko-grid/1.0/api/grid/{gridCustomFieldId}/issue/{issueIdOrKey}

...

Description: Add rows to the Grid custom field

Request

PATH PARAMETERS

gridCustomFieldId 

Status
titleREQUIRED

string

The id of the Grid custom field.

issueIdOrKey 

Status
titleREQUIRED

string

The ID or key of the issue.

BODY

Example (application/json)

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

Responses

Auitabs
directionhorizontal


Auitabspage
title201

Returned if the request is successful.

Content-Type - application/json

Example response (application/json)

...



Auitabspage
title400

Returned if:

  • Specified column id(s) does not exist.

  • An invalid value is set to a column e.g. a non-number to a number column.

  • A required column is not specified or assigned to an empty value.

  • A read-only column is added.
  • A userlist value is not found on Jira.

Example response (application/json)

...



Auitabspage
title401

Returned if the authentication credentials are incorrect or missing.


Auitabspage
title404

Returned if:

  • The issue is not found or the user does not have permission to view it.

  • The custom field is not found or it's not the Grid type.


Expand
titleUpdate Grid Data

...

Update Grid Data

API call: PUT /rest/idalko-grid/1.0/api/grid/{gridCustomFieldId}/issue/{issueIdOrKey}

Description: Update rows of the Grid custom field

Request

PATH PARAMETERS

gridCustomFieldId 

Status
titleREQUIRED

string

The id of the Grid custom field.

issueIdOrKey 

Status
titleREQUIRED

string

The ID or key of the issue.

BODY

Example (application/json)

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

Responses

Auitabs
directionhorizontal


Auitabspage
title204

Returned if the request is successful.


Auitabspage
title400

Returned if:

  • Specified column id(s) does not exist.

  • An invalid value is set to a column e.g. a non-number to a number column.

  • A required column is assigned to an empty value i.e. is removed.

  • A read-only column is updated.
  • A userlist value is not found on Jira.

Example response (application/json)

...



Auitabspage
title401

Returned if the authentication credentials are incorrect or missing.


Auitabspage
title404

Returned if:

  • The issue is not found or the user does not have permission to view it.

  • The custom field is not found or it's not the Grid type.


Expand
titleDelete Grid Data

Delete Grid Data

...

Delete one or more rows

API call: DELETE /rest/idalko-grid/1.0/api/grid/{gridCustomFieldId}/issue/{issueIdOrKey}

Description: Delete rows of the Grid custom field

Request

PATH PARAMETERS

gridCustomFieldId 

Status
titleREQUIRED

string

The id of the Grid custom field.

issueIdOrKey 

Status
titleREQUIRED

string

The ID or key of the issue.

BODY

Example (application/json)

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

Responses

Auitabs
directionhorizontal


Auitabspage
title204

Returned if the request is successful.


Auitabspage
title401

Returned if the authentication credentials are incorrect or missing.


Auitabspage
title404

Returned if:

  • The issue is not found or the user does not have permission to view it.

  • The custom field is not found or it's not the Grid type.
  • Specified row id does not exist in the grid. None of the rows are deleted in this case.

...



Delete ALL rows

API call: DELETE /rest/idalko-grid/1.0/api/grid/{gridCustomFieldId}/issue/{issueIdOrKey}

Description: Delete all rows of the Grid custom field

Request

PATH PARAMETERS

gridCustomFieldId 

Status
titleREQUIRED

string

The id of the Grid custom field.

issueIdOrKey 

Status
titleREQUIRED

string

The ID or key of the issue.

BODY

Example (application/json)

Code Block
{ 
   "rows":"all"
}

Responses

Auitabs
directionhorizontal


Auitabspage
title204

Returned if the request is successful.


Auitabspage
title401

Returned if the authentication credentials are incorrect or missing.


Auitabspage
title404

Returned if:

  • The issue is not found or the user does not have permission to view it.

  • The custom field is not found or it's not the Grid type.
  • Specified row id does not exist in the grid. None of the rows are deleted in this case.


Expand
titleRead Grid Configuration

Read Grid Configuration

...

Read grid configuration for one grid custom field

API call: GET /rest/idalko-grid/1.0/api/grid/config/{gridCustomFieldId}/issue/{issueIdOrKey}

...

Description: Reads configuration of the Grid custom field

Request

PATH PARAMETERS

gridCustomFieldId 

Status
titleREQUIRED

string

The id of the Grid custom field.

issueIdOrKey 

Status
titleREQUIRED

string

The ID or key of the issue.

Responses

Auitabs
directionhorizontal


Auitabspage
title200

Returned if the request is successful.

Content-Type - application/json

Example response (application/json)

...



Auitabspage
title401

Returned if the authentication credentials are incorrect or missing.


Auitabspage
title404

Returned if:

  • The issue is not found or the user does not have permission to view it.

  • The custom field is not found or it's not the Grid type.

...


Read all Grid custom fields configurations

API call: GET /rest/idalko-grid/1.0/api/grid/config/all

...

Description: Read all Grid custom field configurations

Responses

Auitabs
directionhorizontal


Auitabspage
title200

Returned if the request is successful.

Content-Type - application/json

Example response (application/json)

css



Auitabspage
title401

Returned if the authentication credentials are incorrect or missing

...

titleValue 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:
    • "key" contains user key, which uniquely identifies a user.
      "key" may be missing if a user could not be found.
      When using "Add Grid Data" or "Update Grid Data" methods, "key" MUST be provided, and the rest of the entries are optional.
    • "username" contains user's username.
    • "value" contains user's full name.
    • "avatar" contains a link to user's avatar.

...

.