{"type":"doc","content":[{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":66.66},"content":[{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"excerpt","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"239b2de1-c2cb-401f-87f5-9d205394863e"},"schemaVersion":{"value":"1"},"title":"Excerpt"}},"localId":"56de7505-9840-4665-851f-a45ddfd75db0"},"content":[{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"This page describes how to use REST APIs for ","type":"text"},{"text":"Table Grid Next Generation for Jira Server / Datacenter","type":"text","marks":[{"type":"strong"}]},{"text":". Our APIs endpoints are deployed within your Jira Platform, directly embed in our app.","type":"text"}]}]}]},{"type":"paragraph"},{"type":"expand","attrs":{"title":"Value format"},"content":[{"type":"heading","attrs":{"level":1},"content":[{"text":"Value format","type":"text"}]},{"type":"paragraph","content":[{"text":"Values in columns are stored in the following format:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Checkboxes","type":"text","marks":[{"type":"em"}]},{"text":" are stored as booleans.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Integers","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"Numbers","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"Dates","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"DateTimes","type":"text","marks":[{"type":"em"}]},{"text":" and ","type":"text"},{"text":"Times","type":"text","marks":[{"type":"em"}]},{"text":" are stored as numbers. Values of Date, DateTime and Time columns are stored in Unix time format in milliseconds.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Strings","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"Textareas","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"Single Select Lists","type":"text","marks":[{"type":"em"}]},{"text":" and ","type":"text"},{"text":"Sequences","type":"text","marks":[{"type":"em"}]},{"text":" are stored as strings. Value of a single select list is a string containing a selected item's title.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Multi Select Lists","type":"text","marks":[{"type":"em"}]},{"text":" are stored as lists of strings containing titles of selected items.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Formulas","type":"text","marks":[{"type":"em"}]},{"text":" are stored as numbers or strings depending on return type.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Userlists","type":"text","marks":[{"type":"em"}]},{"text":" are stored as Maps with the following entries:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"\"key\" contains user key, which uniquely identifies a user.","type":"text"},{"type":"hardBreak"},{"text":"\"key\" may be missing if a user could not be found.","type":"text"},{"type":"hardBreak"},{"text":"When using \"Add Grid Data\" or \"Update Grid Data\" methods, \"key\" MUST be provided, and the rest of the entries are optional.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"\"username\" contains user's username.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"\"value\" contains user's full name.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"\"avatar\" contains a link to user's avatar.","type":"text"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"The term ","type":"text"},{"text":"empty value","type":"text","marks":[{"type":"em"}]},{"text":" refers to nulls, empty strings and empty lists.","type":"text"}]}]}]},{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"paragraph","content":[{"text":"Contents","type":"text","marks":[{"type":"strong"}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"d5a8bae2-2be6-49ac-8af6-54c0b1d0acc4"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"57b0c78d-d403-4792-8d6a-1087d3a6693f"}}]}]},{"type":"expand","attrs":{"title":"Read Grid Data"},"content":[{"type":"heading","attrs":{"level":1},"content":[{"text":"Read Grid Data","type":"text"}]},{"type":"paragraph","content":[{"text":"API call:","type":"text","marks":[{"type":"strong"}]},{"text":" GET /rest/idalko-grid/1.0/api/grid/{gridCustomFieldId}/issue/{issueIdOrKey}","type":"text"}]},{"type":"paragraph","content":[{"text":"Description:","type":"text","marks":[{"type":"strong"}]},{"text":" Read all rows of the Grid custom field","type":"text"}]},{"type":"paragraph","content":[{"text":"Request","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"PATH PARAMETERS","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"gridCustomFieldId ","type":"text","marks":[{"type":"strong"}]},{"type":"status","attrs":{"color":"neutral","style":"bold","text":"REQUIRED","localId":"33a586b6-a278-409e-8da0-82820039e306"}}]},{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00875a"}}]}]},{"type":"paragraph","content":[{"text":"The id of the Grid custom field.","type":"text"}]},{"type":"paragraph","content":[{"text":"issueIdOrKey ","type":"text","marks":[{"type":"strong"}]},{"type":"status","attrs":{"color":"neutral","style":"bold","text":"REQUIRED","localId":"8121cd8f-41d6-42af-919d-b39458b34164"}}]},{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00875a"}}]}]},{"type":"paragraph","content":[{"text":"The ID or key of the issue.","type":"text"}]},{"type":"paragraph","content":[{"text":"QUERY PARAMETERS","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Responses","type":"text","marks":[{"type":"strong"}]}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"horizontal

200

400

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

401

Returned if the authentication credentials are incorrect or missing.

404

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.

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

Returned if the authentication credentials are incorrect or missing.

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.

201

Returned if the request is successful.

Content-Type - application/json

Example response (application/json)

400

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)

401

Returned if the authentication credentials are incorrect or missing.

404

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.

Returned if the request is successful.

Content-Type - application/json

Example response (application/json)

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)

Returned if the authentication credentials are incorrect or missing.

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.

204

Returned if the request is successful.

400

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)

401

Returned if the authentication credentials are incorrect or missing.

404

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.

Returned if the request is successful.

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)

Returned if the authentication credentials are incorrect or missing.

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.

204

Returned if the request is successful.

401

Returned if the authentication credentials are incorrect or missing.

404

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.

Returned if the request is successful.

Returned if the authentication credentials are incorrect or missing.

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.

204

Returned if the request is successful.

401

Returned if the authentication credentials are incorrect or missing.

404

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.

Returned if the request is successful.

Returned if the authentication credentials are incorrect or missing.

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.

200

Returned if the request is successful.

Content-Type - application/json

Example response (application/json)

401

Returned if the authentication credentials are incorrect or missing.

404

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.

Returned if the request is successful.

Content-Type - application/json

Example response (application/json)

Returned if the authentication credentials are incorrect or missing.

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.

200

Returned if the request is successful.

Content-Type - application/json

Example response (application/json)

css

401

Returned if the authentication credentials are incorrect or missing.

Returned if the request is successful.

Content-Type - application/json

Example response (application/json)

css

","nestedContent":{"type":"doc","content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"auitabspage","parameters":{"macroParams":{"title":{"value":"200"}},"macroMetadata":{"macroId":{"value":"b426e0ec-3f2e-4d2c-9f9c-165841338222"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://content-formatting.connect.apps.adaptavist.com/icons/CFMC_Kolekti_icon.svg"}}],"title":"Tabs Page - Legacy"}}},"content":[{"type":"paragraph","content":[{"text":"Returned if the request is successful.","type":"text"}]},{"type":"paragraph","content":[{"text":"Content-Type - application/json","type":"text"}]},{"type":"paragraph","content":[{"text":"Example response (application/json)","type":"text"}]},{"type":"codeBlock","attrs":{"language":"css"},"content":[{"text":"[\n {\n \"name\":\"TGE Field\",\n \"description\":\"TGE Field\",\n \"customFieldId\":10724,\n \"fieldContextId\":10933,\n \"fieldContextLabel\":\"Default Configuration Scheme for TGE Field\",\n \"fieldContextDesc\":\"Default configuration scheme generated by Jira\",\n \"id\":60,\n \"issueTypes\":[\n \n ],\n \"projects\":[\n \n ],\n \"config\":{\n \"gd\":{\n \"columns\":[\n \"isummary\",\n \"iassignee\",\n \"istatus\",\n \"idue\"\n ],\n \"tablename\":\"TGE Field\",\n \"view\":{\n \"autosize\":false,\n \"height\":\"385\",\n \"rowHeight\":\"35\"\n }\n },\n \"col\":{\n \"isummary\":{\n \"type\":\"string\",\n \"title\":\"Summary\",\n \"required\":true,\n \"editable\":true,\n \"summary\":{\n \n },\n \"view\":{\n \"width\":400,\n \"resizable\":true,\n \"hidden\":false\n },\n \"errorHolder\":[\n \n ],\n \"alignment\":\"left\"\n },\n \"iassignee\":{\n \"type\":\"userlist\",\n \"title\":\"Assignee\",\n \"required\":false,\n \"editable\":true,\n \"defaultvalue\":\"%7B%7D\",\n \"summary\":{\n \n },\n \"view\":{\n \"width\":100,\n \"resizable\":true,\n \"hidden\":false\n },\n \"errorHolder\":[\n \n ],\n \"alignment\":\"left\"\n },\n \"istatus\":{\n \"type\":\"list\",\n \"title\":\"Status\",\n \"required\":false,\n \"editable\":true,\n \"attributes\":[\n {\n \"key\":\"label\",\n \"defaultValue\":\"\"\n },\n {\n \"key\":\"value\",\n \"defaultValue\":\"\"\n }\n ],\n \"staticOptions\":[\n {\n \"label\":\"Open\",\n \"value\":\"O\"\n },\n {\n \"label\":\"Done\",\n \"value\":\"D\"\n }\n ],\n \"defaultvalue\":\"Open\",\n \"summary\":{\n \n },\n \"view\":{\n \"width\":60,\n \"resizable\":true,\n \"hidden\":false\n },\n \"errorHolder\":[\n \n ],\n \"alignment\":\"left\"\n },\n \"idue\":{\n \"type\":\"date\",\n \"title\":\"Date due\",\n \"required\":false,\n \"editable\":true,\n \"format\":{\n \"date\":\"YYYY-MM-DD\"\n },\n \"summary\":{\n \n },\n \"view\":{\n \"resizable\":true,\n \"hidden\":false\n },\n \"errorHolder\":[\n \n ],\n \"alignment\":\"left\"\n }\n }\n },\n \"staticData\":[\n \n ],\n \"indexedColumnIds\":[\n \"isummary\",\n \"iassignee\",\n \"istatus\",\n \"idue\",\n \"iassignee\"\n ]\n },\n {\n \"name\":\"Test Grid\",\n \"description\":\"\",\n \"customFieldId\":10801,\n \"fieldContextId\":11003,\n \"fieldContextLabel\":\"Default Configuration Scheme for Test Grid\",\n \"fieldContextDesc\":\"Default configuration scheme generated by Jira\",\n \"id\":62,\n \"issueTypes\":[\n \n ],\n \"projects\":[\n \n ],\n \"config\":{\n \"gd\":{\n \"columns\":[\n \"jseq\",\n \"jsummary\",\n \"jassignee\",\n \"jstatus\"\n ],\n \"view\":{\n \"autosize\":false,\n \"height\":\"385\"\n }\n },\n \"col\":{\n \"jseq\":{\n \"type\":\"sequence\",\n \"title\":\"Order\",\n \"required\":false,\n \"editable\":false,\n \"summary\":{\n \n },\n \"view\":{\n \"resizable\":true,\n \"hidden\":false\n },\n \"errorHolder\":[\n \n ],\n \"initValue\":1,\n \"step\":1,\n \"alignment\":\"center\"\n },\n \"jsummary\":{\n \"type\":\"string\",\n \"title\":\"Summary\",\n \"required\":false,\n \"editable\":true,\n \"summary\":{\n \n },\n \"view\":{\n \"resizable\":true,\n \"hidden\":false\n },\n \"errorHolder\":[\n \n ],\n \"alignment\":\"left\"\n },\n \"jassignee\":{\n \"type\":\"userlist\",\n \"title\":\"Assignee\",\n \"required\":false,\n \"editable\":true,\n \"summary\":{\n \n },\n \"view\":{\n \"resizable\":true,\n \"hidden\":false\n },\n \"errorHolder\":[\n \n ],\n \"alignment\":\"left\"\n },\n \"jstatus\":{\n \"type\":\"list\",\n \"title\":\"Status\",\n \"required\":false,\n \"editable\":true,\n \"attributes\":[\n {\n \"key\":\"label\",\n \"defaultValue\":\"\"\n }\n ],\n \"staticOptions\":[\n {\n \"label\":\"Open\"\n },\n {\n \"label\":\"In Progress\"\n },\n {\n \"label\":\"In Review\"\n },\n {\n \"label\":\"Closed\"\n }\n ],\n \"summary\":{\n \n },\n \"view\":{\n \"resizable\":true,\n \"hidden\":false\n },\n \"errorHolder\":[\n \n ],\n \"alignment\":\"left\"\n }\n }\n },\n \"staticData\":[\n \n ],\n \"indexedColumnIds\":[\n \"jseq\",\n \"jsummary\",\n \"jassignee\",\n \"jstatus\"\n ]\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]}],"version":1}}}},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"401

Returned if the authentication credentials are incorrect or missing.