Data Storage and Access

Data Storage

SimpleGrid stores its grid information within Jira as a native field, utilizing JSON format to organize and manage the data. On the other side, the grid’s configuration, including column types and names, is stored within the field’s configuration settings.

Customfield Data: JSON Format Example:

{
    "fields": {
        "customfield_xxx": {
            "gridData": [
                {
                    "First Column": "aaa",
                    "Second Column": "bbb",
                    "Third Column": "ccc"
                },
                {
                    "First Column": "ddd",
                    "Second Column": "fff",
                    "Third Column": "ggg"
                },
                {
                    "Second Column": "hhh",
                    "Third Column": "iii"
                }
            ]
        }
    }
}

Accessing Customfield Data via Jira REST API

SimpleGrid provides access to its stored data through the Jira REST API, enabling seamless integration with other systems and applications. You can retrieve and manipulate grid data programmatically using standard HTTP requests.

You can use GET /rest/api/3/issue/{issueKey} to access the data, where you have to make the changes accordingly.

Customfield Configuration: JSON Format Example:

{
	"id": "XXXXX",
	"fieldContextId": "XXXXX",
	"configuration": [
		{
			"key": "First Column",
			"type": "text",
			"index": 0,
			"content": "First Column",
			"isSortable": false
		},
		{
			"key": "Second Column",
			"type": "text",
			"index": 1,
			"content": "Second Column",
			"isSortable": true
		},
		{
			"key": "Third Column",
			"type": "text",
			"index": 2,
			"content": "Third Column",
			"isSortable": false
		}
	]
}

Accessing Customfield Configuration via Jira REST API

You can retrieve and manipulate grid configuration programmatically using standard HTTP requests.

You can use GET /rest/api/3/app/field/{customfieldId}/context/configuration?fieldContextId={contextId}, where you have to make the changes accordingly.