Versions Compared

Old Version 20

changes.mady.by.user mariana.kolomiiets (Deactivated)

Saved on

compared with

New Version 21

changes.mady.by.user andrii (Deactivated)

Saved on

Key

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

...

Expand
titleRead Grid Data


Panel

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

Desription: 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


{
"gd": {
"columns": [
"isummary",
"iassignee",
"istatus",
"idue"
],
"tablename": "TGE Field",
"view": {
"autosize": false,
"height": "385",
"rowHeight": "35"
}
},
"col": {
"isummary": {
"type": "string",
"title": "Summary",
"required": true,
"editable": true,
"summary": {},
"view": {
"width": 400,
"resizable": true,
"hidden": false
},
"errorHolder": [],
"alignment": "left"
},
"iassignee": {
"type": "userlist",
"title": "Assignee",
"required": false,
"editable": true,
"defaultvalue": "%7B%7D",
"summary": {},
"view": {
"width": 100,
"resizable": true,
"hidden": false
},
"errorHolder": [],
"alignment": "left"
},
"istatus": {
"type": "list",
"title": "Status",
"required": false,
"editable": true,
"attributes": [
{
"key": "label",
"defaultValue": ""
},
{
"key": "value",
"defaultValue": ""
}
],
"staticOptions": [
{
"label": "Open",
"value": "O"
},
{
"label": "Done",
"value": "D"
}
],
"defaultvalue": "Open",
"summary": {},
"view": {
"width": 60,
"resizable": true,
"hidden": false
},
"errorHolder": [],
"alignment": "left"
},
"idue": {
"type": "date",
"title": "Date due",
"required": false,
"editable": true,
"format": {
"date": "YYYY-MM-DD"
},
"summary": {},
"view": {
"resizable": true,
"hidden": false
},
"errorHolder": [],
"alignment": "left"
}
}
}


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


Panel

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

Desription: 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)

css



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)

css



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


Panel

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)

css



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


Panel

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.




Panel

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


Panel

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

Desription: 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

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

Auitabs
directionhorizontal


Auitabspage
title200

Returned if the request is successful.

Content-Type - application/json

Example response (application/json)

css
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.




...